> ## Documentation Index > Fetch the complete documentation index at: https://docs.didit.me/llms.txt > Use this file to discover all available pages before exploring further. # Cancelar Substituição de Funcionalidade na API > Cancele uma substituição de estado pendente no Didit antes de a pessoa concluir o fluxo; o passo mantém o seu estado atual. Prompt para cancelar substituição de funcionalidade Copiar o prompt para a área de transferência \

\`Cancel a check (feature) status override on a Didit session that still waits for the person to finish the flow, so it never applies.

Endpoint:
POST https://verification.didit.me/v3/session/{session_id}/features/overrides/{override_id}/cancel/

Authentication:
x-api-key (client API key) or a user-auth token. Privilege: write:sessions. A scoped API key needs write access to decisions.

Path parameters:
\- session_id (UUID): KYC or KYB; Didit resolves it against both session types.
\- override_id (UUID): the id of the override, from the "override" object returned by PATCH /v3/session/{session_id}/features/{node_id}/update-status/ or from GET /v3/session/{session_id}/features/overrides/.

Request body: none.

Only an override whose state is "pending_until_flow_finishes" can be cancelled.

Response (200): the override, with state "cancelled", cancelled_at set and cancel_reason "cancelled_by_reviewer".

Side effects:
\- The check keeps its current status.
\- The cancellation is recorded in the session's activity as FEATURE_OVERRIDE_CANCELLED.
\- No webhook is sent.

curl example:
curl -X POST https://verification.didit.me/v3/session//features/overrides//cancel/ \
-H "x-api-key: "

Failure modes:
\- 401: the scoped API key has expired.
\- 403: missing credentials (a wrong, revoked or expired key gets 401), the caller lacks write:sessions, a scoped key lacks decisions write, or the session belongs to another application ({ "detail": "You do not have permission to perform this action." }).
\- 404: { "detail": "Not found." } when no session with this session_id exists, or { "detail": "Override not found." } when the session has no override with this override_id.
\- 409: { "detail": "This override is no longer pending: it already applied or was cancelled.", "code": "feature_override_not_pending" }.

For end-to-end Didit integration, paste in the full prompt at /integration/integration-prompt.`

