# Bedrijfsprofiel

Eén endpoint geeft de openbare kant van het bedrijfsprofiel van de merchant: hoe het bedrijf heet en bereikbaar is, waar het is geregistreerd, welke sociale profielen het deelt en in welke talen de content is geschreven. Gebruik het voor een footer, een contactpagina of een taalwisselaar in je storefront. De merchant bewerkt deze waarden in het dashboard onder **Instellingen** → **Bedrijf**.

Het endpoint vereist een tenant-API-sleutel met de scope `tenant:read`, verstuurd als `Authorization: Bearer {api_key}`. Het is niet afhankelijk van een module. Een sleutel zonder die scope krijgt `403 {"message": "Invalid ability provided."}`. De gedeelde tenant-limiet van 120 verzoeken per minuut geldt.

## GET /v1/api/business

Geeft de openbare allowlist van het bedrijfsprofiel. Bank-, ondertekenaar-, afzender- en voorwaardenvelden maken er nooit deel van uit. De aanroep maakt geen profiel aan: een winkel die het profiel nog niet heeft ingevuld antwoordt met `200`, alle tekstvelden `null`, `social_links` als `[]` en de standaardtaal.

### Request

```bash title="Request"
curl https://api.borkol.com/v1/api/business \
  -H "Authorization: Bearer {api_key}"
```

### Response

```json title="Response"
{
  "data": {
    "trade_name": "Sunrise Bakery",
    "legal_name": "Sunrise Bakery BV",
    "email": "hello@bakery.example",
    "phone": "+31 20 123 4567",
    "website": "https://bakery.example",
    "street": "Kerkstraat",
    "house_number": "12",
    "postal_code": "2011 AB",
    "city": "Haarlem",
    "country": "NL",
    "registration_number": "12345678",
    "vat_id": "NL123456789B01",
    "social_links": [
      { "platform": "instagram", "url": "https://www.instagram.com/sunrisebakery", "label": null },
      { "platform": "other", "url": "https://bakery.example/blog", "label": "Blog" }
    ],
    "locale": "nl",
    "content_locales": ["nl", "en"]
  }
}
```

### Velden

| Veld | Type | Beschrijving |
| --- | --- | --- |
| `trade_name` | string of null | Naam waaronder het bedrijf handelt. |
| `legal_name` | string of null | Geregistreerde juridische naam. |
| `email` | string of null | Openbaar contactadres. |
| `phone` | string of null | Openbaar telefoonnummer. |
| `website` | string of null | De eigen website van het bedrijf. |
| `street` | string of null | Straat van het bedrijfsadres. |
| `house_number` | string of null | Huisnummer. |
| `postal_code` | string of null | Postcode. |
| `city` | string of null | Plaats. |
| `country` | string of null | Landcode van twee letters, hoofdletters, bijvoorbeeld `NL`. |
| `registration_number` | string of null | KvK- of ander bedrijfsregistratienummer. |
| `vat_id` | string of null | BTW-nummer, hoofdletters. |
| `social_links` | array | De sociale profielen die de merchant deelt, in de volgorde die is ingesteld. Lege array als er geen zijn. Elk item staat hieronder beschreven. |
| `locale` | string | De standaardtaal van de winkel, een taaltag zoals `nl`. |
| `content_locales` | array van strings | De talen waarin de content van de winkel is geschreven. Bevat altijd `locale`. Dezelfde lijst waartoe gelokaliseerde [Objects](/nl/api/objects/index#gelokaliseerde-waarden)-waarden worden beperkt. |

### Items van sociale links

| Veld | Type | Beschrijving |
| --- | --- | --- |
| `platform` | string | Een van `instagram`, `facebook`, `x`, `linkedin`, `youtube`, `tiktok`, `pinterest`, `threads`, `bluesky`, `snapchat`, `whatsapp`, `telegram`, `github`, `behance`, `dribbble`, `vimeo`, `reddit`, `discord`, `mastodon`, `twitch`, `spotify`, `medium`, `other`. |
| `url` | string | Een `https://`-adres. Voor elk platform behalve `mastodon` en `other` hoort de host bij dat platform. |
| `label` | string of null | Weergavetekst. Altijd aanwezig voor `other`, optioneel (vaak `null`) voor de rest. |

De platformlijst kan groeien. Behandel een onbekende `platform` als een gewone link en toon die met `label` of `url`.

### Fouten

| Status | Wanneer |
| --- | --- |
| `401` | Ontbrekende of ongeldige API-sleutel. |
| `403` | De sleutel heeft de scope `tenant:read` niet. |
| `429` | Limiet bereikt. Zie [Fouten en limieten](/nl/api/getting-started/errors-and-rate-limits). |
