Overview

Use this method to check the operational status of the API.

👍
Tip
You can also check our uptime history and the current service status on the Sumsub Status page.

Errors

On API errors, we return standard HTTP status codes.

📘
Note

We have a limit for the API requests that you can send. If there are too many requests from you, we will return a status code 429. Notify our team if you have to make a vast amount of requests during a particular time frame.

If you still don't understand what the issue is, contact us with the correlationId provided.

The response body contains a JSON payload with additional information.

{
  "description": "Error analyzing file, unsupported format or corrupted file",
  "code": 400,
  "correlationId": "req-5fd59b09-7f5e-41cd-a86b-38a4e6d57e08",
  "errorCode": 1004, // may be absent
  "errorName": "corrupted-file" // may be absent
}

Name	Type	Optional	Description
`description`	String	No	Error description.
`code`	Integer	No	HTTP status code.
`correlationId`	String	No	Identifies the error. You can send this ID to us, if the cause of the problem is still unclear.
`errorCode`	Integer	Yes	Error code. May not be present for some errors.
`errorName`	String	Yes	String representation of the error. Displayed when `errorCode` is present.

Error codes

📘
Note
Not all error responses will contain error code and name. More and more errors will get their codes in the future.

Code	Name	Description
1000	`duplicate-document`	Duplicate document (image, video) was uploaded. Exact equality is taken into account.
1001	`too-many-documents`	Applicant contains too many documents. Adding new is not allowed.
1002	`file-too-big`	Uploaded file is too big (more than 64MB).
1003	`empty-file`	Uploaded file is empty (0 bytes).
1004	`corrupted-file`	File is corrupted or of incorrect format (e.g. PDF file is uploaded as JPEG).
1005	`unsupported-file-format`	Unsupported file format (e.g. a TIFF image).
1006	`no-upload-verification-in-progress`	Applicant is being checked. Adding new data is not allowed.
1007	`incorrect-file-size`	The file size must meet the file upload requirements specified in the global settings.
1008	`applicant-marked-as-deleted`	Applicant is marked as deleted/inactive. No action is allowed to change the status.
1009	`applicant-with-final-reject`	Applicant is rejected with the `FINAL` rejection type. Adding new data/files is not allowed.
1010	`doc-type-not-in-req-docs`	Attempt to upload the document outside of the applicant level set/set of required documents.
3000	`applicant-is-already-in-the-state`	Attempt to change the status of the applicant against the logic — the applicant is already in the required state.
4000	`app-token-invalid-format`	Invalid format of the `X-App-Token` value.
4001	`app-token-not-found`	App token does not exist (e.g. test env. token used on production).
4002	`app-token-private-part-mismatch`	Private part of the token (after dot) does not match public part.
4003	`app-token-signature mismatch`	Signature encoded value does not match the request content.
4004	`app-token-request-expired`	`X-App-Access-Ts` does not match the number of seconds since Unix Epoch in UTC.
4005	`app-token-invalid-value`	Invalid authentication header values were provided.
4006	`app-token-not-all-auth-params-provided`	Not all required authorization headers were provided.
4007	`app-token-invalid-params`	Invalid authentication parameters were provided.
5000	`applicant-already-blacklisted`	Attempt to blocklist the applicant that is already blocklisted.
5001	`applicant-already-whitelisted`	Attempt to whitelist the applicant that is already whitelisted.