\
Colar em 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çãoUse o `id` do objeto `override` devolvido por [Atualizar estado da funcionalidade](https://docs.didit.me/pt/sessions-api/update-feature-status.md), ou liste as substituições da sessão com [Listar substituições de funcionalidades](https://docs.didit.me/pt/sessions-api/list-feature-overrides.md) e escolha uma cujo `state` seja `pending_until_flow_finishes`.## Quando o cancelamento falhaUma 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](https://docs.didit.me/pt/sessions-api/update-feature-status.md).## Relacionados- [Atualizar estado da funcionalidade](https://docs.didit.me/pt/sessions-api/update-feature-status.md): substitua o estado de um passo, agora ou quando o fluxo terminar. - [Listar substituições de funcionalidades](https://docs.didit.me/pt/sessions-api/list-feature-overrides.md): todas as substituições de uma sessão e o respetivo estado. ## OpenAPI ````yaml pt/openapi-25.json POST /v3/session/{sessionId}/features/overrides/{overrideId}/cancel/ openapi: 3.0.0 info: version: 3.0.0 title: Didit Verification API description: API de Verificação de identidade. Autentique-se com o cabeçalho x-api-key. servers: - url: https://verification.didit.me security: [] tags: [] paths: /v3/session/{sessionId}/features/overrides/{overrideId}/cancel/: post: tags: - Sessions summary: Cancelar uma sobreposição de verificação que aguarda que o fluxo termine description: >- Cancela uma sobreposição do estado de uma funcionalidade (passo) que ainda esteja `pending_until_flow_finishes`, para que nunca seja aplicada. A verificação mantém o respetivo estado, o cancelamento é registado na atividade da sessão como `FEATURE_OVERRIDE_CANCELLED` e nenhum webhook é enviado. A resposta é a sobreposição com `state: cancelled` e `cancel_reason: cancelled_by_reviewer`. Uma sobreposição que já tenha sido aplicada ou cancelada devolve `409` com o código `feature_override_not_pending`. Encontre os IDs das sobreposições com `GET /v3/session/{sessionId}/features/overrides/` ou no objeto `override` devolvido pela atualização de estado da funcionalidade. Requer o privilégio `write:sessions`; uma chave de API com âmbito restrito precisa de acesso de escrita a decisões. operationId: post_v3_session_feature_override_cancel parameters: - in: path name: sessionId required: true description: >- UUID da sessão de verificação. Aceita IDs de sessão de utilizador (KYC) e de empresa (KYB). schema: type: string format: uuid example: 3fa85f64-5717-4562-b3fc-2c963f66afa6 - in: path name: overrideId required: true description: O `id` da substituição a cancelar. schema: type: string format: uuid example: 9b2f4c1e-8d3a-4e5f-a6b7-c8d9e0f1a2b3 responses: '200': description: A substituição foi cancelada e nunca será aplicada. content: application/json: schema: $ref: '#/components/schemas/FeatureStatusOverride' examples: Cancelled: summary: A substituição cancelada value: id: 9b2f4c1e-8d3a-4e5f-a6b7-c8d9e0f1a2b3 node_id: feature_liveness_1 feature_type: '' feature_model: Face previous_status: Declined new_status: Approved state: cancelled forced: false reason: Liveness retried with a reviewer present. requested_by: email: reviewer@example.com name: Alex Reviewer type: CONSOLE_USER requested_at: '2026-10-13T09:15:00Z' applied_at: null cancelled_at: '2026-10-13T09:20:00Z' cancel_reason: cancelled_by_reviewer '401': description: A chave de API com âmbito expirou. content: application/json: examples: Expired API Key: summary: Chave de API com âmbito cuja data de validade já passou value: detail: This API key has expired. '403': description: >- Credenciais em falta, um chamador sem o privilégio `write:sessions`, uma chave de API com âmbito sem o acesso de que este endpoint necessita, ou um `session_id` que pertence a outra aplicação. content: application/json: examples: Invalid Credentials: summary: x-api-key em falta ou inválido value: detail: >- Authentication credentials were not provided or are invalid. Missing Privilege: summary: O autor da chamada não tem write:sessions value: detail: You do not have permission to perform this action. Scoped Key Without Access: summary: Chave de API com âmbito sem este acesso value: detail: This API key has no write access to decisions. '404': description: >- Não existe nenhuma sessão de KYC ou KYB com este `session_id`, ou a sessão não tem nenhum override com este `overrideId`. content: application/json: examples: Not Found: summary: session_id desconhecido value: detail: Not found. Override Not Found: summary: Nenhum override com este id na sessão value: detail: Override not found. '409': description: A substituição já foi aplicada ou foi cancelada. content: application/json: examples: Not Pending: summary: Apenas uma substituição em espera pode ser cancelada value: detail: >- This override is no longer pending: it already applied or was cancelled. code: feature_override_not_pending security: - ApiKeyAuth: [] x-codeSamples: - lang: curl label: curl source: |- curl -X POST \ https://verification.didit.me/v3/session/3fa85f64-5717-4562-b3fc-2c963f66afa6/features/overrides/9b2f4c1e-8d3a-4e5f-a6b7-c8d9e0f1a2b3/cancel/ \ -H 'x-api-key: YOUR_API_KEY' - lang: python label: Python source: |- from didit import Didit # Reads DIDIT_API_KEY. client = Didit() result = client.sessions.cancel_feature_override( "3fa85f64-5717-4562-b3fc-2c963f66afa6", "9b2f4c1e-8d3a-4e5f-a6b7-c8d9e0f1a2b3", ) print(result) - lang: javascript label: Node.js source: |- import Didit from "@didit-protocol/sdk-node"; // Reads DIDIT_API_KEY. const didit = new Didit(); const result = await didit.sessions.cancelFeatureOverride( "3fa85f64-5717-4562-b3fc-2c963f66afa6", "9b2f4c1e-8d3a-4e5f-a6b7-c8d9e0f1a2b3", ); console.log(result); - lang: go label: Go source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Sessions.CancelFeatureOverride(ctx, \"3fa85f64-5717-4562-b3fc-2c963f66afa6\", \"9b2f4c1e-8d3a-4e5f-a6b7-c8d9e0f1a2b3\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" - lang: java label: Java source: >- import me.didit.Didit; // Reads DIDIT_API_KEY. Didit client = new Didit(); var result = client.sessions().cancelFeatureOverride("3fa85f64-5717-4562-b3fc-2c963f66afa6", "9b2f4c1e-8d3a-4e5f-a6b7-c8d9e0f1a2b3"); System.out.println(result); - lang: php label: PHP source: >- sessions->cancelFeatureOverride('3fa85f64-5717-4562-b3fc-2c963f66afa6', '9b2f4c1e-8d3a-4e5f-a6b7-c8d9e0f1a2b3'); print_r($result->toArray()); - lang: ruby label: Ruby source: |- require "didit" # Reads DIDIT_API_KEY. didit = Didit::Client.new result = didit.sessions.cancel_feature_override( "3fa85f64-5717-4562-b3fc-2c963f66afa6", "9b2f4c1e-8d3a-4e5f-a6b7-c8d9e0f1a2b3" ) puts result.to_h - lang: csharp label: .NET source: >- using System; using System.Text.Json; using Didit; // Reads DIDIT_API_KEY. using var client = new DiditClient(); var result = await client.Sessions.CancelFeatureOverrideAsync("3fa85f64-5717-4562-b3fc-2c963f66afa6", "9b2f4c1e-8d3a-4e5f-a6b7-c8d9e0f1a2b3"); Console.WriteLine(JsonSerializer.Serialize(result)); components: schemas: FeatureStatusOverride: type: object description: >- 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ê. required: - id - node_id - feature_type - feature_model - previous_status - new_status - state - forced - reason - requested_by - requested_at - applied_at - cancelled_at - cancel_reason properties: id: type: string format: uuid description: >- Identificador da substituição. Transmita-o para o endpoint de cancelamento. example: 7c9e6679-7425-40de-944b-e07fc1f90ae7 node_id: type: string description: O nó do fluxo indicado pelo pedido (`default` para um passo sem nó). example: feature_ocr_1 feature_type: type: string description: >- O `feature_type` transmitido pelo pedido, ou uma string vazia se nenhum tiver sido transmitido. example: '' feature_model: type: string description: >- O tipo de verificação que foi substituído, por exemplo `KYC`, `Face`, `AML` ou `GeolocationCheck`. example: KYC previous_status: type: string enum: - Not Finished - Approved - Declined - In Review - Resub Requested description: O estado da verificação quando a substituição foi solicitada. example: In Review new_status: type: string enum: - Approved - Declined - In Review description: O estado definido pela sobreposição. example: Approved state: type: string enum: - applied - pending_until_flow_finishes - cancelled description: >- `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`). example: applied forced: type: boolean description: >- `true` quando a substituição foi aplicada de imediato enquanto a pessoa ainda estava no fluxo. example: false reason: type: string nullable: true description: O `comment` enviado com o pedido, ou `null`. example: Document manually verified by compliance. requested_by: type: object nullable: true description: Quem solicitou a substituição, ou `null` quando não for conhecido. properties: email: type: string format: email nullable: true description: >- E-mail do utilizador da consola, ou `null` para chaves de API e para o sistema. example: reviewer@example.com name: type: string nullable: true description: Nome de apresentação do requerente, ou `null`. example: Alex Reviewer type: type: string enum: - CONSOLE_USER - API_KEY - SYSTEM description: >- Quem fez o pedido: um utilizador da consola, uma chave de API ou a própria Didit. example: CONSOLE_USER requested_at: type: string format: date-time description: Quando a substituição foi solicitada. example: '2026-10-13T09:15:00Z' applied_at: type: string format: date-time nullable: true description: >- Quando a verificação assumiu o novo estado, ou `null` enquanto aguarda ou assim que for cancelada. example: '2026-10-13T09:15:00Z' cancelled_at: type: string format: date-time nullable: true description: Quando uma substituição em espera foi cancelada, ou `null`. example: null cancel_reason: type: string nullable: true enum: - cancelled_by_reviewer - replaced - check_changed - session_closed - null description: >- 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). example: null securitySchemes: ApiKeyAuth: type: apiKey in: header name: x-api-key description: >- 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. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.