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

multipart/form-data
documents
file[]
required

Files to upload: JPG, JPEG, PNG, TIFF, WEBP, PDF or ZIP archives of them. PDFs up to 50 MB, photos up to 6 MB before compression.

document_passwords
string[]

One entry per file in documents, in the same order: the password of a protected PDF, empty for any other file.

document_group
enum<string>

Required document group this upload answers.

Available options:
LEGAL_PRESENCE,
COMPANY_DETAILS,
OWNERSHIP_STRUCTURE,
REPRESENTATIVES_AUTHORIZATION
locale
string

Locale used to translate the response of the next step.

Maximum string length: 10

Response

Documents processed. When every required group is satisfied the session advances and next_step names the next step; otherwise it stays on the Documents step and document_groups and document_answer say what is still missing.

valid
boolean
next_step
string | null

Step the session is on after the upload.

kyb_status
string

Status of the company check.

document_answer
object

Result per uploaded document and the uploads left.