LIVE · LANȚ DE AUDIT · UE
SISTEM · 99,99% UPTIME
v 1.0 ↗ FĂCUT ÎN UE

API Org

Citiți metadatele organizației credențialei. Doar pentru citire pe API-ul public — setările organizației (retenție, SMS opt-in, KYB) sunt gestionate din interfața admin din aplicație, unde lanțul de audit captează cine a modificat ce + când.

Obțineți organizația

GET /api/v1/public/org — permisiune 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"
}
CâmpTipNote
idUUIDStabil pe durata de viață a credențialei.
namestringNume afișat. Vizibil în emailurile de invitație + antetul raportului PDF.
countryISO 3166-1 alpha-2Determină locale-ul implicit + jurisdicția KYB.
settings_jsonbobjectPreferințe la nivel de organizație sub formă liberă (locale implicit, comutator înregistrare automată, etc.). Schema este compatibilă forward — tratați cheile necunoscute ca informative.
retention_daysint | nullCât timp sunt păstrați octeții de probe în stocarea de obiecte înainte ca regulile de ciclu de viață să îi șteargă. null = valoarea implicită a platformei (7 ani pentru deployment-urile conforme eIDAS).
sms_enabledboolDacă livrarea invitațiilor prin SMS este activată. Implicit false; activare prin cardul SMS din admin.
created_atISO 8601Marcă de timp a creării organizației.

Erori frecvente

StatusCodCând
403permission_deniedCredențiala nu are org:read.

Note

  • O organizație per credențială. Fiecare credențială API public este limitată la exact o organizație; nu transmiteți un org_id — credențiala îl rezolvă pe server.
  • Fără suprafață de scriere. Modificările setărilor organizației trec prin interfața admin astfel încât identitatea + motivul operatorului să poată fi auditate. API-ul public rămâne intenționat doar pentru citire.
  • White-label. Pentru personalizarea logo-ului + culorilor, consultați API Branding — acesta este colțul care permite scriere.