# Sumsub API API

> Sumsub API API on Apizie: 82 endpoints (API health, Change top-level information, Change required documents, Get required ID documents, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://www.apizie.tech/v1/finance:sumsub/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `finance:sumsub`
- Category: Finance
- Status: byok
- Source: https://sumsub.com
- Page: https://www.apizie.tech/api/finance/sumsub
- OpenAPI: https://www.apizie.tech/api/finance/sumsub/openapi.json

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,…

## Endpoints

### API health
`GET https://www.apizie.tech/v1/finance:sumsub/health-status-api-get` (byok)

### Change top-level information
`POST https://www.apizie.tech/v1/finance:sumsub/applicant-update-top-level-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Change required documents
`POST https://www.apizie.tech/v1/finance:sumsub/applicant-change-required-document-set` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| name | string | yes | A [verification level](https://docs.sumsub.com/reference) name. Case-sensitive and must be created in the same… |
| applicantId | string | yes | A unique applicant identifier. |

### Get required ID documents
`POST https://www.apizie.tech/v1/finance:sumsub/applicant-get-required-id-docs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| applicantId | string | yes | A unique applicant identifier. |

### Add ID document
`POST https://www.apizie.tech/v1/finance:sumsub/applicant-add-id-document` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-Return-Doc-Warnings | boolean | yes | `true` / `false` |
| applicantId | string | yes | A unique applicant identifier. |
| body | object | no | JSON request body |

### Change provided information
`POST https://www.apizie.tech/v1/finance:sumsub/applicant-update-fixed-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| applicantId | string | yes | A unique applicant identifier. |
| body | object | no | JSON request body |

### Change extracted information
`POST https://www.apizie.tech/v1/finance:sumsub/applicant-change-extracted-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| applicantId | string | yes | A unique applicant identifier. |
| body | object | no | JSON request body |

### Import applicants
`POST https://www.apizie.tech/v1/finance:sumsub/applicant-import-completed` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| levelName | string | yes | A [verification level](https://docs.sumsub.com/reference) name. Case-sensitive and must be created in the same… |
| body | object | no | JSON request body |

### Import applicant with images by archive
`POST https://www.apizie.tech/v1/finance:sumsub/applicant-import-by-archive` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Set review for applicant in sandbox
`POST https://www.apizie.tech/v1/finance:sumsub/applicant-sandbox-verification-response` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| applicantId | string | yes | A unique applicant identifier. |
| body | object | no | JSON request body |

### Add custom applicant tags
`POST https://www.apizie.tech/v1/finance:sumsub/applicant-add-custom-tags` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| applicantId | string | yes | A unique applicant identifier. |
| body | object | no | JSON request body |

### Add and overwrite custom applicant tags
`POST https://www.apizie.tech/v1/finance:sumsub/applicant-add-custom-tags-2` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| applicantId | string | yes | A unique applicant identifier. |
| body | object | no | JSON request body |

### Remove custom applicant tags
`POST https://www.apizie.tech/v1/finance:sumsub/applicant-remove-custom-tags` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| applicantId | string | yes | A unique applicant identifier. |
| body | object | no | JSON request body |

### Request applicant check
`POST https://www.apizie.tech/v1/finance:sumsub/applicant-initiate-applicant-check` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| reason | string | yes | A note indicating the reason for checking the applicant profile. |
| applicantId | string | yes | A unique applicant identifier. |

### Add applicant to blocklist
`POST https://www.apizie.tech/v1/finance:sumsub/applicant-add-to-blocklist` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| note | string | yes | A note indicating the reason for blocklisting the applicant profile. |
| applicantId | string | yes | A unique applicant identifier. |

### Reset applicant profile
`POST https://www.apizie.tech/v1/finance:sumsub/applicant-reset-profile` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| applicantId | string | yes | A unique applicant identifier. |

### Reset verification step
`POST https://www.apizie.tech/v1/finance:sumsub/applicant-reset-verification-step` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| applicantId | string | yes | A unique applicant identifier. |
| idDocSetType | string | yes | A [step name](ref:reset-single-verification-step#available-steps-to-reset) to reset. |

### Get document images
`GET https://www.apizie.tech/v1/finance:sumsub/image-get-document-images` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| inspectionId | string | yes | An inspection identifier. This identifier is returned as a root field upon running [this API method](ref:get-applicant-data). |
| imageId | string | yes | An image identifier. You can get this number by using [this API method](ref:get-applicant-verification-steps-status). |

### Mark image as inactive
`POST https://www.apizie.tech/v1/finance:sumsub/image-mark-as-inactive` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| revert | boolean | no | Set `true` to revert inactivity of the image. |
| inspectionId | string | yes | An inspection identifier. You can get this number by using [this API method](ref:get-applicant-data). |
| imageId | string | yes | An image identifier. You can get this number by using [this API method](ref:get-applicant-verification-steps-status). |

### Deactivate applicant profile
`POST https://www.apizie.tech/v1/finance:sumsub/applicant-deactivate-profile` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| applicantId | string | yes | A unique applicant identifier. |
| status | string | yes | Possible values: `deactivated` to deactivate the applicant profile. `activated` to reactivate the applicant profile. |

### Add applicant consent
`POST https://www.apizie.tech/v1/finance:sumsub/applicant-add-consent-to-profile` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| applicantId | string | yes | A unique identifier of an applicant profile to which a consent should be added. |
| body | object | no | JSON request body |

### Get applicant data
`GET https://www.apizie.tech/v1/finance:sumsub/applicant-get-data` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| applicantId | string | yes | A unique applicant identifier |

### Get applicant data (externalUserId)
`GET https://www.apizie.tech/v1/finance:sumsub/applicant-get-data-by-external-user-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| externalUserId | string | yes | A unique applicant identifier in your system. |

### Get applicant review status
`GET https://www.apizie.tech/v1/finance:sumsub/applicant-get-review-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| applicantId | string | yes | A unique applicant identifier. |

### Get applicant verification steps status
`GET https://www.apizie.tech/v1/finance:sumsub/applicant-get-verification-steps-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| applicantId | string | yes | A unique applicant identifier. |

### Clarify rejection reason
`GET https://www.apizie.tech/v1/finance:sumsub/applicant-clarify-rejection-reason` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| applicantId | string | yes | A unique applicant identifier. |

### Get TIN (SSN) check results
`GET https://www.apizie.tech/v1/finance:sumsub/check-tin-ssn-check-results` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| applicantId | string | yes | A unique applicant identification number. |

### Get email confirmation check results
`GET https://www.apizie.tech/v1/finance:sumsub/check-email-confirmation-results` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| applicantId | string | yes | A unique applicant identifier. |

### Get phone confirmation check results
`GET https://www.apizie.tech/v1/finance:sumsub/check-phone-confirmation-results` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| applicantId | string | yes | A unique applicant identifier. |

### Get IP check results
`GET https://www.apizie.tech/v1/finance:sumsub/check-ip-check-results` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| applicantId | string | yes | A unique applicant identifier. |

### Get applicant fraud networks
`GET https://www.apizie.tech/v1/finance:sumsub/applicant-get-fraud-networks-by-applicant` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| applicantId | string | yes | A unique applicant identifier. |

### Get fraud network by ID
`GET https://www.apizie.tech/v1/finance:sumsub/applicant-get-fraud-network-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| networkId | string | yes | A unique network identifier. |

### Get video call data
`GET https://www.apizie.tech/v1/finance:sumsub/inspection-get-video-ident-data` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| inspectionId | string | yes | A unique inspection identifier. |

### Get video call media
`GET https://www.apizie.tech/v1/finance:sumsub/applicant-get-video-call-media` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| applicantId | string | yes | A unique applicant identifier. |
| compositionMediaId | string | yes | Video call media identifier. |

### Generate external WebSDK link
`POST https://www.apizie.tech/v1/finance:sumsub/web-sdk-link-generate-external` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ttlInSecs | integer | no | A lifespan of the link in seconds. |
| externalUserId | string | no | An external user ID on your side. |
| lang | string | no | The language for WebSDK in ISO 639-1 format. |
| levelName | string | yes | A [verification level](https://docs.sumsub.com/reference) name. Case-sensitive and has to be created in the same environment. If contains… |

### Get available applicant levels
`GET https://www.apizie.tech/v1/finance:sumsub/applicant-get-levels` (byok)

### Get additional PoA data
`GET https://www.apizie.tech/v1/finance:sumsub/check-additional-poa-data` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| applicantId | string | yes | A unique applicant identifier. |

### Generate access token
`POST https://www.apizie.tech/v1/finance:sumsub/token-create-action-token` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ttlInSecs | string | no | A lifespan of a token in seconds. Default value is 10 mins. |
| userId | string | yes | An external user ID which will be bound to the token. |
| externalActionId | string | yes | An external action ID which will be bound to the token. |
| levelName | string | yes | The name of the [verification level](https://docs.sumsub.com/reference). |

### Get applicant actions
`GET https://www.apizie.tech/v1/finance:sumsub/applicant-get-actions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| limit | integer | no | Limit of applicant actions to be returned. |
| offset | integer | no | Offset of applicant actions to be returned. |
| applicantId | string | yes | A unique applicant identifier. |

### Get action information
`GET https://www.apizie.tech/v1/finance:sumsub/applicant-get-action-one-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| actionId | string | yes | A unique applicant action identifier. |

### Create applicant action
`POST https://www.apizie.tech/v1/finance:sumsub/applicant-create-action` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| applicantId | string | yes | A unique aplicant identifier. |
| levelName | string | yes | A name of the level configured in the dashboard. |
| body | object | no | JSON request body |

### Create payment source actions
`POST https://www.apizie.tech/v1/finance:sumsub/applicant-create-payment-source-actions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| applicantId | string | yes | An unique applicant identifier. |
| levelName | string | yes | A verification level name for which you want to create a payment source action. |
| body | object | no | JSON request body |

### Request action check
`POST https://www.apizie.tech/v1/finance:sumsub/applicant-request-action-check` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| actionId | string | yes | A unique applicant action identifier. |

### Submit payment method
`POST https://www.apizie.tech/v1/finance:sumsub/applicant-submit-payment-method` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-External-Action-Id | string | yes | Use `externalActionId` if you intend to [initialize SDK](ref:about-applicant-actions) for that particular action. |
| requireSelfie | boolean | no | Sets the video selfie at `requiredIdDocs` for the action. |
| applicantId | string | yes | A unique applicant identifier. |

### Add payment method information
`POST https://www.apizie.tech/v1/finance:sumsub/applicant-add-payment-method-information` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| actionId | string | yes | A unique applicant action identifier. |
| body | object | no | JSON request body |

### Get bank card image
`GET https://www.apizie.tech/v1/finance:sumsub/applicant-get-bank-card-image` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| isPreview | boolean | yes | Indicates if an image thumbnail should be returned. |
| actionId | string | yes | A unique applicant action identifier. |
| imageId | string | yes | An image identifier taken from `images[].imageId`. |

### Add image to payment method
`POST https://www.apizie.tech/v1/finance:sumsub/applicant-add-image-to-payment-method` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| actionId | string | yes | A unique applicant action identifier. |
| body | object | no | JSON request body |

### Submission
`POST https://www.apizie.tech/v1/finance:sumsub/applicant-create-crypto-source-of-funds` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| applicantId | string | yes | A unique applicant identifier. |
| body | object | no | JSON request body |

### Standalone crypto analysis
`POST https://www.apizie.tech/v1/finance:sumsub/analysis-standalone-crypto-initiation` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Get available tokens
`GET https://www.apizie.tech/v1/finance:sumsub/token-get-available-currencies` (byok)

### Add applicant as beneficiary
`POST https://www.apizie.tech/v1/finance:sumsub/applicant-add-beneficiary` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| applicantId | string | yes | A unique company applicant identifier. |
| body | object | no | JSON request body |

### Remove applicant from beneficiary list
`POST https://www.apizie.tech/v1/finance:sumsub/applicant-remove-from-beneficiary-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| applicantId | string | yes | A unique company applicant identifier. |
| beneficiaryApplicantId | string | yes | Beneficiary applicant identifier. |

### Change company data
`POST https://www.apizie.tech/v1/finance:sumsub/applicant-change-company-data` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| applicantId | string | yes | A unique applicant identifier. |
| body | object | no | JSON request body |

### Get additional company check data
`GET https://www.apizie.tech/v1/finance:sumsub/check-additional-company-data` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| applicantId | string | yes | A unique applicant identifier. |

### Submit applicant data for non-doc verification
`POST https://www.apizie.tech/v1/finance:sumsub/verification-submit-applicant-data` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| applicantId | string | yes | A unique applicant identifier. |
| body | object | no | JSON request body |

### Confirm applicant data for non-doc verification
`POST https://www.apizie.tech/v1/finance:sumsub/applicant-confirm-data` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| applicantId | string | yes | A unique applicant identifier. |
| confirmationId | string | yes | A confirmation identifier from the [submission](ref:submit-applicant-data) response. |
| confirmationid | string | yes | Path parameter {confirmationid} |
| body | object | no | JSON request body |

### Get non-doc verification applicant data
`GET https://www.apizie.tech/v1/finance:sumsub/applicant-get-data-latest` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| type | string | yes | Check type. |
| applicantId | string | yes | A unique applicant identifier. |

### Submit transaction for existing applicant
`POST https://www.apizie.tech/v1/finance:sumsub/applicant-submit-transaction-data` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| applicantId | string | yes | A unique identification number of the applicant who passed user verification (KYC). If you do no have such an applicant, use [Submit… |
| body | object | no | JSON request body |

### Submit transaction for non-existing applicant
`POST https://www.apizie.tech/v1/finance:sumsub/applicant-submit-transaction-for-non-existing` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| levelName | string | yes | A [verification level](https://docs.sumsub.com/reference) name. Case-sensitive and has to be created in the same environment. If contains… |
| body | object | no | JSON request body |

### Get transaction information
`GET https://www.apizie.tech/v1/finance:sumsub/transaction-information-one` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | A unique transaction identifier. |

### Get transaction information (externalTxnId)
`GET https://www.apizie.tech/v1/finance:sumsub/transaction-get-one-data` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| externalTxnId | string | yes | A unique transaction identifier on your side. |

### Bulk transaction import
`POST https://www.apizie.tech/v1/finance:sumsub/transaction-bulk-import` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ignoreErrors | boolean | no | true — all valid transactions will be created and returned, errors will be ignored during the processing and listed in the response. false… |
| scoreSavedTxns | boolean | no | Allows you to control whether scoring should be run on imported transactions or not: true (default) — start scoring after import. false —… |
| body | object | no | JSON request body |

### Change transaction properties
`POST https://www.apizie.tech/v1/finance:sumsub/transaction-update-properties` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| unsetKeys | string | no | A list of property names separated by commas that should be set to `null`. |
| id | string | yes | A unique transaction identification number. |
| body | object | no | JSON request body |

### Re-score transaction
`POST https://www.apizie.tech/v1/finance:sumsub/transaction-re-score` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | A unique transaction identification number. |

### Approve and reject transaction
`POST https://www.apizie.tech/v1/finance:sumsub/transaction-approve-reject` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | A unique transaction identification number. |
| body | object | no | JSON request body |

### Get tags
`GET https://www.apizie.tech/v1/finance:sumsub/transaction-list-tags` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | A unique transaction identifier. |

### Add tags
`POST https://www.apizie.tech/v1/finance:sumsub/tag-add-transaction-tags` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | A unique transaction identifier. |
| body | object | no | JSON request body |

### Remove tags
`POST https://www.apizie.tech/v1/finance:sumsub/transaction-remove-tags` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | A unique transaction identifier. |
| body | object | no | JSON request body |

### Get notes
`GET https://www.apizie.tech/v1/finance:sumsub/note-get-transaction-notes` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | A unique transaction identifier. |

### Add notes
`POST https://www.apizie.tech/v1/finance:sumsub/note-add-to-transaction` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Edit notes
`POST https://www.apizie.tech/v1/finance:sumsub/note-update-transaction-notes` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Remove notes
`POST https://www.apizie.tech/v1/finance:sumsub/note-remove-from-transaction` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Patch transaction with chain transaction ID
`POST https://www.apizie.tech/v1/finance:sumsub/transaction-update-blockchain-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| txnId | string | yes | A unique transaction identifier. |
| body | object | no | JSON request body |

### Move transaction to another applicant
`POST https://www.apizie.tech/v1/finance:sumsub/applicant-move-transaction-to-another-applicant` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| txnId | string | yes | A unique transaction identifier. |
| applicantId | string | yes | A unique applicant identifier who should own the transaction. |

### Enriching transaction with Travel Rule
`POST https://www.apizie.tech/v1/finance:sumsub/applicant-enrich-transaction-with-travel-rule-data` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| txnId | string | yes | A unique transaction identifier. |
| body | object | no | JSON request body |

### Confirm transaction ownership
`POST https://www.apizie.tech/v1/finance:sumsub/transaction-confirm-ownership` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| txnId | string | yes | A unique transaction identifier. |

### Remove transaction ownership
`POST https://www.apizie.tech/v1/finance:sumsub/transaction-remove-ownership` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| txnId | string | yes | A unique transaction identifier. |

### Get available VASPs
`GET https://www.apizie.tech/v1/finance:sumsub/vasp-get-available-vasps` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| limit | integer | no | Maximum number of the VASPs to be returned. The maximum recommended value you can set is 100. |
| offset | integer | no | Offset of the VASPs to be returned. |

### Generate access token
`POST https://www.apizie.tech/v1/finance:sumsub/access-token-generate-fisherman-token` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Confirm applicant platform event
`POST https://www.apizie.tech/v1/finance:sumsub/access-token-confirm-platform-event` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| accessToken | string | yes | Access token that you have [received at the first step](ref:generate-access-token-fisherman) of the flow. |
| body | object | no | JSON request body |

### Audit trail events
`GET https://www.apizie.tech/v1/finance:sumsub/audit-trail-event-get-events` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subjectName | string | no | The name of the subject for which events are received. If the name is not specified, the events are received for all subjects on the key. |
| activity | string | no | If specified, only the events with this activity will be in the response. |
| from | string | no | Date/time events are received from (`yyyy-MM-dd HH:mm:ss`, e.g. 2022-10-01 12:05:00). If not specified, the events are received from the… |
| to | string | no | To the date/time events are received (`yyyy-MM-dd HH:mm:ss`, e.g. 2022-10-01 12:15:00). If not specified, the events are received up to… |
| limit | string | no | The maximum number of events per request. Cannot be more than 20000. By default is 10. |
| offset | string | no | Allows to skip the offset events before beginning to return the events. By default is 0. |

### Get fraud networks
`GET https://www.apizie.tech/v1/finance:sumsub/applicant-get-fraud-networks` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| offset | integer | no | Offset of the found networks to be returned. |
| limit | integer | no | Maximum number of the found networks to be returned. The maximum value you can set is 100. |

## Example
```
curl "https://www.apizie.tech/v1/finance:sumsub/health-status-api-get" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Sumsub API API?
Create a free Apizie key, then send GET https://www.apizie.tech/v1/finance:sumsub/health-status-api-get with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Sumsub API API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Sumsub API itself also needs your own key from api.sumsub.com.

### Can AI agents use the Sumsub API API?
Yes. Add the Apizie MCP server (https://www.apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key finance:sumsub.

### What is the status of the Sumsub API API?
Needs your own provider key (bring your own key)