Saltar al contingut principal
POST
curl
Quan fas una substitució d’un pas amb defer_until_flow_finishes: true mentre la persona encara és al flux de treball, la substitució queda en espera i s’aplica quan acaba el flux de treball. Cancel·la-la aquí si ja no vols que s’apliqui. La comprovació manté el seu estat actual. La cancel·lació queda registrada a l’activitat de la sessió com a FEATURE_OVERRIDE_CANCELLED, i no s’envia cap webhook. La resposta és la substitució amb state: cancelled i cancel_reason: cancelled_by_reviewer.

Troba l’ID de la substitució

Usa el id de l’objecte override que retorna Update Feature Status, o llista les substitucions de la sessió amb List Feature Overrides i tria’n una amb state pending_until_flow_finishes.

Quan la cancel·lació falla

Una substitució que ja s’ha aplicat o cancel·lat retorna 409 amb el codi feature_override_not_pending. Per canviar una comprovació després que la seva substitució s’hagi aplicat, envia en canvi una nova sol·licitud Update Feature Status.

Relacionats

Autoritzacions

x-api-key
string
header
requerit

La clau d'API de la teva aplicació, des de Developers -> API keys a la Business Console. La clau primària té accés complet. Una clau amb nom pot tenir l'abast limitat: cap, lectura o escriptura per recurs, limitada a determinats fluxos de treball o a sessions aprovades, a una llista d'adreces IP i a una data de caducitat. 401 significa que la clau és incorrecta, revocada o caducada; 403 significa que no s'ha enviat cap clau, que la clau no té accés a aquest recurs o acció, o que la sol·licitud prové d'una adreça fora de la seva llista d'IP; 404 en una ruta de sessió significa que la sessió està fora dels fluxos de treball o estats de la clau. Una clau sense accés a fitxers multimèdia rep els URL d'imatge, vídeo i PDF com a null, i una clau sense permís d'escriptura de sessions rep els enllaços de sessió i els tokens com a null. Consulta https://docs.didit.me/console/api-keys.

Paràmetres de ruta

sessionId
string<uuid>
requerit

UUID de la sessió de verificació. Accepta tant IDs de sessió d'usuari (KYC) com d'empresa (KYB).

Exemple:

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

overrideId
string<uuid>
requerit

L'id de l'override que es vol cancel·lar.

Exemple:

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

Resposta

La substitució s'ha cancel·lat i no s'aplicarà mai.

Una sobreescriptura de l'estat d'una comprovació (funcionalitat) feta amb PATCH /v3/session/{sessionId}/features/{nodeId}/update-status/: què canvia, si s'ha aplicat o encara espera que la persona finalitzi el flux, qui ho ha sol·licitat i per què.

id
string<uuid>
requerit

Identificador de la sobreescriptura. Transmet-lo a l'endpoint de cancel·lació.

Exemple:

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

node_id
string
requerit

El node del flux de treball indicat a la sol·licitud (default per a un pas sense node).

Exemple:

"feature_ocr_1"

feature_type
string
requerit

El feature_type que ha passat la sol·licitud, o una cadena buida si no n'ha passat cap.

Exemple:

""

feature_model
string
requerit

El tipus de comprovació que s'ha anul·lat, per exemple KYC, Face, AML o GeolocationCheck.

Exemple:

"KYC"

previous_status
enum<string>
requerit

L'estat de la comprovació quan es va sol·licitar la sobreescriptura.

Opcions disponibles:
Not Finished,
Approved,
Declined,
In Review,
Resub Requested
Exemple:

"In Review"

new_status
enum<string>
requerit

L'estat que estableix l'anul·lació.

Opcions disponibles:
Approved,
Declined,
In Review
Exemple:

"Approved"

state
enum<string>
requerit

applied: la comprovació té el nou estat. pending_until_flow_finishes: la sobreescriptura espera i s'aplica quan la persona finalitza el flux. cancelled: ha esperat i no s'ha arribat a aplicar mai (consulta cancel_reason).

Opcions disponibles:
applied,
pending_until_flow_finishes,
cancelled
Exemple:

"applied"

forced
boolean
requerit

true quan la sobreescriptura s'ha aplicat immediatament mentre la persona encara era al flux.

Exemple:

false

reason
string | null
requerit

El comment enviat amb la sol·licitud, o null.

Exemple:

"Document manually verified by compliance."

requested_by
object | null
requerit

Qui ha sol·licitat la substitució, o null si no se sap.

requested_at
string<date-time>
requerit

Quan es va sol·licitar la sobreescriptura.

Exemple:

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

applied_at
string<date-time> | null
requerit

Quan la comprovació va adoptar el nou estat, o null mentre està en espera o un cop cancel·lada.

Exemple:

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

cancelled_at
string<date-time> | null
requerit

Quan es va cancel·lar una substitució en espera, o null.

Exemple:

null

cancel_reason
enum<string> | null
requerit

Per què no es va aplicar mai una substitució en espera, o null. cancelled_by_reviewer: cancel·lada amb l'endpoint de cancel·lació. replaced: una substitució més recent en la mateixa comprovació la va substituir. check_changed: la persona ha tornat a fer la comprovació abans d'acabar el flux. session_closed: la sessió ha sortit del flux abans que la persona l'acabés (abandonada, caducada o decidida a mig flux).

Opcions disponibles:
cancelled_by_reviewer,
replaced,
check_changed,
session_closed,
null
Exemple:

null

Darrera modificació el 7 de novembre del 2026