> ## 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.

# 取消功能覆盖 API：撤销待生效的步骤覆盖

> 取消仍在等待用户完成流程的步骤状态覆盖，使其不再生效，步骤保持原有状态。Didit 支持此操作。



取消功能覆盖提示
        将提示词复制到剪贴板



      
      

\<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>



      
      

粘贴到

当你在用户仍处于流程中时，使用 `defer_until_flow_finishes: true` 覆盖某个步骤，该覆盖会等待，并在流程结束后生效。如果你不再希望它生效，请在此处取消。检查保持当前状态。
取消操作会以 `FEATURE_OVERRIDE_CANCELLED` 记录在会话活动中，且不会发送 Webhook。
响应为该覆盖，其中 `state: cancelled`，`cancel_reason: cancelled_by_reviewer`。## 查找覆盖 ID使用 [更新功能状态](https://docs.didit.me/zh/sessions-api/update-feature-status.md) 返回的 `override` 对象中的 `id`，或使用 [列出功能覆盖](https://docs.didit.me/zh/sessions-api/list-feature-overrides.md) 列出会话的覆盖，然后选择 `state` 为 `pending_until_flow_finishes` 的那一项。## 取消失败时已生效或已取消的覆盖会返回 `409`，错误代码为 `feature_override_not_pending`。如需在覆盖生效后修改检查，请改为发送新的 [更新功能状态](https://docs.didit.me/zh/sessions-api/update-feature-status.md) 请求。## 相关内容- [更新功能状态](https://docs.didit.me/zh/sessions-api/update-feature-status.md)：覆盖某个步骤的状态，可立即生效，也可在流程结束后生效。
- [列出功能覆盖](https://docs.didit.me/zh/sessions-api/list-feature-overrides.md)：会话的每个覆盖及其状态。


## OpenAPI

````yaml zh/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。使用 x-api-key 请求头进行身份验证。
servers:
  - url: https://verification.didit.me
security: []
tags: []
paths:
  /v3/session/{sessionId}/features/overrides/{overrideId}/cancel/:
    post:
      tags:
        - Sessions
      summary: 取消等待流程完成的检查覆盖
      description: >-
        取消仍处于 `pending_until_flow_finishes`
        状态的功能（步骤）状态覆盖，使其永不生效。该检查保持其原有状态，取消操作会在会话活动中记录为
        `FEATURE_OVERRIDE_CANCELLED`，且不会发送 Webhook。响应为带有 `state: cancelled` 和
        `cancel_reason: cancelled_by_reviewer` 的覆盖对象。


        已生效或已被取消的覆盖将返回 `409` 及错误代码 `feature_override_not_pending`。可通过 `GET
        /v3/session/{sessionId}/features/overrides/` 或功能状态更新返回的 `override` 中查找覆盖
        ID。


        需要 `write:sessions` 权限；受范围限制的 API 密钥需要对 decisions 具有写入权限。
      operationId: post_v3_session_feature_override_cancel
      parameters:
        - in: path
          name: sessionId
          required: true
          description: 验证会话的 UUID。支持用户（KYC）和企业（KYB）会话 ID。
          schema:
            type: string
            format: uuid
            example: 3fa85f64-5717-4562-b3fc-2c963f66afa6
        - in: path
          name: overrideId
          required: true
          description: 要取消的覆盖项 `id`。
          schema:
            type: string
            format: uuid
            example: 9b2f4c1e-8d3a-4e5f-a6b7-c8d9e0f1a2b3
      responses:
        '200':
          description: 覆盖已取消，且永不生效。
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FeatureStatusOverride'
              examples:
                Cancelled:
                  summary: 已取消的覆盖
                  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: 作用域 API 密钥已过期。
          content:
            application/json:
              examples:
                Expired API Key:
                  summary: 已过有效期的作用域 API 密钥
                  value:
                    detail: This API key has expired.
        '403':
          description: >-
            缺少凭据、调用方没有 `write:sessions` 权限、限定范围的 API 密钥缺少此 endpoint 所需的访问权限，或者
            `session_id` 属于另一个应用。
          content:
            application/json:
              examples:
                Invalid Credentials:
                  summary: x-api-key 缺失或无效
                  value:
                    detail: >-
                      Authentication credentials were not provided or are
                      invalid.
                Missing Privilege:
                  summary: 调用方缺少 write:sessions 权限
                  value:
                    detail: You do not have permission to perform this action.
                Scoped Key Without Access:
                  summary: 没有此访问权限的作用域 API 密钥
                  value:
                    detail: This API key has no write access to decisions.
        '404':
          description: 不存在具有此 `session_id` 的 KYC 或 KYB 会话，或者该会话不存在具有此 `overrideId` 的覆盖配置。
          content:
            application/json:
              examples:
                Not Found:
                  summary: 未知的 session_id
                  value:
                    detail: Not found.
                Override Not Found:
                  summary: 该会话中不存在具有此 id 的覆盖项
                  value:
                    detail: Override not found.
        '409':
          description: 覆盖已应用或已被取消。
          content:
            application/json:
              examples:
                Not Pending:
                  summary: 只有等待中的覆盖才能被取消
                  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: >-
        通过 `PATCH /v3/session/{sessionId}/features/{nodeId}/update-status/`
        对某项检查（功能）状态进行的一次覆盖：它更改了什么、是否已应用或仍在等待用户完成流程、发起者以及原因。
      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: 覆盖项的标识符。将其传递给取消 endpoint。
          example: 7c9e6679-7425-40de-944b-e07fc1f90ae7
        node_id:
          type: string
          description: 请求指定的工作流节点（对于没有节点的步骤为 `default`）。
          example: feature_ocr_1
        feature_type:
          type: string
          description: 请求传递的 `feature_type`；若未传递，则为空字符串。
          example: ''
        feature_model:
          type: string
          description: 被覆盖的核验类型，例如 `KYC`、`Face`、`AML` 或 `GeolocationCheck`。
          example: KYC
        previous_status:
          type: string
          enum:
            - Not Finished
            - Approved
            - Declined
            - In Review
            - Resub Requested
          description: 请求覆盖时该检查的状态。
          example: In Review
        new_status:
          type: string
          enum:
            - Approved
            - Declined
            - In Review
          description: 覆盖所设置的状态。
          example: Approved
        state:
          type: string
          enum:
            - applied
            - pending_until_flow_finishes
            - cancelled
          description: >-
            `applied`：检查已获得新状态。`pending_until_flow_finishes`：覆盖设置处于等待状态，并在该人员完成流程时应用。`cancelled`：已等待且从未应用（参见
            `cancel_reason`）。
          example: applied
        forced:
          type: boolean
          description: 当该人员仍在流程中且覆写立即生效时为 `true`。
          example: false
        reason:
          type: string
          nullable: true
          description: 随请求发送的 `comment`，或为 `null`。
          example: Document manually verified by compliance.
        requested_by:
          type: object
          nullable: true
          description: 请求覆盖的人员；若未知则为 `null`。
          properties:
            email:
              type: string
              format: email
              nullable: true
              description: Console 用户的邮箱，对于 API 密钥和系统则为 `null`。
              example: reviewer@example.com
            name:
              type: string
              nullable: true
              description: 请求者的显示名称，或 `null`。
              example: Alex Reviewer
            type:
              type: string
              enum:
                - CONSOLE_USER
                - API_KEY
                - SYSTEM
              description: 发起请求的主体：控制台用户、API 密钥或 Didit 本身。
              example: CONSOLE_USER
        requested_at:
          type: string
          format: date-time
          description: 请求覆盖的时间。
          example: '2026-10-13T09:15:00Z'
        applied_at:
          type: string
          format: date-time
          nullable: true
          description: 检查变为新状态的时间，等待中或一旦取消则为 `null`。
          example: '2026-10-13T09:15:00Z'
        cancelled_at:
          type: string
          format: date-time
          nullable: true
          description: 等待中的覆盖被取消的时间，或为 `null`。
          example: null
        cancel_reason:
          type: string
          nullable: true
          enum:
            - cancelled_by_reviewer
            - replaced
            - check_changed
            - session_closed
            - null
          description: >-
            处于等待状态的覆盖为何从未生效，或为 `null`。`cancelled_by_reviewer`：已通过取消 endpoint
            取消。`replaced`：同一项检查上更新的覆盖替换了它。`check_changed`：用户在完成流程之前重新进行了检查。`session_closed`：会话在用户完成之前离开了流程（已放弃、已过期或在流程中做出决策）。
          example: null
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        您的应用 API 密钥，可在 Business Console 的“开发者 -> API
        密钥”中获取。主密钥拥有完整访问权限。指定名称的密钥可设置作用域：针对每个资源设为无权限、只读或读写，限定于特定工作流或已通过的会话、限定于
        IP 地址列表，以及设置到期日期。401 表示密钥错误、已撤销或已过期；403 表示未发送密钥、密钥无权访问该资源或操作，或请求来自其 IP
        列表之外的地址；在会话路由上返回 404 表示该会话不在该密钥允许的工作流或状态范围内。没有媒体访问权限的密钥获取到的图片、视频和 PDF
        URL 将为 null；没有会话写入权限的密钥获取到的会话链接和 token 将为 null。请参阅
        https://docs.didit.me/console/api-keys。

````

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