获取组织机构核身地址
接口描述
- 获取组织机构核身认证地址
接口地址
/v2/identity/auth/web/orgAuthUrl
请求方式
POST
- 请求报文体采用Json数据格式,编码方式采用UTF-8编码
请求参数
参数名称 | 说明 | 参数类型 | 是否必填 | 类型 |
---|---|---|---|---|
authType | 指定默认认证方式认证, 详见:组织机构认证方式对照表 |
body | 否 | string |
availableAuthTypes | 指定页面显示认证方式,会从appid已配置方式下取值,可指定方式见:组织机构认证类型对照表 | body | 否 | list |
contextInfo | 业务方交互上下文信息 | body | 否 | object |
orgEntity | 企业基本信息 | body | 否 | object |
configParams | 认证配置信息 | body | 否 | object |
receiveUrlMobileNo | 接收实名认证邀请链接短信手机号。传入手机号会发送邀请短信到该用户,并收取一次短信费用,不传入则不发送,不产生短信费用 | body | 否 | string |
带页面交互的实名与业务方通信数据模型
参数名称 | 说明 | 参数类型 | 是否必填 | 类型 |
---|---|---|---|---|
contextId | 发起方业务上下文标识 在异步通知时发送回发起方 |
body | 否 | string |
notifyUrl | 发起方接收认证状态变更通知的地址 | body | 否 | string |
origin | 认证发起来源 | body | 否 | string |
redirectUrl | 认证结束后页面跳转地址.如果origin=APP,则需在该url参数中以key为esignAppScheme设置APP Scheme参数 | body | 是 | string |
showResultPage | 认证完成是否显示结果页,默认显示 | body | 否 | boolean |
企业/组织认证基本信息
参数名称 | 说明 | 参数类型 | 是否必须 | 类型 |
---|---|---|---|---|
name | 组织机构名称 | body | 否 | string |
certNo | 组织机构证件号,支持统一社会信用代码或工商注册号 | body | 否 | string |
legalRepName | 法定代表人姓名 | body | 否 | string |
legalRepCertNo | 法定代表人身份证号 | body | 否 | string |
agentName | 经办人姓名 | body | false | string |
agentIdNo | 经办人身份证号 | body | false | string |
organizationType | 组织类型,1 - 企业类;2 - 个体工商户 ;3 - 其他组织;不填为不指定核验类型 | body | 否 | int |
认证配置信息
参数名称 | 说明 | 参数类型 | 是否必须 | 类型 |
---|---|---|---|---|
orgUneditableInfo | 指定页面上不可修改的信息属性。 详见:组织机构页面版认证信息属性名称对照表 未指定的信息属性可以修改。 如需全局配置信息属性不可修改,可联系客服。 |
array | 否 | string |
请求示例
POST /v2/identity/auth/web/orgAuthUrl HTTP/1.1
{
"authType": "ORG_BANK_TRANSFER",
"availableAuthTypes":["ORG_BANK_TRANSFER","ORG_ZM_AUTHORIZE"],
"configParams":{
"orgUneditableInfo": ["name", "certNo", "legalRepName", "legalRepCertNo", "agentName", "agentIdNo"]
},
"contextInfo": {
"contextId": "57cc9602-d1b6-48bd-bdbb-61e9f8443955",
"notifyUrl": "https://www.notifyUrl.cn",
"origin": "BROWSER",
"redirectUrl": "https://www.redirectUrl.cn",
"showResultPage": true
},
"orgEntity": {
"name": "杭州天谷信息科技有限公司",
"certNo": "913301087458306077",
"legalRepName": "何一兵",
"legalRepCertNo": "362428198001010010",
"agentName": "李四",
"agentIdNo": "362428199001010010",
"organizationType": 1
},
"receiveUrlMobileNo": "13811111111"
}
响应参数
参数名称 | 说明 | 类型 |
---|---|---|
code | 错误码 | int |
data | 业务信息 | object |
message | 错误信息 | string |
获取实名认证链接地址响应数据
属性名称 | 说明 | 类型 |
---|---|---|
flowId | 认证流程Id | string |
shortLink | 认证地址短连接 | string |
url | 认证地址原始链接 | string |
响应示例
{
"code": 0,
"data": {
"flowId": "806742726212082619",
"shortLink": "https://testt.tsign.cn/rXTpvXA9ofIx",
"url": "http://testfront.tsign.cn:8890/identity/login?param=RjnJDvu5CYdgGzn5fC9z2vW1sdPoQIsT6rAc50wvvVTHDZuzNDE8KC9NjW8a%2BmU5bHsgBvMoP3uETH8XJ1KBgi5DdgD9vI79W%2FA3g5ENKNwo0bOt5d3AqjyQXETMJmp8rol2NWuDw6WiJ1m0a0ak5%2BX0IxIuOgDkXxGhVMNtkfBCVXSo%2FnYGWL9z3afWjZPd8Dt6F4bdMmdzkzUVvyX7KUQK6qRAAK1K2wltCUGiIJmwUJQCpTmP5zDtx4HMio2IgNXJRk2KxE6emS%2BLUWQyIw%3D%3D"
},
"message": "成功"
}