Skip to main content
POST
Python

Authorizations

x-api-key
string
header
required

Your application's API key, from Developers -> API keys in the Business Console. The primary key has full access. A named key can be scoped: none, read or write per resource, limited to some workflows or to approved sessions, to a list of IP addresses, and to an expiry date. 401 means the key is missing, wrong, revoked or expired; 403 means the key has no access to this resource or action, or the request came from an address outside its IP list; 404 on a session route means the session is outside the key's workflows or statuses. A key without media access receives image, video and PDF URLs as null, and a key without sessions write receives session links and tokens as null. See https://docs.didit.me/console/api-keys.

Path Parameters

sessionId
string<uuid>
required

UUID of the Business Verification (KYB) session. It must belong to the application of the API key.

Example:

"33333333-4444-5555-6666-777777777777"

Query Parameters

node_id
string

Workflow node of the KYB step. Only needed when the workflow has more than one KYB node; by default Didit uses the session's own node.

Body

application/json
locale
string

Locale used to translate the response of the step the session advances to.

Maximum string length: 10

Response

Parties declared (or already declared).

valid
boolean
next_step
string | null

Step the session is on.

status
string

Status of the business session.

advanced
boolean

true when this call declared the parties and advanced the session.

already_submitted
boolean

true when the parties had been declared by an earlier call.

kyb_key_people_status
string
parties
object[]