使用SDK+服务端接入、H5+服务端接入的认证方案时,调用本接口发起认证请求,获取认证token。

单击查看老版本接入文档说明。

接入准备

接入该API时,请确保已经完成相应的准备工作,具体请参见服务端接入准备

描述

接口名:DescribeVerifyToken

请求方法:HTTPS POST 和 GET

接口说明:每次开始认证前通过本接口获取认证Token(VerifyToken),用来串联认证请求中的各个接口。

适用范围:该接口适用于SDK+服务端接入、H5+服务端接入的认证方案。

图片地址:需使用HTTP/HTTPS地址,公网可访问的HTTP/HTTPS地址。例如,http://image-demo.img-cn-hangzhou.aliyuncs.com/example.jpg
说明
  • 不支持本地图片的相对路径或绝对路径。
  • 单张图片大小请控制在2M内,避免算法拉取超时。
  • 图片中人脸区域的大小至少64*64像素。
  • 单个请求的Body有8M的大小限制,请计算好请求中所有图片和其他信息的大小,不要超限。

请求参数

名称 类型 参数位置 是否必需 描述
Action String query 要执行的操作,取值:DescribeVerifyToken
RegionId String query 服务所在地域,,取值:cn-hangzhou
BizType String query 使用实人认证服务的业务场景标识。请先参见业务设置在控制台完成创建。
BizId String query 标识一次认证任务的唯一ID,不超过64字符。针对一次认证任务,系统支持无限次发起提交,直到最终认证通过,该任务完结。
说明 发起不同的认证任务时需要更换不同的BizId。
UserId String query C用户的ID,如C用户账号ID。
Name String query 姓名。
IdCardNumber String query 身份证号。
IdCardFrontImageUrl String query 身份证人像面图片的HTTP/HTTPS链接。
IdCardBackImageUrl String query 身份证国徽面图片的HTTP/HTTPS链接。
FaceRetainedImageUrl String query 人像留底照片的HTTP/HTTPS链接。
IdImageUrl String query 二代身份证芯片中存储的头像照片的HTTP/HTTPS链接。
PassedRedirectUrl String query 认证通过重定向URL,H5方案适用 。
FailedRedirectUrl String query 认证失败重定向URL,H5方案适用 。
根据选择的认证方案不同,所需传入的字段不太一样,具体可以参考下述表格中的说明。
认证方案 Name字段 IdCardNumber字段 IdCardFrontImageUrl字段 IdCardBackImageUrl字段 FaceRetainedImageUrl字段 IdImageUrl字段
RPBasic
RPManual
RPBioID
RPBioOnlyPro
RPBioOnly 可选传入 可选传入
RPH5BioOnly 可选传入 可选传入

返回参数

名称 类型 是否必须 描述
VerifyToken 字符串 该次认证的Token,用来串联认证请求中的各个接口,在30分钟内有效。
VerifyPageUrl 字符串 H5认证页面的入口链接,适用于H5方案,其他认证方案不需要关注。

示例

请求示例
https://cloudauth.aliyuncs.com/?Action= DescribeVerifyToken
&RegionId=cn-hangzhou
&BizType=RPBasicTest
&BizId=39ecf51e-2f81-4dc5-90ee-ff86125be683
&<[公共请求参数]>
返回示例
  • XML格式
    <?xml version='1.0' encoding='UTF-8'?>
    <DescribeVerifyTokenResponse>
        <Data>
            <VerifyToken>c302c0797679457685410ee51a5ba375</VerifyToken>
        </Data>
    </VerifyMaterialResponse>
  • JSON格式
    {
          "VerifyToken": "c302c0797679457685410ee51a5ba375",
    }