Pular para o conteúdo principal
POST
curl
Use isto quando o link anterior não funciona mais: a sessão foi excluída ou expirou antes de a pessoa sequer iniciá-la. Sessões excluídas são elegíveis mesmo que a pessoa já tenha iniciado ou concluído a verificação. Sessões importadas não são elegíveis por expiração; elas precisam ter sido excluídas. Uma sessão que não foi excluída e que a pessoa já havia iniciado não é elegível por expiração. A nova sessão fica vinculada à mesma parte, então o resultado dela entra na verificação de pessoas-chave como o da sessão original entraria, e o link permanece válido pelo tempo de expiração da sessão do fluxo de KYC que ela executa (de 1 hora a 4 semanas), não o da sessão de empresa. Consulte a parte e as sessões filhas dela na decisão da sessão de empresa. Se a pessoa não deve ser verificada de forma alguma, ignore a parte em vez disso. Veja Pessoas-chave para entender como as partes e as verificações delas funcionam.

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 principal de Verificação de empresas (KYB).

Exemplo:

"33333333-4444-5555-6666-777777777777"

partyUuid
string<uuid>
obrigatório

UUID da parte de pessoas-chave (Key People) (key_people_checks[].submitted.parties[].uuid na decisão da sessão de empresa). Deve pertencer à sessão referenciada por sessionId.

Exemplo:

"0a3f1e2c-7c2f-4a1b-9d55-2f8d2a5d6b41"

Resposta

Nova sessão de KYC criada. Retorna a parte atualizada com sua nova sessão filha, que expira após o tempo de expiração de sessão do fluxo de verificação (workflow) de KYC correspondente.

Uma parte de pessoas-chave de uma sessão de Verificação de empresas (KYB), com sua verificação filha. A mesma parte aparece em key_people_checks[].submitted.parties[] da decisão da sessão da empresa.

uuid
string<uuid>
obrigatório

Identificador da parte.

entity_type
enum<string>
obrigatório

Se a parte é uma pessoa física ou uma empresa.

Opções disponíveis:
person,
company
source
enum<string>
obrigatório

REGISTRY: obtido do registro de empresas. USER: informado na tela Pessoas-chave.

Opções disponíveis:
REGISTRY,
USER
name
string
obrigatório

Nome de exibição da parte.

is_active
boolean
obrigatório

Se a parte está ativa.

is_skipped
boolean
obrigatório

Se a parte está isenta de verificação. Gerar novamente limpa esse valor.

requires_verification
boolean
obrigatório

Se as regras de função e de propriedade exigem uma verificação para esta parte.

roles
object[]
obrigatório

Funções que a parte exerce na empresa.

kyc_session_deleted
boolean
obrigatório

A sessão de KYC filha foi excluída, portanto nunca poderá ser concluída.

kyb_sub_session_deleted
boolean
obrigatório

Equivalente de kyc_session_deleted para partes do tipo empresa.

first_name
string | null

Primeiro nome (pessoas físicas).

last_name
string | null

Sobrenome (pessoas).

company_name
string | null

Nome da empresa (partes do tipo empresa).

registration_number
string | null

Número de registro da empresa (partes do tipo empresa).

email
string<email> | null

E-mail para o qual o link de verificação é enviado.

nationality
string | null

Nacionalidade para pessoas, país de constituição para empresas.

phone_number
string | null

Número de telefone coletado para a parte.

date_of_birth
string<date> | null

Data de nascimento (pessoas).

position
string | null

Cargo em texto livre (pessoas).

custom_fields
object

Campos personalizados definidos pelo fluxo e coletados para a parte, indexados pela chave do campo.

kyc_session_id
string<uuid> | null

Sessão KYC individual filha (pessoas).

kyc_session_status
enum<string> | null

Status da sessão de KYC filha. Uma sessão excluída mantém o status que tinha quando foi excluída.

Opções disponíveis:
Not Started,
In Progress,
Approved,
Declined,
In Review,
Expired,
Abandoned,
Kyc Expired,
Resubmitted,
Awaiting User,
null
kyc_session_url
string<uri> | null

Link hospedado da sessão KYC filha. null quando ela não existe ou foi excluída, e para uma chave de API com escopo sem sessions: write.

kyb_sub_session_id
string<uuid> | null

Sessão KYB filha (partes que são empresas).

kyb_sub_session_status
enum<string> | null

Status da sessão de KYB filha.

Opções disponíveis:
Not Started,
In Progress,
Approved,
Declined,
In Review,
Expired,
Abandoned,
Kyc Expired,
Resubmitted,
Awaiting User,
null
kyb_sub_session_url
string<uri> | null

Link hospedado da sessão KYB filha, com as mesmas regras de null que kyc_session_url.

verification_workflow_type
enum<string> | null

Tipo do fluxo executado pela sessão filha.

Opções disponíveis:
kyc,
kyb,
adaptive_age_verification,
biometric_authentication,
address_verification,
questionnaire_verification,
email_verification,
phone_verification,
null
verification_workflow_id
string<uuid> | null

Fluxo executado pela sessão filha.

verification_workflow_label
string | null

Rótulo desse fluxo.

verification_workflow_features
object[] | null

Recursos do fluxo de verificação (workflow) da sessão filha, com o status atual de cada um.

didit_internal_id
string<uuid> | null

Identificador da Didit para a pessoa verificada, quando conhecido.

Última modificação em 1 de novembro de 2026