API Org
Leggi i metadati dell'organizzazione della credenziale. Sola lettura sull'API pubblica — le impostazioni dell'org (retention, opt-in SMS, KYB) si gestiscono dalla superficie di amministrazione in-app, dove la catena di audit registra chi ha cambiato cosa e quando.
Ottieni l'org
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"
} | Campo | Tipo | Note |
|---|---|---|
id | UUID | Stabile per tutta la durata della credenziale. |
name | string | Nome visualizzato. Mostrato nelle email di invito e nell'intestazione del report PDF. |
country | ISO 3166-1 alpha-2 | Determina il locale predefinito e la giurisdizione KYB. |
settings_jsonb | object | Preferenze a livello di org in formato libero (locale predefinito, interruttore di registrazione automatica, ecc.). Lo schema è compatibile in avanti — tratta le chiavi sconosciute come informative. |
retention_days | int | null | Per quanto tempo i byte delle prove vengono conservati nell'object storage prima che le regole di lifecycle li eliminino. null = valore predefinito della piattaforma (7 anni per i deployment conformi a eIDAS). |
sms_enabled | bool | Se il recapito degli inviti via SMS è abilitato. Predefinito a false; opt-in tramite la scheda SMS di amministrazione. |
created_at | ISO 8601 | Marca temporale di creazione dell'org. |
Errori comuni
| Stato | Codice | Quando |
|---|---|---|
| 403 | permission_denied | La credenziale non dispone di org:read. |
Note
- Un'org per credenziale. Ogni credenziale dell'API pubblica è associata a esattamente un'organizzazione; non passi un
org_id— la credenziale lo risolve lato server. - Nessuna superficie di scrittura. Le modifiche alle impostazioni dell'org passano dall'interfaccia di amministrazione affinché l'identità e la motivazione dell'operatore possano essere sottoposte ad audit. L'API pubblica resta volutamente in sola lettura qui.
- White-label. Per la personalizzazione di logo e colori, vedi l' API Branding — è l'angolo scrivibile.