tencent cloud

人脸核身

文档人脸核身API 文档卡证活体人脸比对 (App SDK) 相关接口申请SDK核验令牌

申请SDK核验令牌

下载
聚焦模式
字号
最后更新时间： 2026-05-26 23:14:08

1. 接口描述

接口请求域名： faceid.intl.tencentcloudapi.com 。

每次调用Identity Verification SDK核验服务前，需要先调用本接口获取Token，需要保存此Token用来发起核验流程，并且在核验完成后获取结果信息。

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：ApplySdkVerificationToken。
Version 是 String 公共参数，本接口取值：2018-03-01。
Region 是 String 公共参数，详见产品支持的 地域列表。
CheckMode 否 Integer

检测模式，参数取值如下：
1：OCR+活体检测+人脸比对；
2：活体检测+人脸比对；
3：活体检测；
默认值为1。
SecurityLevel 否 Integer

认证的安全等级：
1：静默活体；
2：动作活体；
3：光线活体：
4：动作+光线活体；
默认值为4。
IdCardType 否 String

认证使用的卡证类型，当前支持:

  1. HK (默认): 中国香港身份证
  2. ML: 马来西亚身份证
  3. IndonesiaIDCard: 印度尼西亚身份证
  4. PhilippinesVoteID: 菲律宾选民卡
  5. PhilippinesDrivingLicense: 菲律宾驾驶证
  6. PhilippinesTinID: 菲律宾TinID
  7. PhilippinesSSSID: 菲律宾SSSID
  8. PhilippinesUMID: 菲律宾UMID
  9. MLIDPassport: 港澳台地区以及境外护照
  10. ThailandIDCard: 泰国身份证
  11. MainlandIDCard: 大陆身份证
  12. SingaporeIDCard: 新加坡身份证
  13. HMTPermit：港澳台通行证
CompareImage 否 String

比对照片的base64，仅当CheakMode为2时，本参数才需要传入。
DisableChangeOcrResult 否 Boolean

是否禁止用户修改ocr结果，默认false，允许用户修改。（该参数目前暂不启用）
DisableCheckOcrWarnings 否 Boolean

是否关闭证件告警，默认false，开启。如果开启证件告警，我们会根据告警信息进行拦截。
该功能当前仅支持香港身份证、马来西亚身份证和护照。
SelectedWarningCodes.N 否 Array of Integer

自定义拦截哪些告警码，不填默认拦截所有告警码
Extra 否 String

透传字段，在获取验证结果时返回，最长1024位。
SdkVersion 否 String

PLUS：PLUS版
PRO：PRO版
ENHANCED：增强版
BASIC：基础版（默认）
ActionList 否 String

此接口用于控制动作序列，动作类型如下：
“blink”
“mouth”
“nod”
“shake”
可以选择四个中的1-2个动作。
单动作示例：“blink”
多动作示例：“blink,mouth”.
默认值为blink
仅当SecurityLevel为2或4时传入此参数不同动作类型生效；否则接口报错。
AllowExpiredDocument 否 Boolean

是否允许过期身份证件进入活体检测流程。此参数仅在证件类型为香港身份证（HKID）时生效。
true（默认值）：允许过期香港身份证进入活体检测流程。
false：拒绝过期香港身份证，不可进入活体检测流程。
SkipResultPage 否 Boolean

是否展示最终结果页

枚举值：

  • true： 不展示结果页
  • false： 展示结果页

默认值：false
CardOcrDisplayFields.N 否 Array of String

卡证OCR阶段展示的识别字段

参数格式：["ChineseName","FullName"]

入参限制：卡证类型支持的字段名称：
HK(中国香港身份证): "ChineseName","FullName","LicenseNumber","Birthday","Sex", "IssuedDate", "Permanent", "Symbol", "CurrentIssueDate"
ML(马来西亚身份证): "FullName","LicenseNumber","Sex", "Birthday", "Type", "FormattedAddress"
IndonesiaIDCard(印度尼西亚身份证): "LicenseNumber","FullName","Sex", "Birthday", "FormattedAddress", "Nationality", "DueDate", "IssuedDate", "Street", "Village","Area","Province","City","MaritalStatus", "BloodType", "Religion", "Occupation"
PhilippinesVoteID(菲律宾选民卡): "FirstName","LastName","Birthday"
PhilippinesDrivingLicense(菲律宾驾驶证): "LastName","FirstName","MiddleName","Sex","Birthday"
PhilippinesTinID(菲律宾TinID): "LicenseNumber", "FullName", "Birthday"
PhilippinesSSSID(菲律宾SSSID):"LicenseNumber", "FullName", "Birthday"
PhilippinesUMID(菲律宾UMID):"Surname", "MiddleName", "GivenName", "Sex", "Birthday"
MLIDPassport(港澳台地区以及境外护照):"LicenseNumber","FullName", "Surname", "GivenName", "Birthday", "Sex","DateOfExpiration","IssuingCountry"
ThailandIDCard(泰国身份证):"FullName", "LastName", "FirstName", "FormattedAddress", "LicenseNumber", "Birthday", "ExpirationDate", "IssuedDate", "RegistrationNumber", "Religion", "ThaiBirthday", "ThaiExpirationDate", "ThaiIssueDate"
MainlandIDCard(大陆身份证):"LicenseNumber", "FullName", "Sex", "Nation", "Birthday", "FormattedAddress"
SingaporeIDCard(新加坡身份证):"ChineseName","Sex","Birthday","LicenseNumber","Nationality","FullName","Address"
HMTPermit(港澳台通行证):"Name", "EnglishName", "Sex", "Number", "ValidDate", "Birthday"

字段不传则按照默认逻辑展示全部识别字段

3. 输出参数

参数名称 类型 描述
SdkToken String

标识一次SDK核验流程的令牌，有效时间为10分钟。流程结束后可用该令牌获取核验结果信息。
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 ApplySdkVerificationToken调用示例

输入示例

POST / HTTP/1.1
Host: faceid.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ApplySdkVerificationToken
<公共请求参数>

{
    "CheckMode": 3,
    "SecurityLevel": 1,
    "SdkVersion": "BASIC"
}

输出示例

{
    "Response": {
        "RequestId": "70666678-fe01-411b-abc0-f0ea7a1518ce",
        "SdkToken": "C7FD7E30-93AA8-0148B2-BAD3-9F385C1AE648"
    }
}

5. 开发者资源

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

命令行工具

6. 错误码

该接口暂无业务逻辑相关的错误码，其他错误码详见 公共错误码。

上一篇: 获取活体人脸比对SDK核验结果下一篇: 获取SDK验证结果

帮助和支持

本页内容是否解决了您的问题？

填写满意度调查问卷，共创更好文档体验。

文档反馈