Overview
Sumsub is a global KYC/KYB platform – identity verification, liveness, AML monitoring across 220+ countries. The Automize Sumsub connector covers applicant creation + verification status + document upload.
- Regions: 220+ countries. Multi-language UI.
- Plans: Per-check pricing. Volume discounts.
Setting up the connection
Auth type: API Key.
- Cockpit → Account → API Keys → create token.
- In Automize → Settings → Connectors → Sumsub. Paste token + secret. Connector signs requests with HMAC.
Find your credentials at https://cockpit.sumsub.com/.
Rate limits
Per-account, ~5-20 req/sec.
Data model
Applicant-centric:
Applicant ─── Documents (ID + selfie + proof of address) ─── ReviewsAvailable operations
8 operations available. Click any row to jump to its detail.
| Operation | Category | What it does |
|---|---|---|
| Add Document | General | Upload an identity document for an applicant |
| Create Applicant | General | Create a new applicant for verification |
| Get Applicant | General | Retrieve applicant details by ID |
| Get Applicant Required Docs Status | General | Get required ID document status for an applicant |
| Get Check Result | General | Get the verification check result for an applicant |
| List Applicants | General | List all applicants with pagination |
| Request Check | General | Request a verification check for an applicant |
| Reset Applicant | General | Reset an applicant to allow re-verification |
Operations
Add Document
Upload an identity document for an applicant
| Parameter | Required | Type | Description |
|---|---|---|---|
Metadata metadata | Yes | textarea | |
Content content | Yes | textarea | |
Applicant Id applicant_id | Yes | text |
Create Applicant
Create a new applicant for verification
| Parameter | Required | Type | Description |
|---|---|---|---|
Externaluserid externalUserId | Yes | text | |
Info info | Yes | text | |
Type type | Yes | text |
Tips
- externalUserId + info (name + DOB).
- Returns applicant id used for subsequent ops.
Get Applicant
Retrieve applicant details by ID
| Parameter | Required | Type | Description |
|---|---|---|---|
Applicant Id applicant_id | Yes | text |
Get Applicant Required Docs Status
Get required ID document status for an applicant
| Parameter | Required | Type | Description |
|---|---|---|---|
Applicant Id applicant_id | Yes | text |
Tips
- Returns review status: init, pending, prechecked, queued, completed, onHold.
Get Check Result
Get the verification check result for an applicant
| Parameter | Required | Type | Description |
|---|---|---|---|
Applicant Id applicant_id | Yes | text |
List Applicants
List all applicants with pagination
No input parameters.
Request Check
Request a verification check for an applicant
| Parameter | Required | Type | Description |
|---|---|---|---|
Applicant Id applicant_id | Yes | text |
Reset Applicant
Reset an applicant to allow re-verification
| Parameter | Required | Type | Description |
|---|---|---|---|
Applicant Id applicant_id | Yes | text |
FAQ
- WebSDK vs API?
- WebSDK is the customer-facing UI. API is for backend (create applicant, upload docs server-side, get status). Most builds use both.