API de organização

Leia os metadados da organização da credencial. Só de leitura na API pública — as definições da organização (retenção, opt-in de SMS, KYB) são geridas a partir da superfície de administração na app, onde a cadeia de auditoria capta quem alterou o quê + quando.

Obter a organização

GET /api/v1/public/org — âmbito 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	Notas
`id`	UUID	Estável ao longo do tempo de vida da credencial.
`name`	string	Nome de exibição. Mostrado nos e-mails de convite + no cabeçalho do relatório PDF.
`country`	ISO 3166-1 alpha-2	Determina o locale predefinido + a jurisdição KYB.
`settings_jsonb`	object	Preferências ao nível da organização em formato livre (locale predefinido, alternador de gravação automática, etc.). O esquema é compatível para a frente — trate as chaves desconhecidas como informativas.
`retention_days`	int \| null	Durante quanto tempo os bytes de Evidence são mantidos no armazenamento de objetos antes de as regras de ciclo de vida os purgarem. `null` = predefinição da plataforma (7 anos para implementações conformes com o eIDAS).
`sms_enabled`	bool	Se a entrega de convites por SMS está ativada. Predefinição false; ativação via o cartão de SMS de administração.
`created_at`	ISO 8601	Selo temporal de criação da organização.

Erros comuns

Estado	Código	Quando
403	`permission_denied`	A credencial não tem `org:read`.

Notas

Uma organização por credencial. Cada credencial de API pública tem âmbito de exatamente uma organização; não passa um org_id — a credencial resolve-o do lado do servidor.
Sem superfície de escrita. As alterações às definições da organização passam pela interface de administração para que a identidade + o motivo do operador possam ser auditados. A API pública mantém-se só de leitura aqui de propósito.
White-label. Para personalização de logótipo + cor, consulte a API de branding — é aí que existe escrita.