Saltar al contingut principal
POST
Python

Autoritzacions

x-api-key
string
header
requerit

La clau d'API de la teva aplicació, des de Developers -> API keys a la Business Console. La clau primària té accés complet. Una clau amb nom pot tenir l'abast limitat: cap, lectura o escriptura per recurs, limitada a determinats fluxos de treball o a sessions aprovades, a una llista d'adreces IP i a una data de caducitat. 401 significa que la clau és incorrecta, revocada o caducada; 403 significa que no s'ha enviat cap clau, que la clau no té accés a aquest recurs o acció, o que la sol·licitud prové d'una adreça fora de la seva llista d'IP; 404 en una ruta de sessió significa que la sessió està fora dels fluxos de treball o estats de la clau. Una clau sense accés a fitxers multimèdia rep els URL d'imatge, vídeo i PDF com a null, i una clau sense permís d'escriptura de sessions rep els enllaços de sessió i els tokens com a null. Consulta https://docs.didit.me/console/api-keys.

Paràmetres de ruta

sessionId
string<uuid>
requerit

UUID de la sessió de Verificació d'empreses (KYB). Ha de pertànyer a l'aplicació de la clau d'API.

Exemple:

"33333333-4444-5555-6666-777777777777"

Paràmetres de consulta

node_id
string

Node del flux de treball del pas de KYB. Només cal quan el flux de treball té més d'un node de KYB; per defecte, Didit utilitza el node propi de la sessió.

Cos

application/json
entity_type
enum<string>
requerit

Si la part és una persona física o una empresa.

Opcions disponibles:
person,
company
nationality
string
requerit

Nacionalitat d'una persona, o país de constitució d'una empresa. Obligatori per a cada part.

Maximum string length: 100
full_name
string

Nom complet d'una persona. Envia aquest camp, o bé first_name i last_name.

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

Rol que té la part. Intercanviable amb roles; quan s'envien tots dos, es fusionen.

Opcions disponibles:
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>[]

Tots els rols que té la part. Una persona necessita almenys un rol (aquí o a role).

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

Càrrec laboral d'una persona.

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

Nom d'una part empresarial. Obligatori quan entity_type és company.

Maximum string length: 255
registration_number
string

Número de registre d'una part de l'empresa.

Maximum string length: 100
email
string<email>

On s'envia l'enllaç de verificació. Obligatori quan la part ha de completar la verificació, cosa que depèn de la configuració del rol i dels llindars de titularitat del flux de treball.

ownership_percent
number | null

Participació de l'empresa que posseeix la part interessada.

phone_number
string
Maximum string length: 32
custom_fields
object

Camps addicionals definits pel flux de treball.

skip_verification
boolean
predeterminat:false

Demana ometre la verificació d'aquesta part. Només s'accepta quan el rol de la part permet l'omissió a la configuració de Persones clau del flux de treball.

Resposta

Esborrany creat.

draft_id
string<uuid>
requerit
created_at
string<date-time>
requerit
updated_at
string<date-time>
requerit
party
object
requerit
Darrera modificació el 7 de novembre del 2026