查询机构账号
(1)按照账号ID查询
接口地址: /v1/organizations/{orgId}
请求方式: GET
接口描述: 使用创建账号返回的账号id查询机构账号。
请求参数
参数名称 | 说明 | 参数类型 | 是否必填 | 类型 |
---|---|---|---|---|
orgId | 机构账号id | path | true | string |
请求示例
GET https://openapi.esign.cn/v1/organizations/d406f301ee5349399dfc83f36a243fcd
响应参数
参数名称 | 说明 | 类型 |
---|---|---|
orgId | 机构账号Id | string |
name | 机构名称 | string |
idType | 证件类型,详见机构证件类型说明 | string |
idNumber | 证件号 | string |
thirdPartyUserId | 第三方平台的机构id | string |
orgLegalIdNumber | 企业法人证件号 | string |
orgLegalName | 企业法人名称 | string |
响应示例
{
"code":0,
"message":"成功",
"data":{
"name":"测试企业01",
"orgId":"d406f301ee5349399dfc83f36a243fcd",
"idNumber":"12330100470104939U",
"idType":"CRED_ORG_USCC",
"thirdPartyUserId":"B001",
"orgLegalName":"",
"orgLegalIdNumber":""
}
}
返回码说明
返回码 | 说明 |
---|---|
0 | 成功 |
53000000 | 账号已存在 |
53000001 | 账号不存在 |
53000002 | 账号类型不匹配 |
(2)按照第三方机构ID查询
接口地址: /v1/organizations/getByThirdId
请求方式: GET
接口描述: 通过2.2.1接口创建的账号,当对接方创建账户时传入第三方平台机构Id,支持使用第三方平台机构Id查询机构的账号。
请求参数
参数名称 | 说明 | 参数类型 | 是否必填 | 类型 |
---|---|---|---|---|
thirdPartyUserId | 第三方平台机构id | query | true | string |
请求示例
GET https://openapi.esign.cn/v1/organizations/getByThirdId?thirdPartyUserId=xxxxxxxx
响应参数
参数名称 | 说明 | 类型 |
---|---|---|
orgId | 机构账号Id | string |
name | 机构名称 | string |
idType | 证件类型,详见机构证件类型说明 | string |
idNumber | 证件号 | string |
thirdPartyUserId | 第三方平台的机构id | string |
响应示例
{
"code":0,
"message":"成功",
"data":{
"name":"测试企业01",
"orgId":"d406f301ee5349399dfc83f36a243fcd",
"idNumber":"12330100470104939U",
"idType":"CRED_ORG_USCC",
"thirdPartyUserId":"B001"
}
}
返回码说明
返回码 | 说明 |
---|---|
0 | 成功 |
53000000 | 账号已存在 |
53000001 | 账号不存在 |
53000002 | 账号类型不匹配 |