获取认证链接

更新时间:2023-10-26 15:12:00

接口描述

用于获取实名认证链接或授权认证链接,用户可通过访问链接进行实名认证或授权认证操作。

该接口支持 实名认证(authentication)和授权认证(combination)两种模式:

(1)使用实名认证模式可以为用户创建e签宝SaaS官网账号并生成实名认证链接用于核验用户真实性。

当传入的手机号或邮箱已完成实名认证时,接口默认不会返回实名认证链接,仅返回“账号已实名,无需重复实名”信息。

(2)使用授权认证模式包含实名认证模式的功能,同时还可以授权appId所属平台获取用户在e签宝SaaS官网的账号信息。

当传入的手机号或邮箱180天内已完成授权认证,接口不会返回授权认证链接,请在180天内查询获取用户已授权的信息。

Tips:

1)当开发者需要获取用户实名认证中所使用的姓名、证件号和联系方式时必须选择授权认证模式

2)用户可以使用接口传入的手机号或邮箱登录e签宝SaaS官网进行账号注销等操作。

3)点击了解实名认证模式和授权认证模式之前的区别和页面图示


实名认证模式授权认证模式都支持以下认证方式,用户可自主选择其中一种方式进行实名认证。

个人人脸识别认证银行卡四要素认证手机号三要素认证

机构法定代表人认证授权委托书认证对公账号打款认证企业支付宝认证

名词解释:组织机构是企业、事业单位、机关、社会团体及其他依法成立单位的统称。

接口

/v3/oauth2/index

注意:该接口路径虽然是V3开头,但不是真正的SaaS API V3版产品,请不要搭配使用。建议只搭配本篇SaaS API 标准版(V2版本)使用。如需使用V3版本,请点击跳转到:【实名认证和授权服务API 3.0】

请求方式

POST

请求头

方式一:请求签名鉴权

当接口调用选择请求签名鉴权方式,【请点击】。

参数名称

类型

必选

参数说明

X-Tsign-Open-Auth-Mode

string

接口鉴权方式,请填写固定值Signature

X-Tsign-Open-App-Id

string

应用ID

X-Tsign-Dns-App-Id

string

应用ID,在微信小程序中对接,该参数为必传,其他场景无需添加该参数。

X-Tsign-Open-Ca-Signature

string

请求签名值。

X-Tsign-Open-Ca-Timestamp

string

接口调用时的Unix时间戳,单位毫秒。

防重放攻击,时间戳有效期为15分钟。

Content-MD5

string

当请求Body体为非Form格式时,需要对Body体计算ContentMD5并传给网关进行校验。

application/json格式的Body体时此项必选。

Content-Type

string

application/json; charset=UTF-8

Accept

string

