API de organización
Lee los metadatos de la organización de la credencial. Solo lectura en la API pública — los ajustes de la organización (retención, opt-in de SMS, KYB) se gestionan desde la superficie de administración dentro de la app, donde la cadena de auditoría registra quién cambió qué y cuándo.
Obtener la organización
GET /api/v1/public/org — alcance 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 | Estable durante toda la vida de la credencial. |
name | string | Nombre para mostrar. Aparece en los correos de invitación y en la cabecera del informe PDF. |
country | ISO 3166-1 alpha-2 | Determina el idioma predeterminado + la jurisdicción de KYB. |
settings_jsonb | object | Preferencias de nivel de organización de formato libre (idioma predeterminado, conmutador de grabación automática, etc.). El esquema es compatible hacia adelante — trate las claves desconocidas como informativas. |
retention_days | int | null | Cuánto tiempo se conservan los bytes de las pruebas en el almacenamiento de objetos antes de que las reglas de ciclo de vida los purguen. null = valor predeterminado de la plataforma (7 años para despliegues conformes con eIDAS). |
sms_enabled | bool | Indica si la entrega de invitaciones por SMS está habilitada. El valor predeterminado es false; opt-in mediante la tarjeta de SMS de administración. |
created_at | ISO 8601 | Marca de tiempo de creación de la organización. |
Errores comunes
| Estado | Código | Cuándo |
|---|---|---|
| 403 | permission_denied | La credencial no tiene org:read. |
Notas
- Una organización por credencial. Cada credencial de la API pública está limitada a exactamente una organización; no se pasa un
org_id— la credencial lo resuelve en el servidor. - Sin superficie de escritura. Las modificaciones de los ajustes de la organización pasan por la interfaz de administración para poder auditar la identidad del operador y el motivo. La API pública permanece de solo lectura aquí de forma intencionada.
- Marca blanca. Para personalizar el logotipo y los colores, consulte la API de personalización de marca — ese es el rincón editable.