Uploading ID document elements | API

ID Document images can be uploaded for verification directly via the API.

To do this, you will need to pass the image as a Base64 string to the POST /api/v2/ci/entities/{entityID}/idv-entries/upload-id-document endpoint.

This will create a new IDv entry against the Entity and automatically analyse and verify the ID document.

You will also need to specify a Document Type for the document from the following list:

0 = Unknown

1 = AgentsLicense

2 = DrivingLicense

3 = ElectoralCard

4 = ForeignerIdentificationCard

5 = HealthCard

6 = JobLicense

7 = MembershipIdentificationCard

8 = MilitaryIdentificationCard

9 = NationalIdentificationCard

10 = Passport

11 = ProofOfAgeCard

12 = TravelPermit

13 = Visa

14 = WeaponsLicense

The request object should look like this:

{

  "documentType": 0,

  "base64Image": "string"

}

The analysis of the document may take several seconds, and in some cases several minutes (if the document requires manual review from a document expert).  For this reason the call is not synchronous - in other words the response with not contain the results of the document analysis.

A webhook notification will be issued once the document verification is complete, whereupon the results can be retrieved.  See the Webhooks (notifications) page for more details on this.