跳转到主要内容
POST
curl
当你在用户仍处于流程中时,使用 defer_until_flow_finishes: true 覆盖某个步骤,该覆盖会等待,并在流程结束后生效。如果你不再希望它生效,请在此处取消。 检查保持当前状态。 取消操作会以 FEATURE_OVERRIDE_CANCELLED 记录在会话活动中,且不会发送 Webhook。 响应为该覆盖,其中 state: cancelled,cancel_reason: cancelled_by_reviewer。

查找覆盖 ID

使用 更新功能状态 返回的 override 对象中的 id,或使用 列出功能覆盖 列出会话的覆盖,然后选择 state 为 pending_until_flow_finishes 的那一项。

取消失败时

已生效或已取消的覆盖会返回 409,错误代码为 feature_override_not_pending。如需在覆盖生效后修改检查,请改为发送新的 更新功能状态 请求。

相关内容

授权

x-api-key
string
header
必填

您的应用 API 密钥,可在 Business Console 的“开发者 -> API 密钥”中获取。主密钥拥有完整访问权限。指定名称的密钥可设置作用域:针对每个资源设为无权限、只读或读写,限定于特定工作流或已通过的会话、限定于 IP 地址列表,以及设置到期日期。401 表示密钥错误、已撤销或已过期;403 表示未发送密钥、密钥无权访问该资源或操作,或请求来自其 IP 列表之外的地址;在会话路由上返回 404 表示该会话不在该密钥允许的工作流或状态范围内。没有媒体访问权限的密钥获取到的图片、视频和 PDF URL 将为 null;没有会话写入权限的密钥获取到的会话链接和 token 将为 null。请参阅 https://docs.didit.me/console/api-keys。

路径参数

sessionId
string<uuid>
必填

验证会话的 UUID。支持用户(KYC)和企业(KYB)会话 ID。

示例:

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

overrideId
string<uuid>
必填

要取消的覆盖项 id。

示例:

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

响应

覆盖已取消,且永不生效。

通过 PATCH /v3/session/{sessionId}/features/{nodeId}/update-status/ 对某项检查(功能)状态进行的一次覆盖:它更改了什么、是否已应用或仍在等待用户完成流程、发起者以及原因。

id
string<uuid>
必填

覆盖项的标识符。将其传递给取消 endpoint。

示例:

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

node_id
string
必填

请求指定的工作流节点(对于没有节点的步骤为 default)。

示例:

"feature_ocr_1"

feature_type
string
必填

请求传递的 feature_type;若未传递,则为空字符串。

示例:

""

feature_model
string
必填

被覆盖的核验类型,例如 KYC、Face、AML 或 GeolocationCheck。

示例:

"KYC"

previous_status
enum<string>
必填

请求覆盖时该检查的状态。

可用选项:
Not Finished,
Approved,
Declined,
In Review,
Resub Requested
示例:

"In Review"

new_status
enum<string>
必填

覆盖所设置的状态。

可用选项:
Approved,
Declined,
In Review
示例:

"Approved"

state
enum<string>
必填

applied:检查已获得新状态。pending_until_flow_finishes:覆盖设置处于等待状态,并在该人员完成流程时应用。cancelled:已等待且从未应用(参见 cancel_reason)。

可用选项:
applied,
pending_until_flow_finishes,
cancelled
示例:

"applied"

forced
boolean
必填

当该人员仍在流程中且覆写立即生效时为 true。

示例:

false

reason
string | null
必填

随请求发送的 comment,或为 null。

示例:

"Document manually verified by compliance."

requested_by
object | null
必填

请求覆盖的人员;若未知则为 null。

requested_at
string<date-time>
必填

请求覆盖的时间。

示例:

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

applied_at
string<date-time> | null
必填

检查变为新状态的时间,等待中或一旦取消则为 null。

示例:

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

cancelled_at
string<date-time> | null
必填

等待中的覆盖被取消的时间,或为 null。

示例:

null

cancel_reason
enum<string> | null
必填

处于等待状态的覆盖为何从未生效,或为 null。cancelled_by_reviewer:已通过取消 endpoint 取消。replaced:同一项检查上更新的覆盖替换了它。check_changed:用户在完成流程之前重新进行了检查。session_closed:会话在用户完成之前离开了流程(已放弃、已过期或在流程中做出决策)。

可用选项:
cancelled_by_reviewer,
replaced,
check_changed,
session_closed,
null
示例:

null

最后修改于 2026年11月7日