API 认证：安全发起 KYC API 请求

获取您的 API 密钥

在 Didit 中，API 密钥的作用域限定在您账户中的特定应用。应用是一个工作空间，您可以在其中为特定项目或环境配置工作流并管理验证。创建应用时，每个应用都会获得一个具有完整访问权限的主要 API 密钥。您还可以在其旁边添加更多密钥，每个密钥仅授予特定服务或合作伙伴所需的访问权限。要查找您的密钥：

前往 Didit Business Console 并登录。

选择您的应用

从顶部的下拉菜单中选择您要使用的应用。

打开 API 密钥

在左侧边栏中导航至 开发者 -> API 密钥。

复制或创建密钥

主要密钥是该应用自身的密钥。创建新密钥可为服务或合作伙伴提供其独立的机密，并授予其所需的访问权限。

您的 API 密钥属于机密信息，请像对待密码一样妥善保管。主要密钥可代表您的应用提供对 API 的完全访问权限。切勿将其暴露在前端代码、公开代码仓库或客户端打包产物中。请始终仅将其保存在服务端。

API 密钥格式

生产环境应用的新 API 密钥以 sk_live_ 开头，沙盒应用的新 API 密钥以 sk_test_ 开头，后跟 43 个 URL 安全字符（字母、数字、- 和 _）。在此格式推出之前创建的密钥没有前缀，将继续有效且无需更改。请在 x-api-key 请求头中发送完整的密钥（包括前缀），并且不要因为密钥没有前缀而将其拒绝。

获取您的组织 ID

您的组织 ID是用于标识您组织的 UUID。您可以在限定组织范围的 API 路径中使用它，例如 /auth/v2/organizations/me/{org_id}/applications/。您可以直接从 Business Console 复制它，无需调用 API：

打开组织设置

在 Didit Business Console 中，前往组织设置。

复制组织 ID

组织 ID 字段会在组织名称旁显示您组织的 UUID，并配有复制到剪贴板按钮。

发起经过身份验证的请求

如需对 API 请求进行身份验证，请在 x-api-key HTTP 请求头中包含您的机密 API 密钥。以下是对 Create Session endpoint 发起经过身份验证的请求的示例：

cURL

curl --request POST \
     --url https://verification.didit.me/v3/session/ \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --header 'x-api-key: YOUR_API_KEY' \
     --data '
{
  "workflow_id": "WORKFLOW_ID",
  "vendor_data": "USER_ID",
  "callback": "CALLBACK_URL"
}
'

错误处理

如果您的 API 密钥错误、格式有误或已被撤销，API 将返回 401 Unauthorized：

{
  "detail": "Authentication credentials were not provided or are invalid."
}

已过期的密钥也会返回 401，且带有 "detail": "This API key has expired."。未携带密钥的请求将返回 403，且带有 "detail": "You do not have permission to perform this action."。

状态码	含义
401	API 密钥错误、格式有误、已被撤销或已过期
403	未发送 API 密钥、该密钥无权访问所请求的资源或操作，或者请求来自该密钥 IP 列表之外的地址
带有 `"code": "application_deleted"` 的 403	该密钥属于已被删除的应用。删除后的几分钟内，API 会返回此响应，随后会像对待任何无效密钥一样拒绝该密钥。请勿重试：该应用及其密钥已不复存在。
404	对于会话路由：该会话超出了该密钥允许的工作流或状态范围

API 错误页面列出了所有的状态、响应体和代码。

限定范围的 API 密钥

为每个服务或合作伙伴分配其专属密钥，而不是共享主要密钥。每个密钥都有其独立的访问权限：对每类资源（会话、决策、媒体、个人、企业、交易、工作流、Webhook、应用设置、分析）设置为无、只读或读写，还可选择将密钥限制为仅适用于某些工作流或已通过的会话、仅允许来自特定 IP 地址列表的请求，并设置到期日期。您可以在 24 小时重叠期内轮换密钥，也可以立即将其撤销。在限定范围访问功能推出之前创建的密钥将保留完整访问权限。请参阅 API 密钥，了解预设、各项预设涵盖的资源，以及 API 如何响应限定范围的密钥。

如果您收到 401 错误，请仔细核对您是否针对正确的应用使用了正确的 API 密钥，并确认该密钥未被重新生成。

概览

定价

工作流与验证

审核与运营

实体（用户与企业）

设置与自定义

安全与合规

Didit 学院

资源

API 认证：安全发起 KYC API 请求

获取您的 API 密钥

API 密钥格式

获取您的组织 ID

发起经过身份验证的请求

错误处理

限定范围的 API 密钥

​获取您的 API 密钥

​API 密钥格式

​获取您的组织 ID

​发起经过身份验证的请求

​错误处理

​限定范围的 API 密钥

获取您的 API 密钥

API 密钥格式

获取您的组织 ID

发起经过身份验证的请求

错误处理

限定范围的 API 密钥