Zum Hauptinhalt springen
POST
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"

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
locale
string

Gebietsschema zur Übersetzung der Antwort des Schritts, zu dem die Sitzung übergeht.

Maximum string length: 10

Antwort

Deklarierte (oder bereits deklarierte) Parteien.

valid
boolean
next_step
string | null

Schritt, in dem sich die Sitzung befindet.

status
string

Status der Unternehmenssitzung.

advanced
boolean

true, wenn dieser Aufruf die Parteien deklariert und die Sitzung weitergeführt hat.

already_submitted
boolean

true, wenn die Parteien durch einen früheren Aufruf deklariert worden waren.

kyb_key_people_status
string
parties
object[]
Zuletzt geändert am 7. November 2026