Uploading non-biometric document elements

Created by Archie Barnett, Modified on Thu, 19 Jun at 4:24 PM by Hannah Rowe

Non-biometric ID Document images can be uploaded 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-non-biometric-document endpoint.


This will create a new IDv entry against the Entity.


You will also need to specify a documentTypeId and documentTypeTitle for the document from the following following table:


documentTypeId
documentTypeTitle
0Other
1Birth Certificate
2Utility Statement
3Credit Card Statement
4Bank Statement
5Mortgage Statement
6Council Tax Statement
7Payslip
8HMRC Letter
9TV License
10
11
12
13
14
15
16
17


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