Pular para o conteúdo principal
POST
Python

Autorizações

x-api-key
string
header
obrigatório

Chave de API da sua aplicação, em Developers -> API keys no Business Console. A chave principal tem acesso total. Uma chave nomeada pode ter escopo restrito: nenhum acesso, 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á errada, 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 a requisição veio de um endereço fora da sua lista de IPs; 404 em uma rota de sessão significa que a sessão está fora dos fluxos ou status da chave. Uma chave sem acesso a mídia recebe URLs de imagem, vídeo e PDF como null, e uma chave sem permissão de escrita em sessões recebe links e tokens de sessão como null. 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). Ela deve pertencer à aplicação da chave de API.

Exemplo:

"33333333-4444-5555-6666-777777777777"

Parâmetros de consulta

node_id
string

Nó do fluxo da etapa de KYB. Necessário apenas quando o fluxo tem mais de um nó de KYB; por padrão, a Didit usa o próprio nó da sessão.

Corpo

application/json
entity_type
enum<string>
obrigatório

Se a parte é uma pessoa física 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 exercida pela parte. Intercambiável com roles; quando ambos são enviados, eles são mesclados.

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>[]

Todas as funções que a parte exerce. Uma pessoa precisa 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 do tipo empresa. Obrigatório quando entity_type é company.

Maximum string length: 255
registration_number
string

Número de registro de uma parte que é empresa.

Maximum string length: 100
email
string<email>

Para onde o link de verificação é enviado. Obrigatório quando a parte precisa concluir a verificação, o que depende das configurações de função e dos limiares de propriedade do fluxo de verificação (workflow).

ownership_percent
number | null

Participação na empresa detida pela parte.

phone_number
string
Maximum string length: 32
custom_fields
object

Campos extras definidos pelo fluxo.

skip_verification
boolean
padrão:false

Solicite que a verificação desta parte seja pulada. Atendido apenas quando a função da parte permite pular a verificação nas configuraçõ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 1 de novembro de 2026