Zum Hauptinhalt springen
PATCH
Python

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

sessionId
string<uuid>
erforderlich

UUID der Sitzung zur Unternehmensverifizierung (KYB). Sie muss zu der Anwendung des API-Schlüssels gehören.

Beispiel:

"33333333-4444-5555-6666-777777777777"

draftId
string<uuid>
erforderlich

UUID des Entwurfs der Partei (draft_id, die bei der Erstellung zurückgegeben wurde).

Beispiel:

"5b0d7a52-9d3e-4f0c-8c6a-0e5f3a1b2c4d"

Abfrageparameter

node_id
string

Workflow-Knoten des KYB-Schritts. Nur erforderlich, wenn der Workflow mehr als einen KYB-Knoten enthält; standardmäßig verwendet Didit den sitzungseigenen Knoten.

Body

application/json

Jede beliebige Teilmenge der Parteifelder. Die Bearbeitung wird mit dem gespeicherten Entwurf zusammengeführt und die zusammengeführte Partei als Ganzes validiert, sodass ein Entwurf, der vor einer Bearbeitung übermittelt werden konnte, auch danach noch übermittelt werden kann.

entity_type
enum<string>

Gibt an, ob die Partei eine Einzelperson oder ein Unternehmen ist.

Verfügbare Optionen:
person,
company
full_name
string

Vollständiger Name einer Person. Übergeben Sie diesen oder first_name und last_name.

Maximum string length: 255
first_name
string
Maximum string length: 128
last_name
string
Maximum string length: 128
role
enum<string>

Rolle, die die Partei innehat. Austauschbar mit roles; wenn beide übermittelt werden, werden sie zusammengeführt.

Verfügbare Optionen:
director,
non_executive_director,
secretary,
chairman,
ubo,
shareholder,
representative,
founder,
legal_advisor,
authorized_signatory,
trustee,
beneficiary,
settlor,
protector,
company_officer,
investor,
other
roles
enum<string>[]

Jede Rolle, die die Partei innehat. Eine Person benötigt mindestens eine Rolle (hier oder in role).

Verfügbare Optionen:
director,
non_executive_director,
secretary,
chairman,
ubo,
shareholder,
representative,
founder,
legal_advisor,
authorized_signatory,
trustee,
beneficiary,
settlor,
protector,
company_officer,
investor,
other
position
string

Berufsbezeichnung einer Person.

Maximum string length: 128
date_of_birth
string<date> | null
company_name
string

Name einer Unternehmenspartei. Erforderlich, wenn entity_type company ist.

Maximum string length: 255
registration_number
string

Registernummer einer Unternehmenspartei.

Maximum string length: 100
email
string<email>

Wohin der Verifizierungslink gesendet wird. Erforderlich, wenn die Partei die Verifizierung abschließen muss, was von den Rolleneinstellungen und Eigentümerstruktur-Schwellenwerten des Workflows abhängt.

ownership_percent
number | null

Anteil am Unternehmen, den die Partei besitzt.

nationality
string

Staatsangehörigkeit einer Person oder Gründungsland eines Unternehmens. Erforderlich für jede Partei.

Maximum string length: 100
phone_number
string
Maximum string length: 32
custom_fields
object

Vom Workflow definierte Zusatzfelder.

skip_verification
boolean
Standard:false

Anfordern, die Verifizierung dieser Partei zu überspringen. Wird nur berücksichtigt, wenn die Rolle der Partei das Überspringen in den Einstellungen für Schlüsselpersonen des Workflows zulässt.

Antwort

Entwurf aktualisiert.

draft_id
string<uuid>
erforderlich
created_at
string<date-time>
erforderlich
updated_at
string<date-time>
erforderlich
party
object
erforderlich
Zuletzt geändert am 7. November 2026