sumsub-check-permissions

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

Check Permissions

检查权限

Returns the tenant's allowed entitlements so callers can gate features before making any API writes.

返回租户的允许权限，以便调用方在执行任何API写入操作前限制功能。

Usage

使用方法

Run the script and parse the result:

bash

bash ${CLAUDE_SKILL_DIR}/scripts/check_permissions.sh

Output: raw Sumsub response body followed by

HTTP <code>

Success (HTTP 200):

json

{"allowedChecks": {"REUSABLE_KYC_SDK": "Reusable KYC via API/SDK: ...", "VIDEO_IDENT": "Video Identification: ..."}}
HTTP 200

Error (non-200):

json

{"description":"Unauthorized","errorName":"...","correlationId":"..."}
HTTP 401

```
allowedChecks
```
— map of permission key → human-readable label for all entitlements enabled for this tenant.
Permission keys present as keys of
```
allowedChecks
```
are the allowed entitlements.

运行脚本并解析结果：

bash

bash ${CLAUDE_SKILL_DIR}/scripts/check_permissions.sh

输出：原始Sumsub响应体，后跟

HTTP <code>

。

成功（HTTP 200）：

json

{"allowedChecks": {"REUSABLE_KYC_SDK": "Reusable KYC via API/SDK: ...", "VIDEO_IDENT": "Video Identification: ..."}}
HTTP 200

错误（非200）：

json

{"description":"Unauthorized","errorName":"...","correlationId":"..."}
HTTP 401

```
allowedChecks
```
— 此租户已启用的所有权限的权限键→易读标签映射。
```
allowedChecks
```
中的键即为允许的权限。

How callers should use this

调用方应如何使用

If the HTTP status is not 200, stop immediately — show the error body to the user and do not proceed.

After a successful response, check whether the required

BackgroundCheckTarget

key is present in

allowedChecks

. If it is not, stop immediately — do not build or POST the payload. Tell the user which entitlement is missing and that they need to contact their CSM or Sumsub Support to get it enabled.

Entitlement → feature mapping (key examples):

Feature	Required entitlement
`E_KYC` docset	`E_KYC_TARGET`
`PROOF_OF_RESIDENCE` docset	`POA`
`E_SIGN` docset	`E_SIGN_TARGET`
`deviceIntelligenceSettings.enabled: true`	`DEVICE_INTELLIGENCE`
`QUESTIONNAIRE` scoring	`QUESTIONNAIRE_SCORING`
`QUESTIONNAIRE` attachments	`QUESTIONNAIRE_ATTACHMENT`
NFC chip reading	`NFC`
Video ident sessions	`VIDEO_IDENT`
Reusable KYC via SDK	`REUSABLE_KYC_SDK`
Known face search	`KNOWN_FACE_SEARCH`
AML / watchlist step	`WATCHLISTS`

如果HTTP状态码不是200，立即停止——向用户显示错误体，不要继续执行。

成功响应后，检查所需的

BackgroundCheckTarget

键是否存在于

allowedChecks

中。如果不存在，立即停止——不要构建或POST请求载荷。告知用户缺少哪个权限，以及他们需要联系客户成功经理（CSM）或Sumsub支持团队来启用该权限。

权限→功能映射（键示例）：

功能	所需权限
`E_KYC` 文档集	`E_KYC_TARGET`
`PROOF_OF_RESIDENCE` 文档集	`POA`
`E_SIGN` 文档集	`E_SIGN_TARGET`
`deviceIntelligenceSettings.enabled: true`	`DEVICE_INTELLIGENCE`
`QUESTIONNAIRE` 评分	`QUESTIONNAIRE_SCORING`
`QUESTIONNAIRE` 附件	`QUESTIONNAIRE_ATTACHMENT`
NFC芯片读取	`NFC`
视频身份验证会话	`VIDEO_IDENT`
通过SDK复用KYC	`REUSABLE_KYC_SDK`
已知人脸搜索	`KNOWN_FACE_SEARCH`
AML/观察名单步骤	`WATCHLISTS`