获取个人核身认证地址

接口描述

获取个人实名认证地址，页面中集成了人脸识别认证、银行卡认证以及手机认证三种认证方式，用户可以自主选择其中一种认证方式。

【注】核身认证无需提前为用户创建账号；

API在线调试

可通过API在线调试工具使用接口功能，入口：获取个人核身认证地址

接口地址

/v2/identity/auth/web/indivAuthUrl

请求方式

POST

请求头

提供两种安全接入方式，对应参数如何获取，参考文档【请点击】。

方式一：请求签名鉴权（优先推荐）

参数名称	类型	必选	参数说明
X-Tsign-Open-App-Id	string	是	应用ID
X-Tsign-Dns-App-Id	string	否	应用ID。在微信小程序中对接，该参数必传；其他场景无需添加该参数
Content-Type	string	是	application/json;charset=UTF-8
X-Tsign-Open-Ca-Timestamp	string	是	API 调用者传递时间戳，值为当前时间的毫秒数，也就是从1970年1月1日起至今的时间转换为毫秒，时间戳有效时间为15分钟，为了防重放攻击
Accept	string	是	建议统一填写 /
X-Tsign-Open-Ca-Signature	string	是	签名字符串
Content-MD5	string	否	当请求 Body 非 Form 表单时，可以计算 Body 的 MD5 值传递给云网关进行 Body MD5 校验。建议当请求 Body 非 Form 表单时，加上此请求头。
X-Tsign-Open-Auth-Mode	string	是	选择请求方式进行鉴权，固定值：Signature

方式二：OAuth2.0鉴权（不推荐使用）

当安全接入选择OAuth2.0鉴权方式，请点击查阅详情。

请求参数

展开全部参数参数名称（点击左侧“+”一键展开）		参数类型	必选	参数位置	参数说明
authType		string	否	body	指定默认认证类型（打开认证页面所展示的第一个认证类型） PSN_BANK4_AUTHCODE - 个人银行卡四要素认证 PSN_TELECOM_AUTHCODE - 个人运营商三要素认证 PSN_FACEAUTH_BYURL - 个人刷脸认证
availableAuthTypes		list	否	body	指定页面显示认证方式 PSN_BANK4_AUTHCODE - 个人银行卡四要素认证 PSN_TELECOM_AUTHCODE - 个人运营商三要素认证 PSN_FACEAUTH_BYURL - 个人刷脸认证
authAdvancedEnabled		list	否	body	指定通过银行卡认证或运营商认证方式时，是否使用详情版，如指定则核验失败可返回具体不匹配信息，传空默认为普通版。 PSN_BANK4_AUTHCODE - 个人银行卡四要素认证 PSN_TELECOM_AUTHCODE - 个人运营商三要素认证【注】详情版：需要单独购买，具体购买方式请咨询e签宝工作人员；普通版：信息比对核验失败，不会返回具体的不匹配信息。
receiveUrlMobileNo		string	否	body	接收实名认证链接短信通知的手机号。传入手机号会发送邀请实名认证短信通知到该用户，并收取一次短信费用，不传入则不发送，不产生短信费用
indivInfo		object	否	body	个人实名认证的基本信息
	bankCardNo	string	否	body	个人银行卡号（仅支持银联卡）
	certNo	string	否	body	个人证件号
	certType	string	否	body	个人证件类型 INDIVIDUAL_CH_IDCARD - 中国大陆身份证 INDIVIDUAL_CH_TWCARD - 台湾来往大陆通行证（台胞证） INDIVIDUAL_CH_HONGKONG_MACAO - 港澳来往大陆通行证（回乡证） INDIVIDUAL_PASSPORT - 护照 INDIVIDUAL_CH_RESIDENCE_PERMIT_HK_MO_TW - 港澳台居民居住证（18位810开头） INDIVIDUAL_CH_GREEN_CARD - 外国人永久居留身份证（18位9开头）
	mobileNo	string	否	body	个人手机号
	name	string	否	body	个人姓名
configParams		object	否	body	认证配置信息
	indivUneditableInfo	list	否	body	设置个人认证页面上不可修改的基本信息。传空表示可以修改 name - 姓名 certNo - 证件号 mobileNo - 手机号 bankCardNo - 银行卡号
