获取认证身份详情
您可以使用本接口获取一个认证身份的详情。
v1.2与v1.3版本对比
以下表格概括了 v1.2与v1.3接口的变化。
``xtable
|变化内容{30%}|v1.2{35%}|v1.3{35%}|
|---|---|---|
|接口路径| /v1.2/identity/info/| /v1.3/identity/info/|
|请求参数名称|profile_image|profile_image_url|
|请求参数类型 |advertiser_id: number |advertiser_id: string |
|新增返回参数| / |can_manage_message<br>is_gpppa<br>ads_only_mode<br>username`|
## 请求
**地址** https://business-api.tiktok.com/open_api/v1.3/identity/info/
**方法** GET
**Header**
```xtable
|字段|类型|描述|
|---|---|---|
|Access-Token {必填}|string|授权访问令牌。可以通过[获取访问令牌](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)接口获取。|
参数
|字段|类型|描述|
|---|---|---|
| advertiser_id {必填} | string |广告主ID。|
| identity_id {必填}| string | 认证身份ID。|
| identity_type {必填}| string | 认证身份类型。枚举值:`CUSTOMIZED_USER`, `AUTH_CODE`, `TT_USER`, `BC_AUTH_TT`。如果不传入,则返回所有结果。获取更多相关信息,请访问[认证身份](https://ads.tiktok.com/marketing_api/docs?id=1738958351620097)。 |
| identity_authorized_bc_id{+条件必填} | string |与添加到商务中心的TikTok用户这一认证身份绑定的商务中心的ID。当`identity_type`为`BC_AUTH_TT`时必填。|
示例
(code curl http)
curl --location --request GET 'https://business-api.tiktok.com/open_api/v1.3/identity/info/?advertiser_id={{advertiser_id}}&identity_type=TT_USER&identity_id={{identity_id}}' \
--header 'Access-Token: {{Access-Token}}'
(/code)
返回
|字段|类型|描述|
|---|---|---|
|code |number|返回码,详见[附录-返回码](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097)。|
|message |string|返回信息,详见[附录-返回码](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097)。|
|request_id |string|请求的日志ID,唯一标识一个请求。|
|data|object|返回数据。|
#| identity_info | object | 认证身份信息。|
##| identity_id | string | 认证身份 ID。|
##| identity_type | string | 认证身份类型。<br><br>枚举值:`CUSTOMIZED_USER`, `AUTH_CODE`, `TT_USER`, `BC_AUTH_TT`。如果不传入,则返回所有结果。获取更多相关信息,请访问[认证身份](https://ads.tiktok.com/marketing_api/docs?id=1738958351620097)。 |
##| identity_authorized_bc_id | string | 与添加到商务中心的TikTok用户这一认证身份绑定的商务中心的 ID。|
##|ads_only_mode|boolean|仅当 `identity_type` 为 `BC_AUTH_TT` 时返回。<br><br>该认证身份是否启用“仅在广告中显示”。<br><br>支持的值:`true`,`false`。<br><br>当此字段为 `true` 时,在(通过 [/smart_plus/ad/create/](1843317390059522.html)、[/ad/create/](1739953377508354.html) 或 [/campaign/spc/create/](1767334204047362.html))创建广告或(通过 [/smart_plus/ad/update/](1843317411665921.html)、[/ad/update/](1739953405142018.html) 或 [/campaign/spc/update/](1767334250066945.html))更新广告时,您不能将 `dark_post_status` 设置为 `OFF`,从而防止您的帖子出现在您的 TikTok 主页上并获得自然流量。</p>|
##| username | string | 认证身份的用户名。 |
##|is_gpppa|boolean|该 TikTok 账号是否为[政府、政治人物和政党账号](https://support.tiktok.com/en/using-tiktok/growing-your-audience/government-politician-and-political-party-accounts)。<br><br>支持的值:`true`,`false`。<br><br>本字段为 `true` 时,对应的 TikTok 账号不可用于[创建 Spark Ads](1739470744631298.html)。|
##| can_push_video | boolean |该 `BC_AUTH_TT` 或 `TT_USER` 认证身份是否可以创建或编辑视频。<br><br>支持的值:`true`, `false`。 |
##| can_pull_video | boolean | 该 `BC_AUTH_TT` 或 `TT_USER` 认证身份是否可以获取 TikTok 账户下的所有视频。<br><br>支持的值:`true`, `false`。 |
##| can_use_live_ads | boolean | 该 `BC_AUTH_TT` 或 `TT_USER` 认证身份是否可以访问 TikTok 账户的直播间。<br><br>支持的值:`true`, `false`。 |
##| can_manage_message | boolean | 该 `BC_AUTH_TT` 或 `TT_USER` 认证身份是否可以管理私信。<br><br>支持的值:`true`, `false`。 |
##| display_name | string |显示名称(昵称)。|
##| profile_image | string |头像 URL。|
##| available_status | string | 认证身份的可用状态。只对`TT_USER`和`BC_AUTH_TT`类型的身份认证有效。<br><br>枚举值: `AVAILABLE`, `NO_VALID_BIND_ACCOUNT`, `SCOPE_UNAVAILABLE`,` IS_PRIVATE_ACCOUNT`, `NOT_BUSINESS_ACCOUNT`。|
示例
(code Success-Response http)
HTTPS/1.1 200 OK
{
"code": 0,
"message": "OK",
"request_id": "{{request_id}}",
"data": {
"identity_info": {
"available_status": "AVAILABLE",
"can_manage_message": true,
"can_pull_video": true,
"can_push_video": true,
"can_use_live_ads": true,
"display_name": "{{display_name}}",
"identity_id": "{{identity_id}}",
"identity_type": "TT_USER",
"profile_image_url": "{{profile_image_url}}",
"is_gpppa": false,
"username": "{{username}}"
}
}
}
(/code)