Perform Document Check
Overview of flow
1. Create a client
The first step in creating any check is to create a client from your backend server. A client can be a person or a company. For a person, you must provide their first name and last name. Only the name is required for a company.
Example request for creating a client
Example response
The response will contain an id (the Client ID). It is required for the next step.
2. Create a document
Create a document by providing the Client ID and document type (e.g. passport, national ID).
Example request for creating a document
Example response
The response will contain an id (the Document ID). It is required for the next step.
3. Upload front side image of an ID
Upload a BASE64 encoded image of the front-side of the ID document. Depending on the type and country combination, both sides of the ID may be required.
Images should be JPG, PNG, or PDF and between 34 KB and 4 MB in size.
Below is a sample BASE64encoded file. Download it, and copy its content. Then paste into the data attribute when making the request.
Example request for uploading the front-side image of a document
Example response
The response will contain an id (the Check ID). It is required for the next step.
4. Create a check
Create a check by providing the Client ID, Document ID and check type.
Example request for creating a check
Example response
The response will contain an id (the Check ID). It is required for the next step.
5. Retrieve outcome
ComplyCube will perform the check. You can retrieve a check's outcome and breakdown via the API.
If you have set up webhooks, a notification is sent upon completion of the check.
Example request for retrieving the check outcome
Example response
Last updated
Was this helpful?