Saltar para o conteúdo principal
POST
curl

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.

Cabeçalhos

Content-Type
string

Defina como application/json ao enviar um corpo JSON.

Exemplo:

"application/json"

Parâmetros de caminho

session_id
string<uuid>
obrigatório

UUID da sessão de Verificação de utilizadores (KYC). Tem de pertencer à mesma aplicação da chave de API — UUIDs entre aplicações, sessões eliminadas e IDs de sessões de Verificação de empresas (KYB) devolvem todos 404.

Exemplo:

"8c2f3a14-7e9b-4d23-9e83-3f7d5e8a1c6d"

Corpo

application/json
new_status
enum<string> | null

Etiqueta de estado opcional a registar na entrada. Aceita qualquer valor de estado da sessão, sensível a maiúsculas e minúsculas ("approved" é rejeitado com 400). Registar um estado aqui não altera o estado real da sessão — utilize o endpoint de atualização de estado para esse efeito.

Opções disponíveis:
Not Started,
In Progress,
Approved,
Declined,
In Review,
Expired,
Abandoned,
Kyc Expired,
Resubmitted,
Awaiting User
Exemplo:

"In Review"

comment
string | null

Nota de texto livre opcional (sem limite de comprimento imposto). Armazenada literalmente; as menções @email não são processadas neste endpoint.

Exemplo:

"Flagging for manual document re-check."

Resposta

Entrada registada no registo de auditoria da sessão. A sessão em si não é alterada — o respetivo status mantém o valor anterior e nenhum webhook é enviado. A nova entrada também aparece no topo de GET …/reviews/ (com actor_display: "Unknown").

user
string

Nome de apresentação do autor da entrada. Sempre "Unknown" para entradas criadas através deste endpoint, porque não regista a atribuição do interveniente.

Exemplo:

"Unknown"

new_status
enum<string> | null

A etiqueta de estado registada na entrada, ou null se nenhuma tiver sido enviada. O estado real da sessão não é afetado.

Opções disponíveis:
Not Started,
In Progress,
Approved,
Declined,
In Review,
Expired,
Abandoned,
Kyc Expired,
Resubmitted,
Awaiting User
Exemplo:

"In Review"

comment
string | null

A nota registada na entrada, ou null se nenhuma tiver sido enviada.

Exemplo:

"Flagging for manual document re-check."

created_at
string<date-time>

Quando a entrada foi gravada, ISO 8601 UTC.

Exemplo:

"2026-06-12T00:18:44.466537Z"

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