DescribeCardVerify-获取认证结果

本文介绍如何通过调用DescribeCardVerify接口查询认证结果。

接口信息

重要

在使用本接口前,请确保已完整阅读接入流程,并开通服务。

接口名:DescribeCardVerify

全局接入地址:cloudauth.aliyuncs.com(IPv4)或cloudauth-dualstack.aliyuncs.com(IPv6)

请求方法:POSTGET

传输协议:HTTPS

接口说明:当您收到回调通知之后,可以在服务端通过该接口获取相应的认证状态和认证资料。

QPS限量:API独享QPS限量,详情请参见信息核验接口QPS限量说明

请求参数

名称

类型

是否必选

描述

示例值

CertifyId

String

认证请求ID。

此参数调用 InitCardVerify 接口返回。

91707dc296d469ad38e4c5ef********

响应结果

名称

类型

描述

示例值

RequestId

String

请求ID。

130A2C10-B9EE-4D84-88E3-5384FF03****

Message

String

接口调用返回信息。

success

Code

String

返回码:200表示成功,其他均为失败。

重要
  • 此参数代表是否正确调用了接口,详细的返回码说明请参见服务端错误码

  • 业务核验结果请通过ResultObject中的字段查看。

200

ResultObject

BizCode

String

身份核验结果:

  • 1:校验⼀致

  • 2:校验不⼀致

  • 3:查⽆记录

1

CardInfo

String

提交核验的身份证信息。

详细说明请查看ResultObject.CardInfo字段说明。

{
  "address": "浙江省杭州市余杭区文一西路969号",
  "birthDate": "19901226",
  "certName": "张三",
  "certNo": "1234561990122*****",
  "nationality": "汉",
  "authority": "xxx公安局",
  "startDate": "20201130",
  "endDate": "20301130"
}

PictureInfo

String

经过客户端编辑后的卡证信息,使用JSON格式的字符串返回。

{
  "certUrl": "https://cn-shanghai-aliyun-nmeta.cn-shanghai.oss.aliyuncs.com/verify/xxxxxxx/xxxxxxxxxx_ocridface_dbf2_normal.jpeg",
  "certNationalUrl": "https://cn-shanghai-aliyun-nmeta.cn-shanghai.oss.aliyuncs.com/verify/xxxxxxxxxx/xxxxxxxxxxx_ocridback_e8a3_normal.jpeg"
}

OcrCardInfo

Sting

OCR读取的身份证信息。

详细说明请查看ResultObject.CardInfo字段说明。

ResultObject.CardInfo

名称

类型

描述

示例值

address

String

身份证上的住址。

xxxxxxxx969

birthDate

String

身份证上的出生日期。

19901xxx

certName

String

身份证上的姓名。

张三

certNo

String

身份证号。

1234561990122*****

nationality

String

民族。

authority

String

签发机关。

xxx公安局

startDate

String

有效期限开始时间。

20201130

endDate

String

有效期限结束时间。

20301130

SDK调用示例

重要

集成前请确保您已完整阅读接入流程开通了服务获取AccessKey且正确配置环境变量

关于SDK示例和安装包获取:

  • 您可以在OpenAPI的在线接口调试页面的右侧找到对应的SDK调用示例,并在代码示例的右上角点击SDK安装信息查看SDK的安装信息。

    说明

    注意选择所需的编程语言。

    image

  • 如果您有离线安装的需求,可以进入SDK安装页面选择需要语言SDK,并转到发布地址获取。

    image

  • OpenAPI平台可对接口进行在线调试,并获取SDK示例。

  • 代码示例工程各编程语言调用SDK的示例工程,可作为接入参考。