Uploading ID document elements | API

Created by Kevin Smith, Modified on Fri, 16 Aug, 2024 at 12:40 PM by Hannah Rowe


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.



Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select at least one of the reasons
CAPTCHA verification is required.

Feedback sent

We appreciate your effort and will try to fix the article

Join our live training sessions

Whether you're new to Credas or simply looking for a refresher, we’ve got you covered! We now offer regular training sessions designed to help you get the most out of the Credas platform. These sessions are tailored to different product areas, including:

- AML / ID verification
- Right to Work
- Our brand-new Credas Lettings solution
- Admin / advanced training

In each session we will walk you through how platform works and answer any questions you may have.

See our full training schedule