LIVE · AUDIT-CHAINED · EU-RESIDENT
SYSTEM · 99.99% UPTIME
v 1.0 ↗ MADE IN EU

Org API

Read the credential's organisation metadata. Read-only on the public API — org settings (retention, SMS opt-in, KYB) are managed from the in-app admin surface where the audit chain captures who changed what + when.

Get the org

GET /api/v1/public/org — scope 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"
}
FieldTypeNotes
idUUIDStable across the credential's lifetime.
namestringDisplay name. Shown in invite emails + the PDF report header.
countryISO 3166-1 alpha-2Drives default locale + KYB jurisdiction.
settings_jsonbobjectFree-form org-level preferences (default locale, auto-record toggle, etc.). Schema is forward-compatible — treat unknown keys as informational.
retention_daysint | nullHow long Evidence bytes are kept in object storage before lifecycle rules purge them. null = platform default (7 years for eIDAS-compliant deployments).
sms_enabledboolWhether SMS invite delivery is enabled. Defaults to false; opt-in via the admin SMS card.
created_atISO 8601Org-creation timestamp.

Common errors

StatusCodeWhen
403permission_deniedCredential lacks org:read.

Notes

  • One org per credential. Every public-API credential is scoped to exactly one organisation; you don't pass an org_id — the credential resolves it server-side.
  • No write surface. Mutations to org settings go through the admin UI so the operator's identity + reason can be audited. The public API stays read-only here on purpose.
  • White-label. For logo + colour customisation, see the Branding API — that's the writeable corner.