查询个人账号
(1)按照账号ID查询
接口地址: /v1/accounts/{accountId}
请求方式: GET
接口描述: 使用创建账号返回的账号id查询用户的账号。
请求参数
参数名称 | 说明 | 参数类型 | 是否必填 | 类型 |
---|---|---|---|---|
accountId | 个人账号id | path | true | string |
请求示例
GET https://openapi.esign.cn/v1/accounts/{accountId}
响应参数
参数名称 | 说明 | 类型 |
---|---|---|
accountId | 个人账号id | string |
name | 姓名 | string |
idType | 证件类型,详见个人证件类型说明 | string |
idNumber | 证件号 | string |
mobile | 联系方式,手机号码 | string |
联系方式,邮箱地址 | string | |
thirdPartyUserId | 第三方平台的用户id | string |
响应示例
{
"code":0,
"message":"成功",
"data":{
"mobile":"15811111111",
"email":"yy@qq.com",
"name":"测试账号01",
"accountId":"99b9513fa07c4dc4b1e77aecc2588cb6",
"idType":"CRED_PSN_CH_IDCARD",
"idNumber":"311111111111111111",
"thirdPartyUserId":"A001"
}
}
返回码说明
返回码 | 说明 |
---|---|
0 | 成功 |
53000000 | 账号已存在 |
53000001 | 账号不存在 |
53000002 | 账号类型不匹配 |
(2)按照第三方用户ID查询
接口地址: /v1/accounts/getByThirdId
请求方式: GET
接口描述: 通过2.1.1接口创建的账号,当对接方创建账户时传入第三方平台的userId时,支持使用第三方平台的userId查询用户的账号。
请求参数
参数名称 | 说明 | 参数类型 | 是否必填 | 类型 |
---|---|---|---|---|
thirdPartyUserId | 第三方平台的用户id | query | true | string |
请求示例
GET https://openapi.esign.cn/v1/accounts/getByThirdId?thirdPartyUserId=A001
响应参数
参数名称 | 说明 | 类型 |
---|---|---|
accountId | 个人账号id | string |
name | 姓名 | string |
idType | 证件类型,详见个人证件类型说明 | string |
idNumber | 证件号 | string |
mobile | 联系方式,手机号码 | string |
联系方式,邮箱地址 | string | |
thirdPartyUserId | 第三方平台的用户id | string |
响应示例
{
"code":0,
"message":"成功",
"data":{
"mobile":"15811111111",
"email":"yy@qq.com",
"name":"测试账号01",
"accountId":"99b9513fa07c4dc4b1e77aecc2588cb6",
"idType":"CRED_PSN_CH_IDCARD",
"idNumber":"311111111111111111",
"thirdPartyUserId":"A001"
}
}
返回码说明
返回码 | 说明 |
---|---|
0 | 成功 |
53000000 | 账号已存在 |
53000001 | 账号不存在 |
53000002 | 账号类型不匹配 |