名称	类型	必填	描述
content-type	string	true	固定值 "application/json"
access-token	string	true	调用`/oauth/client_token/`生成的 token，此 token 不需要用户授权。示例：`clt.1d1021d2aee3d41fee2d2add43456badMFZnrhFhfWotu3Ecuiuka27****`

请求参数

Body

名称	类型	是否必填	描述	示例
open_id	string	false	用户open_id, 通过/oauth/access_token/获取，用户唯一标志。与douyin_shortId字段必须传一个，如果都传会以open_id为第一优先级进行查询。	ba253642-0590-40bc-9bdf-9a1334b94059
douyin_shortId	string	false	用户抖音号。与open_id字段必须传一个，如果都传会以open_id为第一优先级进行查询。	12345678
role_labels	list[string]	true	多个身份信息枚举数组，可以根据需求传以下字段列表： COMPANY_BAND：企业号品牌号 AUTH_COMPANY：认证企业号 STAFF：员工号 OPEN_BRAND：开平品牌号 OPEN_STAFF：开平员工号 OPEN_PARTNER：开平合作号	["COMPANY_BAND", "AUTH_COMPANY"]

请求示例

curl --location --request POST 'https://open.douyin.com/api/douyin/v1/role/check/' \
--header 'access-token: clt.1d1021d2aee3d41fee2d2add43456badMFZnrhFhfWotu3Ecuiuka27****' \
--header 'Content-Type: application/json' \
--data-raw '{
    "open_id": "ba253642-0590-40bc-9bdf-9a1334b94059",
    "role_labels": ["COMPANY_BAND", "AUTH_COMPANY"]
}'

响应参数

名称	类型	是否必填	描述	示例
data	object	false
match_result	bool	false	匹配状态	true
filter_role	map[string]bool	false	返回查询集合中，没有身份的信息	{"COMPANY_BAND":false}
log_id	string	true	标识请求的唯一id	202008121419360101980821035705926A
err_no	int64	true	错误码	0
err_msg	string	true	错误码描述	""

响应示例

正常示例

{
    "data":{
        "match_result":true,
        "filter_role":{
            "COMPANY_BAND":false
        }
    },
    "err_no":0,
    "err_msg":"",
    "log_id":"02169175717697700000000000000000000ffff0a981c1c423a88"
}

异常示例

案例1: 
{
    "log_id":"02169175725748600000000000000000000ffff0a981c1c205982",
    "err_no":28001029,
    "err_msg":"douyin_shortId参数不合法，无效的 douyin_shortId"
}
案例2:
{
    "err_no":28001008,
    "err_msg":"access_token过期,请刷新或重新授权",
    "log_id":"02169174792941000000000000000000000ffff0ac37a22cb0bd7"
}

错误码

HTTP 状态码	错误码	描述	排查建议
200	28001029	参数不合法	检查入参
200	28001008	access_token过期	重新授权
200	29001001	内部错误	平台内部错误，多次重试后仍未恢复，请联系平台OnCall