机构账号修改
(1)按照账号ID修改
接口地址: /v1/organizations/{orgId}
请求方式: PUT
接口描述: 对接方调用本接口在e签宝平台中使用账号id更新机构账号,如变更名称后,则系统根据变更后的信息自动申请新数字证书。
请求参数
参数名称 | 说明 | 参数类型 | 是否必填 | 类型 |
---|---|---|---|---|
orgId | 机构账号id | path | true | string |
name | 机构名称,默认不变 | body | false | string |
idType | 证件类型,详见机构证件类型说明 ,默认CRED_ORG_USCC | body | false | string |
idNumber | 证件号,该字段只有为空才允许修改 | body | false | string |
orgLegalIdNumber | 企业法人证件号 | body | false | string |
orgLegalName | 企业法人名称 | body | false | string |
请求示例
PUT https://openapi.esign.cn/v1/organizations/d406f301ee5349399dfc83f36a243fcd
{
"idNumber":"12330100470104939U",
"idType":"CRED_ORG_USCC",
"name":"测试企业01",
"orgLegalIdNumber":"",
"orgLegalName":""
}
响应参数
参数名称 | 说明 | 类型 |
---|---|---|
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 | 账号类型不匹配 |
53000003 | 证件信息冲突 |
(2)按照第三方机构ID修改
接口地址: /v1/organizations/updateByThirdId
请求方式: POST
接口描述: 过2.2.1接口创建的账号,当对接方创建账户时传入第三方平台的userId时,对接方调用本接口在e签宝平台中使用第三方机构id更新机构账号
请求参数
参数名称 | 说明 | 参数类型 | 是否必填 | 类型 |
---|---|---|---|---|
thirdPartyUserId | 第三方平台机构id | query | true | string |
name | 机构名称 | body | false | string |
idType | 证件类型,详见机构证件类型说明 ,默认CRED_ORG_USCC | body | false | string |
idNumber | 证件号,该字段只有为空才允许修改 | body | false | string |
请求示例
POST https://openapi.esign.cn/v1/organizations/updateByThirdId?thirdPartyUserId=B001
{
"idNumber":"12330100470104939U",
"idType":"CRED_ORG_USCC",
"name":"测试企业01"
}
响应参数
参数名称 | 说明 | 类型 |
---|---|---|
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 | 账号类型不匹配 |
53000003 | 证件信息冲突 |