Get info about an identity
GET/identity/info/Via 360: GET https://partner.quantri360.com/v1/tiktok_business/identity/info/
Description
Use this endpoint to retrieve details about an identity.
Request
Endpoint
GET https://partner.quantri360.com/v1/tiktok_business/identity/info/
Authentication & shop
| Name | In | Type | Sample | Description |
|---|---|---|---|---|
| Authorization | header | header | Bearer q360_live_ab12cd34_… | Khóa API của brand (tạo ở mục API key). Bắt buộc với mọi request. Brand suy từ key — không truyền mã brand. |
| platform_shop_id | query | string | 7000000000000000001 | Tài sản TikTok Business đã kết nối — "Mã tài sản" ở trang Nền tảng hoặc GET /v1/platforms (tài khoản quảng cáo cho Marketing API, tài khoản TikTok cho Organic / Messaging). Có thể bỏ khi chỉ kết nối một tài sản. |
Request parameters
| Name | In | Type | Required | Sample | Description |
|---|---|---|---|---|---|
| identity_id | query | string | Yes | Identity ID. | |
| identity_type | query | string | Yes | Identity type. Enum values: CUSTOMIZED_USER, AUTH_CODE, TT_USER, BC_AUTH_TT. See Identities for details. | |
| identity_authorized_bc_id | query | string | No | ID of the Business Center that a TikTok Account User in Business Center identity is associated with. Required when identity_type is BC_AUTH_TT. |
Request examples
curl -s "https://partner.quantri360.com/v1/tiktok_business/identity/info/?identity_id=&identity_type=" \ -H "Authorization: Bearer $KEY"
Python
import requests
KEY = "q360_live_..." # khóa API của brand
r = requests.get(
"https://partner.quantri360.com/v1/tiktok_business/identity/info/",
params={
"identity_id": "",
"identity_type": ""
},
headers={"Authorization": f"Bearer {KEY}"},
timeout=60,
)
print(r.status_code)
print(r.json())Node.js
const KEY = 'q360_live_...'; // khóa API của brand
const url = new URL('https://partner.quantri360.com/v1/tiktok_business/identity/info/');
for (const [k, v] of Object.entries({"identity_id":"","identity_type":""})) url.searchParams.set(k, typeof v === 'object' ? JSON.stringify(v) : String(v));
const r = await fetch(url, {
method: 'GET',
headers: { Authorization: `Bearer ${KEY}` },
});
console.log(r.status, await r.json());PHP
<?php $key = 'q360_live_...'; // khóa API của brand $url = 'https://partner.quantri360.com/v1/tiktok_business/identity/info/' . '?' . http_build_query(['identity_id' => '', 'identity_type' => '']); $ch = curl_init($url); curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); curl_setopt($ch, CURLOPT_HTTPHEADER, ['Authorization: Bearer ' . $key]); $res = curl_exec($ch); $status = curl_getinfo($ch, CURLINFO_HTTP_CODE); curl_close($ch); echo $status, "\n", $res;
Response
Response fields (as returned by TikTok Business)
| Name | Type | Sample | Description |
|---|---|---|---|
| code | number | Response code. For the complete list of response codes and descriptions, see Appendix - Return Codes. | |
| message | string | Response message. For details, see Appendix - Return Codes. | |
| data | object | Returned data. | |
| identity_info | object | Identity information. | |
| identity_id | string | Identity ID. | |
| identity_type | string | Identity type. Enum values: `CUSTOMIZED_USER`, `AUTH_CODE`, `TT_USER`, `BC_AUTH_TT`. See Identities for details. | |
| identity_authorized_bc_id | string | ID of the Business Center that a TikTok Account User in Business Center identity is associated with. | |
| ads_only_mode | boolean | Returned only when `identity_type` is `BC_AUTH_TT`. Whether the "Show through ads only" mode is enabled for the identity. Supported values: `true`, `false`. When this field is `true`, you cannot set `dark_post_status` to `OFF` while creating ads (through /smart_plus/ad/create/, /ad/create/, or /campaign/spc/create/) or updating ads (through /smart_plus/ad/update/, /ad/update/, or /campaign/spc/update/) to allow your post to appear on your TikTok profile and be eligible to receive organic traffic. | |
| username | string | The username (handle name) of the identity. | |
| is_gpppa | boolean | Whether the TikTok account is a Government, Politician, and Political Party Account (GPPPA). Supported values: `true`, `false`. When this field is `true`, the TikTok account cannot be used to create Spark Ads. | |
| can_push_video | boolean | Whether the `BC_AUTH_TT` or `TT_USER` identity can create or edit videos. Supported values: `true`, `false`. | |
| can_pull_video | boolean | Whether the `BC_AUTH_TT` or `TT_USER` identity can get all videos under the TikTok account. Supported values: `true`, `false`. | |
| can_use_live_ads | boolean | Whether the `BC_AUTH_TT`or `TT_USER` identity can access the live room. Supported values: `true`, `false`. | |
| can_manage_message | boolean | Whether the `BC_AUTH_TT` or `TT_USER` identity can manage direct messages. Supported values: `true`, `false`. | |
| can_use_showcase | boolean | Whether the `BC_AUTH_TT` or `TT_USER` identity can access products from Showcase. Supported values: `true`, `false`. | |
| can_use_series | boolean | Whether the `BC_AUTH_TT` or `TT_USER` identity can access TikTok Series. Supported values: `true`, `false`. | |
| display_name | string | Display name. | |
| profile_image_url | string | Profile image URL. | |
| available_status | string | Availability of the identity. Only valid for `TT_USER` and `BC_AUTH_TT` type of identities. Enum values: `AVAILABLE`, `NO_VALID_BIND_ACCOUNT`, `SCOPE_UNAVAILABLE`, `IS_PRIVATE_ACCOUNT`, `NOT_BUSINESS_ACCOUNT`. | |
| request_id | string | The log id of the request, which uniquely identifies a request. |
Response sample
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,
"can_use_series": true,
"can_use_showcase": true,
"display_name": "{{display_name}}",
"identity_id": "{{identity_id}}",
"identity_type": "TT_USER",
"profile_image_url": "{{profile_image_url}}",
"is_gpppa": false,
"username": "{{username}}"
}
}
}
Get started
- Sign up for Partner
- Enable a data type of the Ads (Marketing API) group on the platform page
- Create an API key (tick the TikTok Business channel)
- Call it as in the examples above