> ## 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 Override de Recurso na API: Descartar Pendente

> No Didit, cancele um override de status de etapa que ainda aguarda a pessoa concluir o fluxo; ele não é aplicado e a etapa mantém o status.



Prompt para cancelar substituição de recurso
        Copiar o prompt para a área de transferência



      
      

\<pre>

\`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/<SESSION_ID>/features/overrides/<OVERRIDE_ID>/cancel/ \
-H "x-api-key: <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.`

\</pre>



      
      

Colar em

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çãoUse o `id` do objeto `override` retornado por [Update Feature Status](https://docs.didit.me/pt-br/sessions-api/update-feature-status.md), ou liste as substituições da sessão com [List Feature Overrides](https://docs.didit.me/pt-br/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 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](https://docs.didit.me/pt-br/sessions-api/update-feature-status.md).## Relacionados- [Update Feature Status](https://docs.didit.me/pt-br/sessions-api/update-feature-status.md): substitui o status de uma etapa, imediatamente ou quando o fluxo terminar.
- [List Feature Overrides](https://docs.didit.me/pt-br/sessions-api/list-feature-overrides.md): todas as substituições de uma sessão e o estado de cada uma.


## OpenAPI

````yaml pt-br/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 substituição de verificação que aguarda o fim do fluxo
      description: >-
        Cancela uma substituição do status de um recurso (etapa) que ainda está
        como `pending_until_flow_finishes`, para que ela nunca seja aplicada. A
        verificação mantém seu status, 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`.


        Uma substituição que já foi aplicada ou cancelada retorna `409` com o
        código `feature_override_not_pending`. Encontre os IDs de substituição
        com `GET /v3/session/{sessionId}/features/overrides/` ou no `override`
        retornado pela atualização de status do recurso.


        Requer o privilégio `write:sessions`; uma chave de API com escopo
        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 tanto de usuário
            (KYC) quanto 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 ser cancelada.
          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 escopo expirou.
          content:
            application/json:
              examples:
                Expired API Key:
                  summary: Chave de API com escopo após a data de validade
                  value:
                    detail: This API key has expired.
        '403':
          description: >-
            Credenciais ausentes, um chamador sem o privilégio `write:sessions`,
            uma chave de API com escopo sem o acesso de que este endpoint
            precisa, ou um `session_id` que pertence a outra aplicação.
          content:
            application/json:
              examples:
                Invalid Credentials:
                  summary: x-api-key ausente ou inválido
                  value:
                    detail: >-
                      Authentication credentials were not provided or are
                      invalid.
                Missing Privilege:
                  summary: O chamador 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 escopo 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 nenhuma substituição com este `overrideId`.
          content:
            application/json:
              examples:
                Not Found:
                  summary: session_id desconhecido
                  value:
                    detail: Not found.
                Override Not Found:
                  summary: Nenhuma substituição 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: Somente 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: >-
            <?php


            require 'vendor/autoload.php';


            use Didit\DiditClient;


            // Reads DIDIT_API_KEY.

            $didit = new DiditClient();


            $result =
            $didit->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 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ê.
      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. Passe-o para o endpoint de
            cancelamento.
          example: 7c9e6679-7425-40de-944b-e07fc1f90ae7
        node_id:
          type: string
          description: >-
            O nó do fluxo indicado na requisição (`default` para uma etapa sem
            nó).
          example: feature_ocr_1
        feature_type:
          type: string
          description: >-
            O `feature_type` informado na requisição, ou uma string vazia quando
            nenhum foi informado.
          example: ''
        feature_model:
          type: string
          description: >-
            O tipo de verificação que foi sobrescrita, por exemplo `KYC`,
            `Face`, `AML` ou `GeolocationCheck`.
          example: KYC
        previous_status:
          type: string
          enum:
            - Not Finished
            - Approved
            - Declined
            - In Review
            - Resub Requested
          description: O status da verificação quando a substituição foi solicitada.
          example: In Review
        new_status:
          type: string
          enum:
            - Approved
            - Declined
            - In Review
          description: O status que a substituição define.
          example: Approved
        state:
          type: string
          enum:
            - applied
            - pending_until_flow_finishes
            - cancelled
          description: >-
            `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`).
          example: applied
        forced:
          type: boolean
          description: >-
            `true` quando a substituição foi aplicada imediatamente, enquanto a
            pessoa ainda estava no fluxo.
          example: false
        reason:
          type: string
          nullable: true
          description: O `comment` enviado com a requisição, ou `null`.
          example: Document manually verified by compliance.
        requested_by:
          type: object
          nullable: true
          description: >-
            Quem solicitou a substituição, ou `null` quando isso não é
            conhecido.
          properties:
            email:
              type: string
              format: email
              nullable: true
              description: >-
                E-mail do usuário do console, ou `null` para chaves de API e
                para o sistema.
              example: reviewer@example.com
            name:
              type: string
              nullable: true
              description: Nome de exibição do solicitante, ou `null`.
              example: Alex Reviewer
            type:
              type: string
              enum:
                - CONSOLE_USER
                - API_KEY
                - SYSTEM
              description: >-
                Quem fez a requisição: um usuário do console, 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 status, ou `null` enquanto ela
            aguarda ou depois de cancelada.
          example: '2026-10-13T09:15:00Z'
        cancelled_at:
          type: string
          format: date-time
          nullable: true
          description: Quando uma substituição pendente foi cancelada, ou `null`.
          example: null
        cancel_reason:
          type: string
          nullable: true
          enum:
            - cancelled_by_reviewer
            - replaced
            - check_changed
            - session_closed
            - null
          description: >-
            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).
          example: null
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        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.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.