LIVE · AUDIT-KETTE · EU-ANSÄSSIG
SYSTEM · 99,99 % VERFÜGBARKEIT
v 1.0 ↗ HERGESTELLT IN DER EU

Org-API

Lesen Sie die Organisations-Metadaten des Credentials. Schreibgeschützt in der öffentlichen API — Org-Einstellungen (Aufbewahrung, SMS-Opt-in, KYB) werden über die In-App-Admin-Oberfläche verwaltet, wo die Audit-Kette erfasst, wer was + wann geändert hat.

Die Organisation abrufen

GET /api/v1/public/org — Bereich 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"
}
FeldTypHinweise
idUUIDÜber die gesamte Lebensdauer des Credentials stabil.
namestringAnzeigename. Erscheint in Einladungs-E-Mails + im Kopf des PDF-Berichts.
countryISO 3166-1 alpha-2Bestimmt Standard-Locale + KYB-Jurisdiktion.
settings_jsonbobjectFrei formatierbare Einstellungen auf Org-Ebene (Standard-Locale, Auto-Aufzeichnungs-Toggle usw.). Das Schema ist vorwärtskompatibel — behandeln Sie unbekannte Keys als informativ.
retention_daysint | nullWie lange Beweis-Bytes im Objektspeicher aufbewahrt werden, bevor Lifecycle-Regeln sie bereinigen. null = Plattform-Standard (7 Jahre für eIDAS-konforme Deployments).
sms_enabledboolOb die SMS-Einladungszustellung aktiviert ist. Standardmäßig false; Opt-in über die Admin-SMS-Karte.
created_atISO 8601Zeitstempel der Org-Erstellung.

Häufige Fehler

StatusCodeWann
403permission_deniedDem Credential fehlt org:read.

Hinweise

  • Eine Organisation pro Credential. Jedes Public-API-Credential ist auf genau eine Organisation beschränkt; Sie übergeben keine org_id — das Credential löst sie serverseitig auf.
  • Keine Schreiboberfläche. Änderungen an Org-Einstellungen laufen über die Admin-UI, damit Identität + Begründung des Operators auditierbar sind. Die öffentliche API bleibt hier bewusst schreibgeschützt.
  • White-Label. Für die Anpassung von Logo + Farben siehe die Branding-API — das ist der beschreibbare Bereich.