AI 助理
文档备案控制台
官方文档
首页

SDK调用接入

更新时间：
复制 MD 格式
产品详情
我的收藏

当您使用SDK进行开发时，无需拼接HTTPS请求或实现签名算法，开发更方便。因此建议您通过SDK方式在服务端集成金融级实人认证。本文为您介绍金融级实人认证服务端需要集成的接口，以及多语言（Java、Python、PHP、C#、Golang、Node.js）的SDK调用示例。

调用说明

  • 全局接入地址：saf.cn-shanghai.aliyuncs.com

  • 请求方法：POST

  • 传输协议：HTTPS

  • QPS限量：API独享QPS限量，详情请参见服务端接口QPS限量说明。

发起认证请求

请求参数

method字段传入init值表示调用发起认证请求接口。

发起认证请求时，传入以下参数：

名称

类型

是否必选

描述

示例值

method

String

是

发起认证请求的操作。

取值：init。

init

sceneId

String

是

认证场景ID，该ID在控制台创建认证场景后自动生成。

10000*****

outerOrderNo

String

是

客户服务端自定义的业务唯一标识，用于后续定位排查问题时使用。

值最长为32位长度的字母和数字组合，请确保唯一。

e0c34a77f5ac40a5aa5e6ed20c********

bizCode

String

是

认证场景码和商户发起认证的接入端有关：

  • 当商户在iOS或安卓平台发起认证时，认证场景码为FACE_SDK。

  • 当商户在小程序中H5页面中发起认证时，认证场景码为FACE。

FACE

identityType

String

是

身份信息的参数类型，必须传入CERT_INFO。

CERT_INFO

certType

String

是

用户证件类型。支持的证件类型，请参见方案概述。

支持的证件类型取值如下：

  • IDENTITY_CARD：中国身份证、港澳台居住证。

  • HOME_VISIT_PERMIT_HK_MC：港澳居民来往内地通行证。

  • HOME_VISIT_PERMIT_TAIWAN：台湾居民来往内地通行证。

IDENTITY_CARD

certNo

String

是

用户身份证件号码，需与证件类型一致。

330103xxxxxxxxxxxx

certName

String

是

用户姓名，需与证件类型一致。

张三

returnUrl

String

是

商户业务页面回调的目标地址。

  • 如您不需要回调商户业务页面，您可以在此处传入空字符串。

  • 当您采用端外唤起支付宝H5方式，且希望您的用户唤起支付宝完成认证后，能够跳回您的应用页面，您需要在此参数下传入您应用的Scheme。更多内容，请参见端外唤起支付宝H5页面。

https://www.aliyun.com

callbackUrl

String

否

认证结果的回调通知地址，必须以HTTPS开头。平台完成认证后会回调该地址，并自动添加certifyId、passed。

https://www.aliyun.com

callbackToken

String

否

安全Token，由您自行生成，用于防重复、防篡改校验。如果设置了该值会在回调地址显示CallbackToken字段。

NMjvQanQgplBSaEI0sL********

encryptType

String

否

加密类型。为空表示不加密。

如开启加密传输，需传入加密算法。目前仅支持SM2国密算法。

如需传入加密算法，需对certName和certNo进行加密，并传入加密后的密文。

有关参数加密的更多信息，请参见参数加密说明。

说明

目前仅Java语言提供有关开启加密传输的示例代码。更多信息，请参见SDK调用示例。

SM2

响应参数

名称

类型

描述

示例值

RequestId

String

请求ID。

130A2C10-B9EE-4D84-88E3-5384FF039795

Message

String

请求消息的响应信息。

OK

certifyId

String

认证ID，刷脸认证的唯一标识。

警告

CertifyId字段为计费统计字段，为了方便后续核对账单，请您在本地留存该字段信息。

初始化接口返回的认证CertifyId在30分钟有效且仅能认证提交一次，请您在有效期内应用，避免重复使用。

7eff3ad26a9c7b68c511b9f35eb1****

certifyUrl

String

认证流程入口Url。

重要

初始化接口返回的认证CertifyUrl在30分钟有效且仅认证仅能提交一次，请您在有效期内使用，避免重复使用。

https://picker.antcloudauth.aliyuncs.com/gateway.do?...

Code

String

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

200

查询认证结果

method参数的值需设定为query，表示调用查询认证结果。

查询认证结果时，传入以下参数：

请求参数

名称

类型

是否必选

描述

示例值

method

String

是

查询认证结果的操作。

取值：query。

query

certifyId

String

是

认证ID，需与发起认证请求时返回的certifyId保持一致。

7eff3ad26a9c7b68c511b9f35eb1****

sceneId

String

是

认证场景ID，需与发起认证请求时的sceneId保持一致。

100000*****

encToken

String

否

公钥加密后的AES 256密钥（Base64编码），用于获取加密图片。仅面向持牌金融客户KYC留存的认证图片。如何使用RSA公钥加密AES密钥，请参见支付宝小程序或H5方案密钥加密说明。

l1tmZUQKdclKdGHzy2hljqltxPYPRo42JjRL04JVHxh9wWP19xHZpVvlKy9lxXRXCiWTKfJAaDfw4pKlZfetvZHdVdjroiXaLt7jx68rpp24wCeWo8wgjMF1lBwJmYZGcTrCVJ+Tonn7CHN7ur11Pn9d4IdkbTi5rBoOx8JITTn6krEH6ssZ5Cj3xFJ4/3PyvloU8UX+FQIPpskYR36jHcqs+Nt4EeTK/wWsAQItl6RfI9FN+8UJ42RVNt/IWHuk3U9aQNxzt7Z+7hbvqpBf/uKp4sgP6fbyYhZ+2tM+KXF1ODOYGenQ65wliaS/C1fTqjUJYcONMEW61T**********

响应参数

名称

类型

是否必选

描述

示例值

passed

String

是

是否通过认证。取值：

  • T：认证通过

  • F：未通过认证（认证失败、认证未提交）

T

identityInfo

String

否

预留字段，默认返回为空。

无

materialInfo

String

否

预留字段，默认返回为空。

无

SDK调用示例

说明

以下集成SDK及获取代码示例的方式以Java开发语言为例。其他开发语言的获取方式类似，获取代码示例前，请确认已切换为对应的语言。

image

  1. 进入OpenAPI门户页，选择实人认证服务。

    说明

    如需获取SDK源码，请单击获取SDK，进入SDK的安装引导页面，在源码仓库地址一栏处获取即可。

  2. 在金融级实人的API接口区域，切换至实人认证方案纯服务端API。

  3. 在右侧区域顶部，切换至SDK示例。

  4. 在所有语言一栏，切换至对应的开发语言（以Java为例）。

    说明

    单击SDK安装信息可快速获取SDK安装包的包名、版本、安装命令等信息。

  5. 以上选择完毕后，即可在代码示例区域查看生成的示例代码。

上一篇：HTTPS原生调用下一篇：支付宝H5页面SDK集成