canonical: https://jentic.com/apis/sumsub.com/sumsub

# Sumsub API

Sumsub is the one verification platform to secure the whole user journey. With Sumsub's customizable KYC, KYB, transaction monitoring and fraud prevention solutions, you can orchestrate your verification process, welcome more customers worldwide, meet compliance requirements, reduce costs and protect your business. Sumsub has over 2,000 clients in fintech, crypto, transportation, trading, e-commer. The API exposes 82 endpoints secured with apiKey authentication.

## For AI agents

Programmatically API health, change top-level information. Covers 82 operations with apiKey authentication.

## Scope

Does not handle communications, crm, or developer tools - use for payments only.

## Capabilities

- API health
- Change top-level information
- Get required ID documents
- Add ID document
- Monitor Sumsub API operational status and events

## Use cases

### Payments Operations

Use the Sumsub API to perform payments operations programmatically. The API provides 82 endpoints covering core functionality including API health, change top-level information, change required documents.

Example prompt: Call GET /resources/status/api to API health

### Automated Applicant Management

Automate applicant operations by combining multiple Sumsub API endpoints. Agents can change top-level information and then change required documents in a single workflow.

Example prompt: Call PATCH /resources/applicants to change top-level information, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call Sumsub API endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read API documentation or handle apiKey tokens manually.

Example prompt: Search Jentic for 'API health', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | /resources/status/api | API health |
| PATCH | /resources/applicants | Change top-level information |
| POST | /resources/applicants/{applicantId}/moveToLevel | Change required documents |
| POST | /resources/applicants/{applicantId}/requiredIdDocs | Get required ID documents |
| POST | /resources/applicants/{applicantId}/info/idDoc | Add ID document |
| PATCH | /resources/applicants/{applicantId}/fixedInfo | Change provided information |
| PATCH | /resources/applicants/{applicantId}/info | Change extracted information |
| POST | /resources/applicants/-/ingestCompleted?levelName={levelName} | Import applicants |

## Key resources

- **Applicant** — Operations related to Applicant
- **Transaction** — Operations related to Transaction
- **Check** — Operations related to Check
- **Note** — Operations related to Note
- **AccessToken** — Operations related to AccessToken

## Why Jentic

- **Setup:** Wiring the Sumsub API by hand means signing requests with your X-App-Token and managing applicant records across a large verification surface yourself. Through Jentic you install once, import the Sumsub API from the API Directory, store the token once, and your agent calls it.
- **Permission scoping:** Sumsub puts the applicant id in the URL path (/resources/applicants/{applicantId}/...), so a rule can pin your agent to one applicant: it can read and update that applicant and nothing else. You choose the operations it may call, so actions like moving an applicant to another level are not included unless you add them.
- **Credential handling:** Your Sumsub app token is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'check API status' or 'update applicant info', and Jentic returns the matching Sumsub operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Stripe** — Alternative payments API
- **Adyen** — Alternative payments API
- **Square** — Complementary payments API
- **Paypal** — Complementary payments API

## FAQ

### What authentication does the Sumsub API use?

The Sumsub API uses an API key passed in the `X-App-Token` header. Through Jentic, these credentials are stored encrypted in your Jentic One instance and injected at execution time, so raw secrets never enter the agent context.

### Can I API health with the Sumsub API?

Yes. Use the GET /resources/status/api endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the Sumsub API?

Rate limits are not specified in the OpenAPI spec. Check the vendor documentation for current limits. Through Jentic, rate limiting is handled automatically with retry logic built into the execution layer.

### How do I API health through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'API health'. Jentic returns the matching Sumsub API operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

### How many endpoints does the Sumsub API have?

The Sumsub API exposes 82 endpoints covering applicant, transaction, check operations.

### Can I limit what my agent is allowed to do with the Sumsub API?

Yes. Because you self-host Jentic One, your own rules decide which Sumsub operations and credentials your agent may use. Since Sumsub puts the applicant id in the URL path, such as /resources/applicants/{applicantId}/requiredIdDocs, you can pin the agent to a single applicant so it only reads and updates that one record. You also choose the exact operations it may call, so sensitive actions like moving an applicant to another level stay out of reach unless you explicitly allow them.