Zum Hauptinhalt springen
PATCH
curl

Überblick

Aktualisiert änderbare Felder einer Unternehmensentität. Felder, die aus Abfragen im Unternehmensregister befüllt wurden (legal_name, registration_number, country_code), werden nach der ersten genehmigten Sitzung zur Unternehmensverifizierung (KYB) schreibgeschützt.

Wann die Methode verwendet wird

  • Umbenennen: einen besseren display_name für interne Ansichten setzen.
  • Metadaten aktualisieren: ein Unternehmen zwischen internen Stufen verschieben, eine interne Notiz erfassen oder Tags ändern.
  • Registerdaten überschreiben (mit Vorsicht): Überschreibungen werden akzeptiert, aber im Audit-Log markiert.

Hinweise

  • vendor_data in der URL kann über diesen Endpoint nicht geändert werden.
  • Löst einen business.data.updated-Webhook mit einem changed_fields-Array aus.
  • Jede Änderung wird in der Aktivität des Unternehmens in der Business Console protokolliert. Eine Änderung von status wird mit dem optionalen reason (bis zu 1000 Zeichen) protokolliert, eine Änderung an display_name, legal_name, registration_number, country_code oder metadata als Profilaktualisierung. Der business.status.updated-Webhook enthält kein reason.

Berechtigungen

Das primäre Secret und API-Schlüssel mit Vollzugriff können diesen Endpoint immer aufrufen. Ein Schlüssel mit benutzerdefiniertem Zugriff benötigt Schreibrechte für Unternehmen (businesses). Ein Schlüssel, der auf bestimmte Workflows oder auf genehmigte Sitzungen beschränkt ist, kann diesen Endpoint nicht aufrufen. Die Rollen und Berechtigungen der Console legen fest, was ein Teammitglied in der Console tun darf. Bei API-Schlüssel-Anfragen werden sie nicht ausgewertet.

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.

Pfadparameter

vendor_data
string
erforderlich

Ihre eindeutige Kennung für das Unternehmen (Freitext-String, KEINE UUID).

Body

application/json

Body für partielle Aktualisierung. Geben Sie nur die Felder an, die Sie ändern möchten.

display_name
string | null

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

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).

status
enum<string>

Lebenszyklusstatus des Unternehmens. Das Festlegen von BLOCKED fügt vendor_data automatisch der Systemsperrliste hinzu; der Wechsel von BLOCKED zu einem anderen Status entfernt diesen Sperrlisteneintrag wieder.

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

Beliebiges JSON-Objekt, das Sie an das Unternehmen anhängen. Ersetzt vollständig die vorhandenen Metadaten bei einer Aktualisierung – führen Sie diese clientseitig zusammen, wenn Sie nur Schlüssel hinzufügen möchten.

reason
string | null

Warum sich der Status geändert hat. Wird im Statusänderungseintrag unter Activity des Unternehmens in der Business Console erfasst, nur wenn sich der Status tatsächlich ändert. Webhooks übertragen dies nicht.

Maximum string length: 1000

Antwort

Unternehmen aktualisiert. Der vollständige aktualisierte Unternehmensdatensatz wird zurückgegeben.

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