API Reference
The details of API endpoints for Web IDV.
get
https://api.app.authenteq.com
/web-idv/verification-url
Request Identity Verification
This endpoint should be called by your backend system.
The client secret, as its name suggests, is a secret and should never be made publicly available. It SHOULD NOT be stored in the frontend code that is run in the user's browser.
get
https://api.app.authenteq.com
/web-idv/verification-result
Get Verification Result Details
This endpoint should be called by your backend system.
The client secret, as its name suggests, is a secret and should never be made publicly available. It SHOULD NOT be stored in the frontend code that is run in the user's browser.
The code can be used once only. On subsequent requests you will get an error that the code is invalid or expired.
The successful response on getting the verification result can hold the following properties:
Property | Description | Mandatory | Example |
id | The unique id of the identity verification. | Yes | "c72322ac-23fc-4667-b23b-f8a1a50653d4" |
platform | The client platform on which the identity verirication was started. Actually it's always WEB . | Yes | "WEB" |
startTime | The date-time when the identity verification was started. | Yes | "2020-04-10T11:44:40Z" |
endTime | The date-time when the identity verification was finished. | Yes | "2020-04-10T11:47:23Z" |
livenessFaceImage | The face image taken on the liveness check. | Yes | { "contentType": "image/jpeg", "content": "bGl2ZW5lc3NGYWNlSW1hZ2UK" } |
documentData | The document data extracted from the first scanned document. | Yes | Described below. |
documentData2 | The document data extracted from the second scanned document in case of the multi-document flow. | No | Described below. |
documentData3 | The document data extracted from the third scanned document in case of the multi-document flow. | No | Described below. |
nfcVerified | Whether at least one of the scanned documents was verified via NFC. | Yes | true or false |
addressProofDocument | The address proof document provided by the user. | No | { "contentType": "application/pdf"
, "content": "YWRkcmVzc1Byb29mRG9jdW1lbnQK" } |
Each document data field can hold the following properties:
Property | Description | Mandatory | Example |
documentType | The document type described by abbreviations:
| Yes | "PP", "DL", "NID" |
documentNumber | The document number. | Yes | "FG617451", "8136431812" |
issuingCountry | The three letter country code in ISO 3166-1 alpha-3 format of the country which issued the document. | Yes | "DEU", "UKR", "USA" |
jurisdiction | The state issued the document. | No | "FL" |
nationality | No | "DEU", "UKR", "USA" | |
surnameAndGivenNames | The surname and given names, separated by whitespace. | Yes | "GARCIA DILS ANNA MARIA DE O", "GOZHENKO VITALII" |
surname | The surname (family name). | No | "GARCIA DILS", "GOZHENKO" |
givenNames | The given names, separated by whitespace. | No | "ANNA MARIA DE O", "VITALII" |
nameSuffixes | The name suffixes, separated by whitespace. | No | "JR 3RD", "8TH" |
namePrefixes | The name prefixes, separated by whitespace. | No | "DR MRS", "DR" |
sex | The user's gender that contains one of values:
| No | "F", "M", "X" |
dateOfBirth | The date of user's birth. | Yes | "1987-01-12" |
dateOfExpiry | The date of document expiration. | No | "2017-01-30" |
dateOfIssue | The date when the document was issued. | No | "2017-01-30" |
address | The user's address. | No | "430-985 ELEIFEND^DULUTH WA 92611" |
licenseClass | The type of Driving License detected. | No | "A","B","C" |
licenseClassDetails | The details of Driver License detected. | No | { "A" : { "from": "2019-01-30", "to": "2029-01-30", "note": "Some valuable note" } } |
Not all documents contain surname and given names as separate fields. Quite often there is just a single field where surname and given names follow each other. So surname and givenNames fields exist in the retrieved document data only when they exist in the user document as separate ones.
All binary data like content of images, attached documents and so on are returned in base64 format and will need to be decoded.
Last modified 1mo ago