Skip to main content
PATCH
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"

draftId
string<uuid>
required

UUID of the party draft (draft_id returned when it was created).

Example:

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

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

Any subset of the party fields. The edit is merged into the stored draft and the merged party is validated as a whole, so a draft that could be submitted before an edit can still be submitted after it.

entity_type
enum<string>

Whether the party is an individual or a company.

Available options:
person,
company
full_name
string

Full name of a person. Send it, or first_name and last_name.

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

Role the party holds. Interchangeable with roles; when both are sent they are merged.

Available options:
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>[]

Every role the party holds. A person needs at least one role (here or in role).

Available options:
director,
non_executive_director,
secretary,
chairman,
ubo,
shareholder,
representative,
founder,
legal_advisor,
authorized_signatory,
trustee,
beneficiary,
settlor,
protector,
company_officer,
investor,
other
position
string

Job title of a person.

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

Name of a company party. Required when entity_type is company.

Maximum string length: 255
registration_number
string

Registration number of a company party.

Maximum string length: 100
email
string<email>

Where the verification link is sent. Required when the party has to complete verification, which depends on the role settings and ownership thresholds of the workflow.

ownership_percent
number | null

Share of the company the party owns.

nationality
string

Nationality of a person, or country of incorporation of a company. Required for every party.

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

Workflow-defined extra fields.

skip_verification
boolean
default:false

Ask to skip this party's verification. Honoured only when the party's role allows skipping in the workflow's Key People settings.

Response

Draft updated.

draft_id
string<uuid>
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
party
object
required