接口描述
查询个人用户实名认证的信息。
【注意事项】
入参中psnId
、psnAccount
和psnIDCardNum
三个参数只选择一个传入即可查询个人的认证信息。
查询优先级为 psnId
> psnAccount
> psnIDCardNum
接口地址&请求方法
接口地址:https://{host}/v3/persons/identity-info
请求方法:GET
请求头格式
具体请求头参数,请查看公共请求格式。
请求参数
参数名称 | 参数类型 | 必选 | 参数位置 | 参数说明 |
psnId | string | 否 | query | 个人账号ID |
psnAccount | string | 否 | query | 个人账号标识(手机号或邮箱) |
psnIDCardNum | string | 否 | query | 个人用户的证件号 |
psnIDCardType | string | 否 | query | 个人证件号类型 (传psnIDCardNum时,证件类型为必传项) CRED_PSN_CH_IDCARD - 中国大陆居民身份证 CRED_PSN_CH_HONGKONG - 香港来往大陆通行证 CRED_PSN_CH_MACAO - 澳门来往大陆通行证 CRED_PSN_CH_TWCARD - 台湾来往大陆通行证 CRED_PSN_PASSPORT - 护照 |
响应参数
展开全部参数参数名称 | 参数类型 | 必选 | 参数说明 | |||
code | int32 | 是 | 业务码,0表示成功,非0表示异常。 | |||
message | string | 否 | 业务信息 请根据 code 来判断错误情况,不应该依赖 message 匹配,因为 message 可能会调整。 | |||
data(点击“+”展开详情) | object | 否 | 业务数据 | |||
realnameStatus | int32 | 否 | 用户在e签宝的实名认证状态 0 - 未实名,1 - 已实名 | |||
authorizeUserInfo | boolean | 否 | 是否授权相关信息给当前应用 true - 已授权,false - 未授权 | |||
psnId | string | 否 | 个人账号ID | |||
psnAccount(点击“+”展开详情) | object | 否 | 个人账号标识 【注】仅当authorizeUserInfo返回值为true,已授权当前应用时,才会返回个人账号标识信息。 | |||
accountMobile | string | 否 | 用户登录e签宝SaaS官网的手机号 | |||
accountEmail | string | 否 | 用户登录e签宝SaaS官网的邮箱地址 | |||
psnInfo(点击“+”展开详情) | object | 否 | 个人用户身份信息 【注】仅当authorizeUserInfo返回值为true,已授权当前应用时,才会返回个人用户的身份信息。 | |||
psnName | string | 否 | 个人用户已认证的姓名 | |||
psnNationality | string | 否 | 个人国籍(暂无值返回) | |||
psnIDCardNum | string | 否 | 个人证件号 | |||
psnIDCardType | string | 否 | 证件类型 CRED_PSN_CH_IDCARD - 中国大陆居民身份证 CRED_PSN_CH_HONGKONG - 香港来往大陆通行证(回乡证) CRED_PSN_CH_MACAO - 澳门来往大陆通行证(回乡证) CRED_PSN_CH_TWCARD - 台湾来往大陆通行证(台胞证) CRED_PSN_PASSPORT - 护照 | |||
bankCardNum | string | 否 | 个人用户已认证的银行卡号 | |||
psnMobile | string | 否 | 个人用户已认证的运营商实名登记手机号或银行卡预留手机号 【注】如果用户使用刷脸方式进行的认证,是不会有该实名手机号返回的。 |
请求示例
GET https://openapi.esign.cn/v3/persons/identity-info?psnAccount=183****0101
响应示例
{
"code": 0,
"message": "成功",
"data": {
"authorizeUserInfo": true,
"realnameStatus": 1,
"psnId": "c7e00229***41e7",
"psnAccount": {
"accountMobile": "183****0101",
"accountEmail": null
},
"psnInfo": {
"psnName": "赵四",
"psnNationality": null,
"psnIDCardNum": "130204********1001",
"psnIDCardType": "CRED_PSN_CH_IDCARD",
"bankCardNum": null,
"psnMobile": "183****0101"
}
}
}
错误码
点击查看错误码