建议统一填写 */*

方式二:OAuth2.0鉴权

当接口调用选择OAuth2.0鉴权方式请点击


请求参数

展开全部参数参数名称

类型

必选

参数

类型

参数说明

(描述过长,请注意左右拖动查看)

appId

string

body

应用ID(需与请求头里的appid一致)

redirectUrl

string

body

认证完成后跳转页面

notifyUrl

string

body

认证完成后的回调通知地址,通知开发者用户认证完成

需要符合 https /http 协议地址

详见【认证回调通知说明

account

string

body

账号标识(手机号或者邮箱)

可使用此手机号/邮箱登录e签宝SaaS官网

bizType

string

body

业务类型

authentication:代表实名认证模式

combination:代表授权认证模式

responseType

string

body

bizType为授权认证模式时此值必传

授权类型,固定传值“code”

scope

string

body

授权范围

bizType为授权认证模式时此值必传

get_user_info - 允许获取用户账号的基本信息(账号ID、手机号、邮箱、实名信息)

op_organ_admin - 允许获取用户账号下对应的企业空间管理权限

个人账号授权时仅传get_user_info即可,

机构账号授权时需要同时传get_user_info和op_organ_admin,使用英文逗号分隔.

state

string

body

业务参数,可自定义此参数值。

认证完成后,在redirectUrl重定向跳转和notifyUrl回调通知时此参数值原样回传给开发者。

可用于第三方应用来防止CSRF攻击,建议请求时传入state参数值,且不能含有中文。

receiveUrlMobileNo

string

body

接收认证链接短信通知的手机号。

传入手机号会发送邀请认证短信通知到该用户。

receiveUrlEmail

string

body

接收认证链接通知的邮件地址。

传入邮件地址会发送邀请认证邮件通知到该用户。

authConfigParam

object

body

认证页面配置参数

authType

string

body

设置页面中默认选择的认证类型

个人认证场景:

【个人银行卡四要素认证】

PSN_BANK4_AUTHCODE

【个人运营商三要素认证】

PSN_TELECOM_AUTHCODE

【个人刷脸认证】

PSN_FACEAUTH_BYURL

组织机构认证场景:

【ORG_BANK_TRANSFER】组织机构对公账户打款认证

【ORG_ZM_AUTHORIZE】企业芝麻认证【ORG_LEGAL_AUTHORIZE】组织机构法定代表人授权书签署认证

【LEGAL_REP_AUTH】法定代表人认证

注:

(1)法定代表人本人认证的方式默认都是在页面存在的,无法去掉。

(2)当只希望用户选择【法定代表人认证】一种方式时,此参数仅传入 LEGAL_REP_AUTH 即可。

availableAuthTypes

list

body

设置页面中可选择的所有认证方式

个人认证场景:

【个人银行卡四要素认证】

PSN_BANK4_AUTHCODE

【个人运营商三要素认证】

PSN_TELECOM_AUTHCODE

【个人刷脸认证】

PSN_FACEAUTH_BYURL

组织机构认证场景:

【组织机构对公账户打款认证】

ORG_BANK_TRANSFER

【企业支付宝认证】

ORG_ZM_AUTHORIZE

【组织机构授权委托书认证】

ORG_LEGAL_AUTHORIZE

indivEditableInfo

list

body

设置页面中允许编辑的个人信息字段

name - 个人姓名

certNo - 个人证件号

mobileNo - 个人手机号(仅针对实名认证手机号)

bankCardNo - 个人银行卡号

orgEditableInfo

list

body

设置页面中允许编辑的机构信息字段

name - 组织机构名称

certNo - 组织机构证件号

legalRepName - 法定代表人姓名

legalRepCertNo - 法定代表人身份证号

showResultPage

boolean

body

认证完成是否显示结果页,默认显示

true - 显示

false - 不显示

authSubject

object

body

组织机构基本信息

注意:

组织机构认证必传此参数对象,个人认证一定不要传此参数对象

组织机构是企业、事业单位、机关、社会团体及其他依法成立单位的统称。


name

string

body

组织机构名称

注意:如果是组织机构认证,authSubject传入的情况,此参数必传,个人认证场景无需传入。

certNo

string

body

组织机构证件号

certType

string

body

组织机构证件类型

【统一社会信用代码】

CRED_ORG_USCC

【工商注册号】

CRED_ORG_REGCODE

organizationType

int32

body

组织机构类型

1 - 企业类

2 - 个体工商户

99 - 其他组织

legalRepName

string

body

法定代表人姓名

legalRepCertNo

string

body

法定代表人证件号

legalRepCertType

string

body

法定代表人证件类型,不传取默认值“

CRED_PSN_CH_IDCARD”

【中国大陆居民身份证】

CRED_PSN_CH_IDCARD

【香港来往大陆通行证】

CRED_PSN_CH_HONGKONG

【澳门来往大陆通行证】

CRED_PSN_CH_MACAO

【台湾来往大陆通行证】

CRED_PSN_CH_TWCARD

【护照】

CRED_PSN_PASSPORT

individualInfo

object

body

个人基本信息


name

string

body

个人姓名

certNo

string

body

个人证件号

certType

string

body

个人证件类型

【中国大陆居民身份证】

CRED_PSN_CH_IDCARD

【香港来往大陆通行证】

CRED_PSN_CH_HONGKONG

【澳门来往大陆通行证】

CRED_PSN_CH_MACAO

【台湾来往大陆通行证】

CRED_PSN_CH_TWCARD

【护照】

CRED_PSN_PASSPORT

mobileNo

string

body

个人手机号(仅用于实名认证,不同于登录手机号)

bankCardNo

string

body

个人银行卡号(仅支持银联卡)


响应参数

参数名称

类型

必选

参数说明

code

int

业务码,0表示成功

message

string

信息

data

string

认证链接,链接有效期30天



请求示例(个人实名认证模式)

{
    "appId": "7438790001",
    "redirectUrl": "https://www.esign.cn/",
    "notifyUrl": "http://xx.xx.xx.xx:8081/asyn/notify",
    "bizType": "authentication",
    "state": "xxxx",
    "account": "13800001111",
    "authConfigParam": {
       "authType": "PSN_TELECOM_AUTHCODE",
        "availableAuthTypes": [
            "PSN_TELECOM_AUTHCODE",
            "PSN_FACEAUTH_BYURL",
            "PSN_BANK4_AUTHCODE"
        ],
        "indivEditableInfo": [
            "name",
            "certNo"
        ],
        "showResultPage": true
    },
    "individualInfo": {
        "bankCardNo": "",
        "certNo": "110101199603121978",
        "certType": "CRED_PSN_CH_IDCARD",
        "name": "**"
    }
}


请求示例(机构授权认证模式)

{
    "appId": "7438790001",
    "redirectUrl": "https://www.esign.cn/",
    "notifyUrl": "http://10.00.00.001:58081/asyn/notify",
    "bizType": "combination",
    "scope": "get_user_info,op_organ_admin",
    "responseType": "code",
    "state": "Test002xxx",
    "account": "138xxxx1111",
    "authConfigParam": {
        "authType": "ORG_BANK_TRANSFER",
        "availableAuthTypes": [
            "ORG_BANK_TRANSFER",
            "ORG_LEGAL_AUTHORIZE"            
        ],
        "indivEditableInfo": [
            "name" ,
            "certNo"
        ],
         "orgEditableInfo": [
            "name"
        ],
        "showResultPage": true
    },
    "authSubject": {
        "name":"xxx测试企业",
         "certType":"CRED_ORG_USCC",
        "certNo":"911112200000000001",
        "legalRepName":"**"
    },
    "individualInfo": {
        "bankCardNo": "",
        "certNo": "110101199603121978",
        "certType": "CRED_PSN_CH_IDCARD",
        "name": "**"
    }
}

响应示例

{
    "code": 0,
    "message": "成功",
    "data": "https://openapi.esign.cn/usercenterFront/oemAuth/v3/realName/index?contextKey=aabbf05ef2e3fe97d4a1ffeb5536c39f&appId=743879xxx"
}

错误码

错误码

错误描述

排查思路

60000000

缺少参数{%s}

请检查JSON中参数值是否空。

60000001

参数错误{%s}

请检查JSON中参数值传入是否正确。

60000000

参数错误{%s}

请检查JSON中参数值类型传入是否正确。

60000002

参数格式错误{%s}

请检查JSON中参数值格式传入是否正确。

60000003

内部服务不可用

请联系客服或交付顾问

60000004

该组织:无管理员或法定代表人

组织机构授权时,该组织无管理员或法定代表人

我要纠错