录入身份信息
该接口用于录入实名认证的身份信息，在唤起有源活体认证前，需要使用该接口进行实名认证。
Tip: 实名认证接口会有计费管理，接入前请联系飞书开放平台工作人员，邮箱：open-platform@bytedance.com。
仅通过计费申请的应用，才能在开发者后台查找并申请该接口的权限。
请求
| 项目 | 值 |
|---|---|
| HTTP URL | https://open.feishu.cn/open-apis/human_authentication/v1/identities |
| HTTP Method | POST |
| 接口频率限制 | 特殊频控 |
| 支持的应用类型 | custom,isv |
| 权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 | human_authentication:identity 创建和编辑实名认证主体 |
| 字段权限要求 | > Tip: 该接口返回体中存在下列敏感字段，仅当开启对应的权限后才会返回；如果无需获取这些字段，则不建议申请 contact:user.employee_id:readonly 获取用户 user ID |
请求头
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| Authorization | string | 是 | tenant_access_token 值格式："Bearer access_token" 示例值："Bearer t-7f1bcd13fc57d46bac21793a18e560" 了解更多：如何选择与获取 access token |
| Content-Type | string | 是 | 固定值："application/json; charset=utf-8" |
查询参数
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
user_id | string | 是 | 用户的唯一标识（使用的ID类型见下一参数描述，不同ID类型的区别和获取，参考文档：如何获得 User ID、Open ID 和 Union ID？） 示例值：ou_2eb5483cb377daa5054bc6f86e2089a5 |
user_id_type | string | 否 | 用户 ID 类型 示例值：open_id 可选值有： - open_id: 标识一个用户在某个应用中的身份。同一个用户在不同应用中的 Open ID 不同。了解更多：如何获取 Open ID - union_id: 标识一个用户在某个应用开发商下的身份。同一用户在同一开发商下的应用中的 Union ID 是相同的，在不同开发商下的应用中的 Union ID 是不同的。通过 Union ID，应用开发商可以把同个用户在多个应用中的身份关联起来。了解更多：如何获取 Union ID？ - user_id: 标识一个用户在某个租户内的身份。同一个用户在租户 A 和租户 B 内的 User ID 是不同的。在同一个租户内，一个用户的 User ID 在所有应用（包括商店应用）中都保持一致。User ID 主要用于在不同的应用间打通用户数据。了解更多：如何获取 User ID？默认值： open_id当值为 user_id，字段权限要求： contact:user.employee_id:readonly 获取用户 user ID |
请求体
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
identity_name | string | 是 | 姓名 示例值："张三" |
identity_code | string | 是 | 身份证号 示例值："4xxxxxxxx" |
mobile | string | 否 | 手机号 示例值："13xxxxxxx" |
请求体示例
json
{
"identity_name": "张三",
"identity_code": "4xxxxxxxx",
"mobile": "13xxxxxxx"
}响应
响应体
| 名称 | 类型 | 描述 |
|---|---|---|
code | int | 错误码，非 0 表示失败 |
msg | string | 错误描述 |
data | \- | - |
└ verify_uid | string | 用户绑定实名身份的uid |
响应体示例
json
{
"code": 0,
"msg": "success",
"data": {
"verify_uid": "ou_2eb5483cb377daa5054bc6f86e2089a5"
}
}错误码
| HTTP状态码 | 错误码 | 描述 | 排查建议 |
|---|---|---|---|
| 400 | 1291001 | upload fail | 上传失败，可以重试 |
| 400 | 1291002 | name mismatch | 检查用户绑定的姓名是否匹配 |
| 400 | 1291003 | code mismatch | 检查用户绑定的身份证号是否匹配 |
| 400 | 1291004 | mobile mismatch | 检查用户绑定的手机号是否匹配 |
| 400 | 1291010 | invalid request | 检查请求参数是否为空 |