contextInfo		object	否	body	业务方交互上下文信息，有统计需求或者分账需求必填部分参数
	contextId	string	否	body	自定义业务标识在异步通知时发送回发起方，直接对接客户建议上传相关订单Id或会员Id，渠道分销商建议上传客户唯一Id
	notifyUrl	string	否	body	发起方接收实名认证状态变更通知的地址，异步通知参考【请点击】
	origin	string	否	body	认证发起来源，默认值为 BROWSER BROWSER - 浏览器 APP - 移动端APP（传APP时，redirectUrl字段必传）
	redirectUrl	string	否	body	认证结束后页面跳转地址，【点击】查看如何跳转回APP
	showResultPage	boolean	否	body	认证完成是否显示结果页，默认值为 true true - 显示结果，false - 不显示结果

响应参数

展开全部参数参数名称（点击左侧“+”一键展开）		类型	必选	参数说明
code		int32	是	业务码，0表示成功，非0表示异常。
message		string	是	错误信息请根据 code 来判断错误情况，不应该依赖message匹配，因为 message 可能会调整。
data		object	否	业务信息
	flowId	string	否	认证流程ID
	shortLink	string	否	个人实名认证短链接（链接有效期30天）沙箱环境域名：https://smlt.tsign.cn 正式环境域名：https://t.tsign.cn
	url	string	否	个人实名认证长链接（链接有效期30天）沙箱环境域名：https://smlfront.esign.cn 正式环境域名：https://idverify.esign.cn （微信小程序端支持自定义域名点击查看对接说明）

请求示例

{
    "authType": "PSN_BANK4_AUTHCODE",
    "availableAuthTypes":["PSN_TELECOM_AUTHCODE","PSN_BANK4_AUTHCODE","PSN_FACEAUTH_BYURL"],
  	"authAdvancedEnabled":["PSN_BANK4_AUTHCODE","PSN_TELECOM_AUTHCODE"],
    "contextInfo": {
        "contextId": "993de698a82b43d9ba6a4fb26093629e",
        "notifyUrl": "http://172.xx.xx.10:8080/notify/msgRecive",
        "redirectUrl": "https://www.xx.cn/",
        "showResultPage": true
    },
    "indivInfo": {
        "name": "***",
        "certNo":"41042*****555"
    },
    "configParams": {
        "indivUneditableInfo": ["name", "certNo", "mobileNo", "bankCardNo"]
    }
}

响应示例

{
    "code":0,
    "data":{
        "flowId":"806735635690817476",
        "shortLink":"https://testt.tsign.cn/AzPS1T0LtMqU",
        "url":"http://testfront.tsign.cn:8890/identity/login?param=RjnJDvu5CYdgGzn5fC9z2iCGY0T2ytSFx08ZyMLVXwvkma7PPiwuic8hqMsyl5QdwbXxpdhLYs9EdWbklEHn8CQaTs8XW5K1DM2WmzI0imNASHNnCMZ3s42GMiwY02RdqHZ%2FS4sZCs%2F2c5mMPrDFwGHW72sv2yQ4h4IQH44%2BGJTwry6eCP3W49kd11lDEEtSnL737p7bh%2FhYvKrDSEYGdnfsLCvbxnd4bjzH1GcE7acg4%2BZXNZaQn23Nnvb2ZPhF7bSwFk7tZ6S4E7dbAECBeA%3D%3D"
    },
    "message":"成功"
}

错误码

错误码	错误描述	解决方案
30500000	操作出错,请联系服务人员处理, ID:XXXX	请核实入参格式是否正确
30500100	缺少参数：请输入正确的银行卡号!	请输入正确的银行卡号
30500100	缺少参数：请输入正确的证件类型!	请输出正确的证件类型
30500100	缺少参数：请输入正确的手机号码!	请输入正确的手机号
30500100	缺少参数：App Scheme	请传入认证结束后页面跳转地址当认证发起来源"origin": "APP"时，redirectUrl必须传入开发者自身scheme地址，示例值："redirectUrl": "esign://demo/realBack"
30500101	参数错误：姓名只支持中文/大小写英文/点符号·/破折号-/半角括号	请输入真实的姓名
30500101	参数错误：姓名长度2~50位	请输入真实的姓名
30500201	当前应用未配置该类型的认证方式	当前appid没有配置接口入参指定的认证方式
30500202	当前无可使用的认证方式	当前appid没有配置认证方式