接口描述
查询机构实名认证信息。
注意事项:
入参中orgId
、orgName
和orgIDCardNum
三个参数只选择一个传入即可查询机构认证信息。
查询优先级为 orgId
> orgName
> orgIDCardNum
。
接口地址&请求方法
接口地址:https://{host}/v3/organizations/identity-info
请求方法:GET
请求头格式
具体请求头参数,请查看公共请求头格式。
请求参数
参数名称 | 参数类型 | 必选 | 参数位置 | 参数说明 |
orgId | string | 否 | query | 机构账号ID |
orgName | string | 否 | query | 组织机构名称 |
orgIDCardNum | string | 否 | query | 组织机构证件号 |
orgIDCardType | string | 否 | query | 组织机构证件类型(传orgIDCardNum时,该参数为必传) CRED_ORG_USCC - 统一社会信用代码 CRED_ORG_REGCODE - 工商注册号 |
响应参数
展开全部参数参数名称 | 参数类型 | 必选 | 参数说明 | |||
code | int32 | 是 | 业务码,0表示成功,非0表示异常。 | |||
message | string | 否 | 业务信息 请根据 code 来判断错误情况,不应该依赖 message 匹配,因为 message 可能会调整。 | |||
data(点击“+”展开详情) | object | 否 | 业务数据 | |||
realnameStatus | int32 | 否 | 实名认证状态 0 - 未实名,1 - 已实名 | |||
authorizeUserInfo | boolean | 是 | 是否授权身份信息给当前应用 true - 已授权,false - 未授权 | |||
orgId | string | 否 | 机构账号ID | |||
orgName | string | 否 | 机构名称 | |||
orgInfo(点击“+”展开详情) | object | 否 | 机构认证信息 【注】如果机构已实名的状态下,会默认返回实名的机构名称、机构证件号、机构证件号类型、法定代表人姓名、机构管理员姓名(脱敏)、机构管理员联系方式(脱敏) | |||
orgIDCardNum | string | 否 | 组织机构证件号 | |||
orgIDCardType | string | 否 | 组织机构证件号类型 CRED_ORG_USCC - 统一社会信用 CRED_ORG_REGCODE - 工商注册号 | |||
legalRepName | string | 否 | 法定代表人姓名 | |||
legalRepIDCardNum | string | 否 | 法定代表人证件号 | |||
legalRepIDCardType | string | 否 | 法定代表人证件类型 CRED_PSN_CH_IDCARD - 中国大陆居民身份证 CRED_PSN_CH_HONGKONG - 香港来往大陆通行证(回乡证) CRED_PSN_CH_MACAO - 澳门来往大陆通行证(回乡证) CRED_PSN_CH_TWCARD - 台湾来往大陆通行证(台胞证) CRED_PSN_PASSPORT - 护照 | |||
adminName | string | 否 | 机构管理员姓名(在e签宝SaaS官网认证绑定的管理员姓名) 【注】姓名会脱敏显示 | |||
adminAccount | string | 否 | 机构管理员联系方式(在e签宝SaaS官网认证绑定的管理员手机号或者邮箱,如果两种联系方式都有优先返回手机号) 【注】联系方式会脱敏显示 |
请求示例
GET https://openapi.esign.cn/v3/organizations/identity-info?orgName=xxxx企业
响应示例
{
"code": 0,
"message": "成功",
"data": {
"authorizeUserInfo": false,
"realnameStatus": 1,
"orgId": "e553e5*******cb0d5fd8d4",
"orgName": "杭州XX信息科技有限公司",
"orgInfo": {
"orgType": null,
"orgIDCardNum": "9100********0004",
"orgIDCardType": "CRED_ORG_REGCODE",
"legalRepName": "何一兵",
"legalRepIDCardNum": null,
"legalRepIDCardType": null,
"adminName": "张*",
"adminAccount": "1******0123"
}
}
}
错误码
点击查看错误码