Saltar para o conteúdo principal
POST
curl
Use esta opção quando a ligação anterior já não funciona: a sessão foi eliminada ou expirou antes de a pessoa a ter iniciado. As sessões eliminadas são elegíveis mesmo que a pessoa já tenha iniciado ou concluído a verificação. As sessões importadas não são elegíveis por expiração; têm de ter sido eliminadas. Uma sessão que não foi eliminada e que a pessoa já tinha iniciado não é elegível por expiração. A nova sessão fica associada à mesma entidade, pelo que o respetivo resultado é tido em conta na verificação de pessoas-chave, tal como aconteceria com a sessão original. A ligação permanece válida durante o período de validade da sessão do fluxo KYC que executa (de 1 hora a 4 semanas), e não o da sessão empresarial. Consulte a entidade e as respetivas sessões secundárias na decisão da sessão empresarial. Se a pessoa não deve ser verificada de todo, ignore a entidade. Consulte Pessoas-chave para saber como funcionam as entidades e as respetivas verificações.

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-pai 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_checks[].submitted.parties[].uuid na decisão da sessão de empresa). Tem de pertencer à sessão referenciada por sessionId.

Exemplo:

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

Resposta

Nova sessão de KYC criada. Devolve a parte atualizada com a sua nova sessão filha, que expira após o tempo de expiração de sessão do respetivo fluxo de KYC.

Uma parte de pessoas-chave de uma sessão de Verificação de empresas (KYB), com a sua verificação subordinada. 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 singular ou uma empresa.

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

REGISTRY: obtido a partir do registo de empresas. USER: introduzido no ecrã Pessoas-chave.

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

Nome de apresentaçã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. A regeneração elimina esta isenção.

requires_verification
boolean
obrigatório

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

roles
object[]
obrigatório

Funções que a parte desempenha na empresa.

kyc_session_deleted
boolean
obrigatório

A sessão de KYC subordinada foi eliminada, pelo que nunca poderá ser concluída.

kyb_sub_session_deleted
boolean
obrigatório

Equivalente da parte empresarial de kyc_session_deleted.

first_name
string | null

Primeiro nome (pessoas).

last_name
string | null

Apelido (pessoas singulares).

company_name
string | null

Nome da empresa (partes empresariais).

registration_number
string | null

Número de registo da empresa (partes empresariais).

email
string<email> | null

E-mail para o qual a ligação de verificação é enviada.

nationality
string | null

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

phone_number
string | null

Número de telefone recolhido para a parte.

date_of_birth
string<date> | null

Data de nascimento (pessoas).

position
string | null

Cargo em texto livre (pessoas singulares).

custom_fields
object

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

kyc_session_id
string<uuid> | null

Sessão KYC individual dependente (pessoas singulares).

kyc_session_status
enum<string> | null

Estado da sessão KYC subordinada. Uma sessão eliminada mantém o estado que tinha quando foi eliminada.

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

Ligação alojada da sessão de KYC dependente. null quando não existe nenhuma ou se foi eliminada, e para uma chave de API com âmbito restrito sem sessions: write.

kyb_sub_session_id
string<uuid> | null

Sessão KYB dependente (partes empresariais).

kyb_sub_session_status
enum<string> | null

Estado da sessão KYB subordinada.

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

Ligação alojada da sessão de KYB dependente, com as mesmas regras de null que kyc_session_url.

verification_workflow_type
enum<string> | null

Tipo do fluxo que a sessão filha executa.

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 que a sessão filha executa.

verification_workflow_label
string | null

Rótulo desse fluxo.

verification_workflow_features
object[] | null

Funcionalidades do fluxo da sessão filha com o respetivo estado atual.

didit_internal_id
string<uuid> | null

Identificador da Didit da pessoa verificada, assim que conhecida.

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