接口描述
开发者通过创建机构签署账号API获取到机构签署账号orgId后,如需查询机构账号的基本信息,可通过该接口查询。
接口Url
/v1/organizations/{orgId}
请求方式Method
GET
请求头Header
提供两种安全接入方式,开发者可选择其中一种方式进行对接,对应参数如何获取,参考文档【请点击】。
方式一:请求签名鉴权
请求头入参示例如下:
参数名称 | 参数类型 | 必选 | 参数位置 | 参数说明 |
X-Tsign-Open-App-Id | string | 是 | Header参数 | 应用ID,通过开放平台创建获取 |
Content-Type | string | 是 | Header参数 | application/json;charset=UTF-8 |
X-Tsign-Open-Ca-Timestamp | string | 是 | Header参数 | API 调用者传递时间戳,值为当前时间的毫秒数,也就是从1970年1月1日起至今的时间转换为毫秒,时间戳有效时间为15分钟,为了防重放攻击 |
Accept | string | 是 | Header参数 | 建议统一填写 */* |
X-Tsign-Open-Ca-Signature | string | 是 | Header参数 | 签名字符串 |
Content-MD5 | string | 否 | Header参数 | 当请求 Body 非 Form 表单时,可以计算 Body 的 MD5 值传递给云网关进行 Body MD5 校验。建议当请求 Body 非 Form 表单时,加上此请求头。 |
X-Tsign-Open-Auth-Mode | string | 是 | Header参数 | 选择请求方式进行鉴权,固定值,Signature |
方式二:OAuth2.0鉴权
当安全接入选择OAuth2.0鉴权方式,请点击查阅详情,请求头入参示例如下:
参数名称 | 参数类型 | 必选 | 参数位置 | 参数说明 |
X-Tsign-Open-App-Id | string | 是 | Header参数 | 应用ID,通过开放平台创建获取 |
X-Tsign-Open-Token | string | 是 | Header参数 | 通过获取鉴权Token接口返回 |
Content-Type | string | 是 | Header参数 | application/json; charset=UTF-8 |
请求参数
参数名称 | 参数类型 | 必选 | 参数位置 | 参数说明 |
orgId | string | 是 | Path参数 | 机构签署账号ID,通过创建机构签署账号API获取 |
公共响应参数
参数名称 | 参数类型 | 必选 | 参数说明 |
code | int | 是 | 业务码,0表示成功 |
message | string | 否 | 业务描述信息 |
data | object | 否 | 业务数据 |
响应参数
参数名称 | 参数类型 | 必选 | 参数说明 |
thirdPartyUserId | string | 否 | 创建机构账号的唯一标识 |
orgId | string | 否 | 机构签署账号ID |
creator | string | 否 | 创建人个人账号ID |
name | string | 否 | 机构名称 |
idType | string | 否 | 机构证件类型 (2)CRED_ORG_CODE 组织机构代码证 (3)CRED_ORG_REGCODE 工商注册号 (4)CRED_ORG_BUSINESS_REGISTTATION_CODE 工商登记证 (5)CRED_ORG_TAX_REGISTTATION_CODE 税务登记证 (6)CRED_ORG_LEGAL_PERSON_CODE 法人代码证 (7)CRED_ORG_ENT_LEGAL_PERSON_CODE 事业单位法人证书 (8)CRED_ORG_SOCIAL_REG_CODE 社会团体登记证书 (9)CRED_ORG_PRIVATE_NON_ENT_REG_CODE 民办非机构登记证书 (10)CRED_ORG_FOREIGN_ENT_REG_CODE 外国机构常驻代表机构登记证 (11)CRED_ORG_GOV_APPROVAL 政府批文 |
idNumber | string | 否 | 机构证件号 |
orgLegalName | string | 否 | 机构法定代表人姓名 |
orgLegalIdNumber | string | 否 | 机构法定代表人证件号 |
status | boolean | 否 | 机构实名状态,true-已实名;false-未实名 |
realnameEvidencePointId | string | 否 | 实名证据点ID |
请求示例
GET https://openapi.esign.cn/v1/organizations/{orgId}
响应示例
{
"code": 0,
"message": "成功",
"data": {
"name": "***",
"creator": "159f****b7068eadc",
"orgLegalName": "**",
"orgLegalIdNumber": "9112****43234",
"orgId": "3eedb1d****d593941dab655",
"idNumber": "911****543234",
"idType": "CRED_ORG_USCC",
"thirdPartyUserId": "AqL****ee4",
"thirdPartyUserType": "_DEFAULT_USER",
"status": false
}
}
错误码
错误码 | 错误描述 | 解决方案 |