EN DIRECT · AUDIT CHAÎNÉ · ÉDR UE
SYSTÈME · 99,99% DISPONIBILITÉ
v 1.0 ↗ FAIT EN UE

API Org

Lisez les métadonnées de l'organisation de l'identifiant. En lecture seule sur l'API publique — les paramètres de l'organisation (rétention, opt-in SMS, KYB) sont gérés depuis la surface d'administration in-app, où la chaîne d'audit enregistre qui a modifié quoi + quand.

Récupérer l'organisation

GET /api/v1/public/org — Portée 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"
}
ChampTypeNotes
idUUIDStable pendant toute la durée de vie de l'identifiant.
namestringNom d'affichage. Affiché dans les e-mails d'invitation + l'en-tête du rapport PDF.
countryISO 3166-1 alpha-2Détermine la locale par défaut + la juridiction KYB.
settings_jsonbobjectPréférences libres au niveau de l'organisation (locale par défaut, bascule d'enregistrement automatique, etc.). Le schéma est compatible ascendant — traitez les clés inconnues comme informatives.
retention_daysint | nullDurée pendant laquelle les octets de preuve sont conservés dans le stockage objet avant que les règles de cycle de vie ne les purgent. null = valeur par défaut de la plateforme (7 ans pour les déploiements conformes eIDAS).
sms_enabledboolIndique si l'envoi d'invitations par SMS est activé. Faux par défaut ; opt-in via la carte SMS de l'administration.
created_atISO 8601Horodatage de création de l'organisation.

Erreurs courantes

StatutCodeQuand
403permission_deniedL'identifiant n'a pas org:read.

Notes

  • Une organisation par identifiant. Chaque identifiant d'API publique est limité à exactement une organisation ; vous ne passez pas d'org_id — l'identifiant le résout côté serveur.
  • Aucune surface d'écriture. Les modifications des paramètres de l'organisation passent par l'interface d'administration afin que l'identité + le motif de l'opérateur puissent être audités. L'API publique reste ici volontairement en lecture seule.
  • Marque blanche. Pour la personnalisation du logo + des couleurs, voir l' API de branding — c'est le coin accessible en écriture.