全部产品
存储与CDN 数据库 域名与网站(万网) 应用服务 数加·人工智能 数加·大数据基础服务 互联网中间件 视频服务 开发者工具 解决方案 物联网 钉钉智能硬件

获取认证资料

更新时间:2018-01-10 20:16:24

描述

接口名称GetMaterials

功能描述: 用户在云服务提交认证后,业务系统通过GetMaterials接口获取用户上传的材料(人脸图、证件图)及算法识别的材料(OCR 的地址等)。

名词解释

  • 业务场景 Biz: 表示使用实人认证服务的业务场景,请先参考 业务设置 在控制台上完成创建。
  • 认证 ID TicketId: 标识一次认证任务的唯一 ID,通常由业务使用方指定,方便关联业务场景的其他内容。

请求参数

名称 类型 是否必须 描述
Action String 系统规定参数。取值: GetMaterials
RegionId String 系统规定参数。取值: cn-hangzhou
Biz String 参看名词业务场景
TicketId String 参看名词认证 ID
注意: 需要与当前认证任务在 发起认证请求(GetVerifyToken) 时的认证 ID保持一致。

返回参数

名称 类型 是否必须 描述
Name String 姓名。
IdentificationNumber String 证件号。
IdCardType String 证件类型。identityCard代表身份证。
IdCardExpiry String 证件有效期。格式:yyyyMMdd。证件有效期依赖于算法识别,非必返回字段,可能存在无法识别的情况。
Address String 证件地址。通过 OCR 算法识别出的地址(JSON 数据格式),请参考 Address 参数示例。证件地址依赖于算法识别,非必返回字段,可能存在无法识别或识别不全的情况。
Sex String 证件性别。返回值的集合为{m, f},m 代表男性,f 代表女性。
IdCardFrontPic String 证件照正面图片 URL(有时效性的 HTTP 图片地址)。若证件类型为身份证,则为身份证人像面照片。
IdCardBackPic String 证件照背面图片 URL(有时效性的 HTTP 图片地址)。若证件类型为身份证,则为身份证国徽面照片。
FacePic String 认证过程中拍摄的人像正面照图片 URL(有时效性的 HTTP 图片地址)。

错误码说明

错误代码 英文描述 中文描述 HTTP 状态码
Error.InternalError The request processing has failed due to some unknown error. 服务内部出现未知错误,请联系技术支持排查。 500
InvalidParam.ParamMissing Please check if there is param empty in your imput. 参数错误,请检查参数是否为空。 400
Error.NoPermissionAccess No permission to access our service. 没有权限访问服务,请确认是否服务已开通。 403
InvalidParam.InvalidBiz The biz is not valid 参数Biz不合法,请与控制台上创建的保持一致。 400
InvalidParam.RecordNotFound There is not record associated with your ticketId. 没有找到和TicketId关联的记录。 404
Error.GetMaterialsError GetMaterials action failed due to internal error. 查询认证资料过程中出现内部未知错误,请联系技术支持排查。 500

示例

拼接 HTTPS 请求示例

请求示例

  1. https://cloudauth.aliyuncs.com/?Action=GetMaterials
  2. &Biz=RPBasic
  3. &TicketId=1839171847
  4. &<[公共请求参数]>

返回示例

XML 格式:

  1. <?xml version='1.0' encoding='UTF-8'?>
  2. <GetMaterialsResponse>
  3. <Data>
  4. <Name>李明</Name>
  5. <FacePic><![CDATA[http://image-demo.img-cn-hangzhou.aliyuncs.com/example.jpg]]></FacePic>
  6. <IdCardType>identityCard</IdCardType>
  7. <Address>{ "detail": "2号大街18号", "address": { "area": { "text": "江干区", "key": "area" }, "province": { "text": "浙江省", "key": "province" }, "city": { "text": "杭州市", "key": "city" } } }</Address>
  8. <IdCardBackPic>
  9. <![CDATA[http://verify-img.cn-shanghai.img.aliyun-inc.com/542fd010b3b04ef18193a94d8739cf97OSS.JPG?Expires=1505348837&OSSAccessKeyId=IJ95qE4nJQY6t6Lk&Signature=WeIU6zzeXXpBhwf7uwig0p7I7Hk%3D]]></IdCardBackPic>
  10. <IdCardFrontPic>
  11. <![CDATA[http://verify-img.cn-shanghai.img.aliyun-inc.com/715559d79b8d49c4aabfdad3f6a40774OSS.JPG?Expires=1505348836&OSSAccessKeyId=IJ95qE4nJQY6t6Lk&Signature=R9bwCimlsXLGYaIZ8S%2BppxNAzJ0%3D]]></IdCardFrontPic>
  12. <IdentificationNumber>629212199002108316</IdentificationNumber>
  13. <IdCardExpiry>19900210</IdCardExpiry>
  14. <Sex>m</Sex>
  15. </Data>
  16. <Success>true</Success>
  17. <Code>1</Code>
  18. </GetMaterialsResponse>

JSON 格式:

  1. {
  2. "Code": "1",
  3. "Data": {
  4. "Address": "{ \"detail\":\"2号大街1号\", \"address\":{ \"area\":{ \"text\":\"江干区\", \"value\":\"330104\", \"key\":\"area\" }, \"province\":{ \"text\":\"浙江省\", \"value\":\"330000\", \"key\":\"province\" }, \"city\":{ \"text\":\"杭州市\", \"value\":\"330100\", \"key\":\"city\" } } }",
  5. "FacePic": "http://image-demo.img-cn-hangzhou.aliyuncs.com/example.jpg",
  6. "IdCardBackPic": "http://verify-img.cn-shanghai.img.aliyun-inc.com/581fd010b3b04ef18193a94d8739cf07OSS.JPG?Expires=1505301155&OSSAccessKeyId=IJ95qE4nJQY6t6Lk&Signature=nYEZoBcdBro4Yfr4QQSv%2B3/rM24%3D",
  7. "IdCardExpiry": "19900210",
  8. "IdCardFrontPic": "http://verify-img.cn-shanghai.img.aliyun-inc.com/915559f79b8d49c8aabfdad3f6a40774OSS.JPG?Expires=1505301155&OSSAccessKeyId=IJ95qE4nJQY6t6Lk&Signature=jgW4rqB5OSTbDDo1Xlf7rwL9N80%3D",
  9. "IdCardType": "identityCard",
  10. "IdentificationNumber": "545230199002108328",
  11. "Name": "李明",
  12. "Sex": "m"
  13. },
  14. "Success": true
  15. }
Address 示例
  1. {
  2. "address": {
  3. "area": {
  4. "text": "余杭区",
  5. "value": "330110",
  6. "key": "area"
  7. },
  8. "province": {
  9. "text": "浙江省",
  10. "value": "330000",
  11. "key": "province"
  12. },
  13. "town": {
  14. "value": "0",
  15. "key": "town"
  16. },
  17. "city": {
  18. "text": "杭州市",
  19. "value": "330100",
  20. "key": "city"
  21. }
  22. },
  23. "detail": "五常街道永福社区文一西路977号"
  24. }

以上地址目前为身份证 OCR 识别所得,可能存在识别错误或不全的情况。其中,province 为 省/直辖市,city 为 市,area 为 区/县/县级市,town 为 街道/镇,detail 为 详细地址。由于 街道/镇 一级的行政划分经常匹配不到,town 这个字段返回值为 0。

使用 SDK 开发包示例

参看 SDK 开发包使用文档中的认证方案示例:JavaPHPPython.NETNode.jsGo

本文导读目录