Saltar para o conteúdo principal
POST
curl
Quando substitui um passo com defer_until_flow_finishes: true enquanto a pessoa ainda está no fluxo, a substituição fica à espera e é aplicada quando o fluxo terminar. Cancele-a aqui se já não quiser que seja aplicada. A verificação mantém o estado atual. O cancelamento fica registado na atividade da sessão como FEATURE_OVERRIDE_CANCELLED, e não é enviado nenhum webhook. A resposta é a substituição com state: cancelled e cancel_reason: cancelled_by_reviewer.

Encontrar o ID da substituição

Use o id do objeto override devolvido por Atualizar estado da funcionalidade, ou liste as substituições da sessão com Listar substituições de funcionalidades e escolha uma cujo state seja pending_until_flow_finishes.

Quando o cancelamento falha

Uma substituição que já foi aplicada ou cancelada devolve 409 com o código feature_override_not_pending. Para alterar uma verificação depois de a substituição ter sido aplicada, envie em vez disso um novo pedido Atualizar estado da funcionalidade.

Relacionados

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"

overrideId
string<uuid>
obrigatório

O id da substituição a cancelar.

Exemplo:

"9b2f4c1e-8d3a-4e5f-a6b7-c8d9e0f1a2b3"

Resposta

A substituição foi cancelada e nunca será aplicada.

Uma sobreposição do estado de uma verificação (funcionalidade) efetuada com PATCH /v3/session/{sessionId}/features/{nodeId}/update-status/: o que altera, se foi aplicada ou se ainda aguarda que a pessoa conclua o fluxo, quem solicitou e porquê.

id
string<uuid>
obrigatório

Identificador da substituição. Transmita-o para o endpoint de cancelamento.

Exemplo:

"7c9e6679-7425-40de-944b-e07fc1f90ae7"

node_id
string
obrigatório

O nó do fluxo indicado pelo pedido (default para um passo sem nó).

Exemplo:

"feature_ocr_1"

feature_type
string
obrigatório

O feature_type transmitido pelo pedido, ou uma string vazia se nenhum tiver sido transmitido.

Exemplo:

""

feature_model
string
obrigatório

O tipo de verificação que foi substituído, por exemplo KYC, Face, AML ou GeolocationCheck.

Exemplo:

"KYC"

previous_status
enum<string>
obrigatório

O estado da verificação quando a substituição foi solicitada.

Opções disponíveis:
Not Finished,
Approved,
Declined,
In Review,
Resub Requested
Exemplo:

"In Review"

new_status
enum<string>
obrigatório

O estado definido pela sobreposição.

Opções disponíveis:
Approved,
Declined,
In Review
Exemplo:

"Approved"

state
enum<string>
obrigatório

applied: a verificação tem o novo estado. pending_until_flow_finishes: a substituição aguarda e é aplicada quando a pessoa terminar o fluxo. cancelled: aguardou e nunca foi aplicada (consulte cancel_reason).

Opções disponíveis:
applied,
pending_until_flow_finishes,
cancelled
Exemplo:

"applied"

forced
boolean
obrigatório

true quando a substituição foi aplicada de imediato enquanto a pessoa ainda estava no fluxo.

Exemplo:

false

reason
string | null
obrigatório

O comment enviado com o pedido, ou null.

Exemplo:

"Document manually verified by compliance."

requested_by
object | null
obrigatório

Quem solicitou a substituição, ou null quando não for conhecido.

requested_at
string<date-time>
obrigatório

Quando a substituição foi solicitada.

Exemplo:

"2026-10-13T09:15:00Z"

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

Quando a verificação assumiu o novo estado, ou null enquanto aguarda ou assim que for cancelada.

Exemplo:

"2026-10-13T09:15:00Z"

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

Quando uma substituição em espera foi cancelada, ou null.

Exemplo:

null

cancel_reason
enum<string> | null
obrigatório

O motivo pelo qual uma sobreposição pendente nunca foi aplicada, ou null. cancelled_by_reviewer: cancelada com o endpoint de cancelamento. replaced: uma sobreposição mais recente na mesma verificação substituiu-a. check_changed: a pessoa repetiu a verificação antes de concluir o fluxo. session_closed: a sessão saiu do fluxo antes de a pessoa o concluir (abandonada, expirada ou decidida a meio do fluxo).

Opções disponíveis:
cancelled_by_reviewer,
replaced,
check_changed,
session_closed,
null
Exemplo:

null

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