Pular para o conteúdo principal
POST
curl
Quando você substitui uma etapa com defer_until_flow_finishes: true enquanto a pessoa ainda está no fluxo, a substituição aguarda e é aplicada quando o fluxo termina. Cancele-a aqui se não quiser mais que ela seja aplicada. A verificação mantém o status atual. O cancelamento é registrado na atividade da sessão como FEATURE_OVERRIDE_CANCELLED, e nenhum webhook é enviado. 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 retornado por Update Feature Status, ou liste as substituições da sessão com List Feature Overrides e escolha uma cujo state seja pending_until_flow_finishes.

Quando o cancelamento falha

Uma substituição que já foi aplicada ou cancelada retorna 409 com o código feature_override_not_pending. Para alterar uma verificação depois que a substituição dela foi aplicada, envie uma nova requisição de Update Feature Status.

Relacionados

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 de verificação. Aceita IDs de sessão tanto de usuário (KYC) quanto de empresa (KYB).

Exemplo:

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

overrideId
string<uuid>
obrigatório

O id da substituição a ser cancelada.

Exemplo:

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

Resposta

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

Uma substituição do status de uma verificação (recurso) feita com PATCH /v3/session/{sessionId}/features/{nodeId}/update-status/: o que ela altera, se foi aplicada ou ainda aguarda a pessoa concluir o fluxo, quem a solicitou e por quê.

id
string<uuid>
obrigatório

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

Exemplo:

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

node_id
string
obrigatório

O nó do fluxo indicado na requisição (default para uma etapa sem nó).

Exemplo:

"feature_ocr_1"

feature_type
string
obrigatório

O feature_type informado na requisição, ou uma string vazia quando nenhum foi informado.

Exemplo:

""

feature_model
string
obrigatório

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

Exemplo:

"KYC"

previous_status
enum<string>
obrigatório

O status 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 status que a substituição define.

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

"Approved"

state
enum<string>
obrigatório

applied: a verificação está com o novo status. pending_until_flow_finishes: a substituição aguarda e é aplicada quando a pessoa conclui o fluxo. cancelled: ela aguardou e nunca foi aplicada (veja 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 imediatamente, enquanto a pessoa ainda estava no fluxo.

Exemplo:

false

reason
string | null
obrigatório

O comment enviado com a requisição, ou null.

Exemplo:

"Document manually verified by compliance."

requested_by
object | null
obrigatório

Quem solicitou a substituição, ou null quando isso não é 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 status, ou null enquanto ela aguarda ou depois de cancelada.

Exemplo:

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

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

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

Exemplo:

null

cancel_reason
enum<string> | null
obrigatório

Por que uma substituição em espera nunca foi aplicada, ou null. cancelled_by_reviewer: cancelada com o endpoint de cancelamento. replaced: uma substituição mais recente na mesma verificação a substituiu. check_changed: a pessoa refez a verificação antes de concluir o fluxo. session_closed: a sessão saiu do fluxo antes de a pessoa concluí-lo (abandonada, expirada ou decidida no meio do fluxo).

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

null

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