Org-API
Lees de organisatiemetadata van de credential. Alleen-lezen op de publieke API — org-instellingen (retentie, SMS-opt-in, KYB) worden beheerd vanuit de in-app admin-omgeving waar de audit chain vastlegt wie wat + wanneer heeft gewijzigd.
De org ophalen
GET /api/v1/public/org — scope org:read
curl https://app.nexbasira.com/api/v1/public/org \
-H "Authorization: Bearer nb_sec_..." {
"id": "00000000-0000-0000-0000-000000000000",
"name": "Acme Insurance",
"country": "FR",
"settings_jsonb": {
"default_locale": "fr",
"auto_record_sessions": false
},
"retention_days": 2555,
"sms_enabled": true,
"created_at": "2024-09-01T08:00:00Z"
} | Veld | Type | Opmerkingen |
|---|---|---|
id | UUID | Stabiel gedurende de levensduur van de credential. |
name | string | Weergavenaam. Getoond in uitnodigingsmails + de header van het PDF-rapport. |
country | ISO 3166-1 alpha-2 | Bepaalt de standaardlocale + KYB-jurisdictie. |
settings_jsonb | object | Vrije voorkeuren op org-niveau (standaardlocale, auto-record-toggle, enz.). Schema is voorwaarts compatibel — behandel onbekende sleutels als informatief. |
retention_days | int | null | Hoe lang Evidence-bytes in object storage worden bewaard voordat lifecycle-regels ze verwijderen. null = platformstandaard (7 jaar voor eIDAS-conforme deployments). |
sms_enabled | bool | Of SMS-uitnodigingsaflevering is ingeschakeld. Standaard false; opt-in via de admin-SMS-kaart. |
created_at | ISO 8601 | Tijdstempel van org-aanmaak. |
Veelvoorkomende fouten
| Status | Code | Wanneer |
|---|---|---|
| 403 | permission_denied | Credential mist org:read. |
Opmerkingen
- Eén org per credential. Elke publieke-API-credential is beperkt tot precies één organisatie; u geeft geen
org_idmee — de credential lost dit server-side op. - Geen schrijfoppervlak. Mutaties aan org-instellingen verlopen via de admin-UI zodat de identiteit + reden van de operator kunnen worden geaudit. De publieke API blijft hier bewust alleen-lezen.
- White-label. Voor logo- + kleuraanpassing, zie de Branding-API — dat is de beschrijfbare hoek.