Saltar para o conteúdo principal
GET
curl
Cada chamada a Atualizar estado da funcionalidade regista uma substituição do estado de uma verificação. Este endpoint lista todas as substituições de uma sessão, da mais recente para a mais antiga, sem paginação.

Estados da substituição

Uma substituição com forced: true foi aplicada de imediato, enquanto a pessoa ainda estava no fluxo.

Motivo do cancelamento de uma substituição em espera

Posição da pessoa no fluxo

person_in_flow é true enquanto a sessão estiver em Not Started, In Progress ou Resubmitted e a pessoa não tiver concluído o fluxo. Enquanto for true, uma nova substituição com defer_until_flow_finishes: true fica em espera. flow_finished_at indica quando a pessoa concluiu o fluxo pela última vez. Fica a null enquanto ela ainda estiver no fluxo, incluindo um reenvio, e quando a sessão foi encerrada antes de ela o concluir.

Consulte também

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. Aceita IDs de sessão de utilizador (KYC) e de empresa (KYB).

Exemplo:

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

Resposta

As substituições da verificação da sessão, da mais recente para a mais antiga.

session_id
string<uuid>
obrigatório
Exemplo:

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

person_in_flow
boolean
obrigatório

Se a pessoa ainda está no fluxo, pelo que uma nova substituição com defer_until_flow_finishes: true aguardaria.

Exemplo:

true

flow_finished_at
string<date-time> | null
obrigatório

Quando a pessoa concluiu o fluxo pela última vez. null enquanto ainda estiver no mesmo (incluindo uma ressubmissão) e quando a sessão foi encerrada antes de terminar (abandonada, expirada ou quando foi tomada uma decisão a meio do fluxo).

Exemplo:

null

overrides
object[]
obrigatório

Cada anulação da sessão, da mais recente para a mais antiga.

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