Uploading non-biometric document elements

Modified on Thu, 19 Jun at 4:24 PM

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
0	Other
1	Birth Certificate
2	Utility Statement
3	Credit Card Statement
4	Bank Statement
5	Mortgage Statement
6	Council Tax Statement
7	Payslip
8	HMRC Letter
9	TV 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.