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

Localidade utilizada para traduzir a resposta do passo para o qual a sessão avança.

Maximum string length: 10

Resposta

Partes declaradas (ou já declaradas).

valid
boolean
next_step
string | null

Passo em que a sessão se encontra.

status
string

Estado da sessão da empresa.

advanced
boolean

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

already_submitted
boolean

true quando as partes tinham sido declaradas por uma chamada anterior.

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