接口描述
通过在【创建个人签署账号】接口传入的 thirdPartyUserId ,查询用户的账号信息。
例如:
账号对应的姓名、证件号、联系方式、传入的第三方平台的用户id、账号实名状态。
接口Url
/v1/accounts/getByThirdId
请求方式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 |
请求参数
参数名称 | 参数类型 | 必选 | 参数位置 | 参数说明 |
thirdPartyUserId | string | 是 | Query参数 | 第三方平台的用户id |
公共响应参数
参数名称 | 参数类型 | 必选 | 参数说明 |
code | int | 是 | 业务码,0表示成功 |
message | string | 否 | 业务描述信息 |
data | object | 否 | 业务数据 |
响应参数
参数名称 | 参数类型 | 必选 | 参数说明 |
accountId | string | 否 | 个人账号id |
name | string | 否 | 姓名 |
idType | string | 否 | 证件类型 (1)CRED_PSN_CH_IDCARD 大陆身份证,默认值 (2)CRED_PSN_CH_TWCARD 台湾来往大陆通行证(台胞证) (3)CRED_PSN_CH_MACAO 澳门来往大陆通行证(回乡证) (4)CRED_PSN_CH_HONGKONG 香港来往大陆通行证(回乡证) (5)CRED_PSN_PASSPORT 护照 |
idNumber | string | 否 | 证件号 |
mobile | string | 否 | 联系方式,手机号码 |
string | 否 | 联系方式,邮箱地址 | |
thirdPartyUserId | string | 否 | 第三方平台的用户id |
status | Boolean | 否 | 实名认证状态 |
realnameEvidencePointId | string | 否 | 实名证据点ID |
请求示例
GET https://openapi.esign.cn/v1/accounts/getByThirdId?thirdPartyUserId=20***230111
响应示例
{
"code":0,
"data":{
"accountId":"1c04a7****b664b5b1370e",
"idType":"CRED_PSN_CH_IDCARD",
"thirdPartyUserId":"2019****0111",
"mobile":"1826***xxxx",
"name":"**",
"idNumber":"371xxxxxxxxxxxxxxx",
"email":"wu***st@tsign.com",
"thirdPartyUserType":"_DEFAULT_USER",
"status":false
},
"message":"成功"
}
错误码
错误码 | 错误描述 | 解决方案 |
53000000 | 账号已存在 | |
53000001 | 账号不存在 | |
53000002 | 账号类型不匹配 |