Saltar para o conteúdo principal
POST
Python

Autorizações

x-api-key
string
header
obrigatório

A chave de API da sua aplicação, a partir de Programadores -> Chaves de API na Business Console. A chave principal tem acesso total. Uma chave nomeada pode ter o âmbito definido: nenhum, leitura ou escrita por recurso, limitada a alguns fluxos ou a sessões aprovadas, a uma lista de endereços IP e a uma data de validade. 401 significa que a chave está incorreta, revogada ou expirada; 403 significa que nenhuma chave foi enviada, que a chave não tem acesso a este recurso ou ação, ou que o pedido veio de um endereço fora da sua lista de IP; 404 numa rota de sessão significa que a sessão está fora dos fluxos ou estados da chave. Uma chave sem acesso a multimédia recebe URLs de imagens, vídeos e PDFs como nulos, e uma chave sem permissão de escrita em sessões recebe ligações de sessão e tokens como nulos. Consulte https://docs.didit.me/console/api-keys.

Parâmetros de caminho

sessionId
string<uuid>
obrigatório

UUID da sessão de Verificação de empresas (KYB). Tem de pertencer à aplicação da chave de API.

Exemplo:

"33333333-4444-5555-6666-777777777777"

Parâmetros de consulta

node_id
string

Nó do fluxo do passo de KYB. Apenas necessário quando o fluxo tem mais de um nó de KYB; por predefinição, a Didit utiliza o nó próprio da sessão.

Corpo

application/json
entity_type
enum<string>
obrigatório

Se a parte é uma pessoa singular ou uma empresa.

Opções disponíveis:
person,
company
nationality
string
obrigatório

Nacionalidade de uma pessoa ou país de constituição de uma empresa. Obrigatório para todas as partes.

Maximum string length: 100
full_name
string

Nome completo de uma pessoa. Envie este campo, ou first_name e last_name.

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

Função desempenhada pela parte. Intercambiável com roles; quando ambas forem enviadas, são combinadas.

Opções disponíveis:
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>[]

Cada função que a parte desempenha. Uma pessoa necessita de pelo menos uma função (aqui ou em role).

Opções disponíveis:
director,
non_executive_director,
secretary,
chairman,
ubo,
shareholder,
representative,
founder,
legal_advisor,
authorized_signatory,
trustee,
beneficiary,
settlor,
protector,
company_officer,
investor,
other
position
string

Cargo de uma pessoa.

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

Nome de uma parte da empresa. Obrigatório quando entity_type é company.

Maximum string length: 255
registration_number
string

Número de registo de uma entidade empresarial.

Maximum string length: 100
email
string<email>

Para onde a ligação de verificação é enviada. Obrigatório quando a parte tem de concluir a verificação, o que depende das definições de funções e dos limiares de propriedade do fluxo.

ownership_percent
number | null

Percentagem da empresa que a parte detém.

phone_number
string
Maximum string length: 32
custom_fields
object

Campos adicionais definidos pelo fluxo.

skip_verification
boolean
padrão:false

Pedir para ignorar a verificação desta parte. Respeitado apenas quando a função da parte permite ignorar nas definições de Pessoas-chave do fluxo.

Resposta

Rascunho criado.

draft_id
string<uuid>
obrigatório
created_at
string<date-time>
obrigatório
updated_at
string<date-time>
obrigatório
party
object
obrigatório
Última modificação em 7 de novembro de 2026