Zum Hauptinhalt springen
POST
curl

Überblick

Erstellt explizit ein Unternehmen, bevor eine Sitzung zur Unternehmensverifizierung (KYB) ausgeführt wird.

Wann verwenden

  • Metadaten vorab anlegen (Partner, Stufe, interne Kennungen) vor der ersten Sitzung zur Unternehmensverifizierung (KYB).
  • Migration von einem anderen KYB-Anbieter mit einer bestehenden Unternehmensliste.
  • Nur-Transaktions-Registrierung: Transaktionen für ein Unternehmen übermitteln, das Sie in einem Offline-Prozess verifiziert haben.

Hinweise

  • vendor_data ist erforderlich und muss pro Anwendung eindeutig sein. Duplikate führen zu einem Konfliktfehler. Verwenden Sie PATCH /v3/businesses/{vendor_data}/, um die Daten zu aktualisieren.
  • Aus dem Register stammende Felder (legal_name, registration_number, country_code) können vorab angelegt werden, werden aber durch die Registerdaten der ersten genehmigten Sitzung zur Unternehmensverifizierung (KYB) überschrieben.
  • Wenn country_code in der Liste gefährlicher Länder Ihrer Anwendung enthalten ist, wird das Unternehmen im Status BLOCKED angelegt.
  • Löst business.data.updated aus.

Berechtigungen

Die Rolle muss create:businesses gewähren.

Verwandte Themen

Autorisierungen

x-api-key
string
header
erforderlich

Der API-Schlüssel Ihrer Anwendung, aus Entwickler -> API-Schlüssel in der Business Console. Der Primärschlüssel hat Vollzugriff. Ein benannter Schlüssel kann im Geltungsbereich eingeschränkt werden: keine, Lese- oder Schreibberechtigung pro Ressource, beschränkt auf bestimmte Workflows oder genehmigte Sitzungen, auf eine Liste von IP-Adressen und auf ein Ablaufdatum. 401 bedeutet, dass der Schlüssel falsch, widerrufen oder abgelaufen ist; 403 bedeutet, dass kein Schlüssel gesendet wurde, der Schlüssel keinen Zugriff auf diese Ressource oder Aktion hat oder die Anfrage von einer Adresse außerhalb seiner IP-Liste stammte; 404 bei einer Sitzungsroute bedeutet, dass die Sitzung außerhalb der Workflows oder Status des Schlüssels liegt. Ein Schlüssel ohne Medienzugriff erhält Bild-, Video- und PDF-URLs als null, und ein Schlüssel ohne Schreibberechtigung für Sitzungen erhält Sitzungslinks und Token als null. Siehe https://docs.didit.me/console/api-keys.

Body

application/json
vendor_data
string | null

Ihre eindeutige Kennung für dieses Unternehmen (Freitext-String, KEINE UUID). Optional, aber dringend empfohlen. Wenn angegeben, muss sie unter den nicht gelöschten Unternehmen der Anwendung eindeutig sein; exakt wie übermittelt abgeglichen.

display_name
string | null

Benutzerfreundlicher Anzeigename, der in der Konsole angezeigt wird (hat für die UI-Anzeige Vorrang vor legal_name).

Maximum string length: 255

Offizieller juristischer Name des Unternehmens.

Maximum string length: 255
registration_number
string | null

Unternehmensregister- oder Gründungsnummer.

Maximum string length: 100
country_code
string | null

Gründungsland (ISO 3166-1 Alpha-2, z. B. GB, US).

Maximum string length: 10
status
enum<string>
Standard:ACTIVE

Anfänglicher Lebenszyklusstatus. Standardmäßig ACTIVE.

Verfügbare Optionen:
ACTIVE,
FLAGGED,
BLOCKED
metadata
object | null

Beliebiges JSON-Objekt, das Sie an das Unternehmen anhängen. Standardmäßig {}.

Antwort

Unternehmen erstellt. Vollständiger Unternehmensdatensatz zurückgegeben (gleiche Struktur wie „Get Business“).

Vollständige Unternehmensdetails. Erweitert BusinessListItem um Metadaten und updated_at.

didit_internal_id
string<uuid>

Didits stabile interne UUID für dieses Unternehmen.

vendor_data
string | null

Ihre eindeutige Kennung für dieses Unternehmen (beim Erstellen von Sitzungen übergeben). Dies kann null sein, wenn keine Vendor-Kennung angegeben wurde.

display_name
string | null

Von Ihnen festgelegter benutzerdefinierter Anzeigename

Offizieller juristischer Name aus dem Register oder manueller Eingabe

registration_number
string | null

Unternehmensregister- oder Gründungsnummer

country_code
string | null

Gründungsland (ISO 3166-1 Alpha-2, z. B. GB, US).

effective_name
string | null

Bester verfügbarer Name: display_name, falls gesetzt, andernfalls legal_name

status
enum<string>

Lebenszyklusstatus des Unternehmensdatensatzes (KEIN Sitzungsstatus). ACTIVE ist der Standard, FLAGGED markiert ihn für manuelle Prüfung, BLOCKED verhindert neue Sitzungen für dieses vendor_data.

Verfügbare Optionen:
ACTIVE,
FLAGGED,
BLOCKED
session_count
integer

Gesamtzahl der Verifizierungssitzungen für dieses Unternehmen

approved_count
integer

Anzahl der genehmigten Sitzungen

declined_count
integer

Anzahl der abgelehnten Sitzungen

in_review_count
integer

Anzahl der Sitzungen in Prüfung

features
object

Aggregierter Status pro Funktion über alle KYB-Sitzungen dieses Unternehmens hinweg. Derzeit ist der einzige Schlüssel KYB (der Status der Unternehmensprüfung im Register). Mögliche Werte: Approved, Declined, In Review, Not Finished, Resub Requested.

features_list
object[]

Dieselben Daten wie features, als geordnetes Array von {feature, status}-Objekten.

last_session_at
string<date-time> | null

Zeitstempel der letzten Sitzung

first_session_at
string<date-time> | null

Zeitstempel der ersten Sitzung

last_activity_at
string<date-time> | null

Zeitstempel der letzten Aktivität (Statusänderung, Sitzungsaktualisierung usw.)

tags
object[]

Diesem Unternehmen zugewiesene Tags

created_at
string<date-time>
metadata
object

Benutzerdefiniertes Metadaten-JSON, das Sie diesem Unternehmen angehängt haben. Standardmäßig {}.

updated_at
string<date-time>
Zuletzt geändert am 7. November 2026