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
locale
string

Localidade usada para traduzir a resposta da etapa para a qual a sessão avança.

Maximum string length: 10

Resposta

Partes declaradas (ou já declaradas).

valid
boolean
next_step
string | null

Etapa em que a sessão está.

status
string

Status da sessão de empresa.

advanced
boolean

true quando esta chamada declarou as partes e avançou a sessão.

already_submitted
boolean

true quando as partes já haviam sido declaradas por uma chamada anterior.

kyb_key_people_status
string
parties
object[]
Última modificação em 1 de novembro de 2026