调用DescribeVerifyToken发起认证请求，获取认证Token。该接口适用于使用SDK+服务端接入的认证方案。
接入准备：接入该API时，请确保已经完成相应的准备工作，具体请参见实人认证方案接入流程概述、活体人脸验证方案（活体检测方案）接入流程概述。
请求方法：HTTPS POST和GET
接口说明：每次开始认证前通过本接口获取认证Token（VerifyToken），用来串联认证请求中的各个接口。
适用范围：该接口适用于无线SDK接入。
图片地址：需使用HTTP或HTTPS地址，公网可访问的HTTP或HTTPS地址。例如，http://image-demo.img-cn-hangzhou.aliyuncs.com/example.jpg。
图片限制：
- 不支持本地图片的相对路径或绝对路径。
- 单张图片大小请控制在2 MB内，避免算法拉取超时。
- 图片中人脸区域的大小至少64*64像素（px）。
- 单个请求的Body有8 MB的大小限制，请计算好请求中所有图片和其他信息的大小，不要超限。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
| 名称 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | DescribeVerifyToken |
要执行的操作。取值：DescribeVerifyToken。 |
| BizId | String | 是 | 39ecf51e-2f81-4dc5-90ee-ff86125be683 |
认证ID。标识一次认证任务的唯一ID，不超过64字符。针对一次认证任务，系统支持无限次发起提交，直到最终认证通过，该任务完结。 说明 发起不同的认证任务时需要更换不同的BizId。
|
| BizType | String | 是 | RPBasicTest |
使用实人认证服务的业务场景标识。请先参见业务设置在控制台完成创建。 |
| IdCardBackImageUrl | String | 否 | http%3A%2F%2Fjiangsu.china.com.cn%2Fuploadfile%2F2015%2F0114%2F1421221304095989.jpg |
身份证国徽面图片的HTTP或HTTPS链接。 |
| FaceRetainedImageUrl | String | 否 | http%3A%2F%2Fjiangsu.china.com.cn%2Fuploadfile%2F2015%2F0114%2F1421221304095989.jpg |
人像留底照片的HTTP或HTTPS链接。 |
| IdCardFrontImageUrl | String | 否 | http%3A%2F%2Fjiangsu.china.com.cn%2Fuploadfile%2F2015%2F0114%2F1421221304095989.jpg |
身份证人像面图片的HTTP或HTTPS链接。 |
| UserId | String | 否 | user111 |
终端用户的ID，如终端用户的账号ID。 |
| Name | String | 否 | 张三 |
姓名。 |
| IdCardNumber | String | 否 | 330100xxxxxxxxxxxx |
身份证号。 |
| UserIp | String | 否 | 192.168.***.*** |
用户IP。 |
| UserPhoneNumber | String | 否 | 187******** |
用户电话号码。 |
| UserRegistTime | Long | 否 | 1577808000000 |
用户的注册时间。使用时间戳格式表达，单位：毫秒。 |
根据选择的认证方案不同，所需传入的字段不太一样，具体可以参考下述表格中的说明。
|
认证方案 |
Name字段 |
IdCardNumber字段 |
IdCardFrontImageUrl字段 |
IdCardBackImageUrl字段 |
FaceRetainedImageUrl字段 |
|---|---|---|---|---|---|
|
RPBasic |
否 |
否 |
否 |
否 |
否 |
|
RPManual |
否 |
否 |
否 |
否 |
否 |
|
RPBioID |
是 |
是 |
否 |
否 |
否 |
|
RPBioOnly |
是 |
是 |
可选传入 |
可选传入 |
否 |
|
FVBioOnly |
否 |
否 |
否 |
否 |
是 |
|
FDBioOnly |
否 |
否 |
否 |
否 |
否 |
返回数据
| 名称 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| OssUploadToken | Struct |
OSS上传Token信息。 |
|
| Bucket | String | cloudauth-zhangjiakou-external |
OSS文件存储的空间。 |
| EndPoint | String | https://oss-cn-zhangjiakou.aliyuncs.com |
接入端点。 |
| Expired | Long | 1582636610000 |
过期时间。使用时间戳格式表达，单位：毫秒。 |
| Key | String | STS.NU8rUBj**** |
文件上传所需的Key。 |
| Path | String | prod/RdNLC@Ox2n-1s7NMt |
文件存放路径。 |
| Secret | String | FwmnyoqT8dHj7nJLuM67T**** |
文件上传所需的Secret。 |
| Token | String | uWia500nTS5knZaDzq4/KqpvhcLnO**** |
文件上传所需的Token。 |
| RequestId | String | 04F0F334-1335-436C-A1D7-6C044FE73368 |
本次请求的ID。 |
| VerifyPageUrl | String | http%3A%2F%2Fjiangsu.china.com.cn%2Fuploadfile%2F2015%2F0114%2F1421221304095989.jpg |
原H5认证方案入口链接，目前该方案已经下线，不支持新增接入。如果您有H5认证方案接入需求，建议您使用金融级实人认证的PC或移动端H5网页接入方案。 |
| VerifyToken | String | c302c0797679457685410ee51a5ba375 |
该次认证的Token，用来串联认证请求中的各个接口，在30分钟内有效。 |
示例
请求示例
https://cloudauth.aliyuncs.com/?Action=DescribeVerifyToken
&RegionId=cn-hangzhou
&BizType=RPBasicTest
&BizId=39ecf51e-2f81-4dc5-90ee-ff86125be683
&<公共请求参数>正常返回示例
XML格式
<DescribeVerifyTokenResponse>
<RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>
<VerifyToken>c302c0797679457685410ee51a5ba375</VerifyToken>
</DescribeVerifyTokenResponse>JSON格式
{
"RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368",
"VerifyToken": "c302c0797679457685410ee51a5ba375"
}错误码
| HttpCode | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | InvalidParam.ImageValuePatternError | The pattern of value of given image is not acceptable. | 图片地址格式错误，请检查 ImageValue 是否符合图片地址格式的要求。 |
访问错误中心查看更多错误码。