API Reference
The details of API endpoints for document recognition.
Recognition with JSON response
POST
https://api.app.authenteq.com/recognition/as-json
This endpoint allows you to perform document recognition and get the result in JSON response.
Headers
Authorization
string
Your client credentials combined with a colon separator, base64-encoded and prefixed with "Basic ".
Content-Type
string
Always multipart/form-data
.
Request Body
frontImage
object
The front side document image.
backImage
object
The back side document image.
{
"documentType": "NID",
"documentNumber": "1234567890",
"issuingCountry": "USA",
"jurisdiction": "UT",
"nationality": "USA",
"surnameAndGivenNames": "JOHN DOE",
"surname": "DOE",
"givenNames": "JOHN",
"namePrefixes": "MR",
"nameSuffixes": "JR",
"sex": "M",
"dateOfBirth": "1964-12-30",
"dateOfIssue": "2012-12-30",
"dateOfExpiry": "2022-12-30",
"address": "430-985 ELEIFEND^DULUTH WA 92611",
"croppedFrontImage": {
"contentType": "image/jpeg",
"content": "Y3JvcHBlZEZyb250SW1hZ2U="
},
"croppedBackImage": {
"contentType": "image/jpeg",
"content": "Y3JvcHBlZEJhY2tJbWFnZQ=="
},
"faceImage": {
"contentType": "image/jpeg",
"content": "ZmFjZUltYWdlCg=="
}
}
Recognition with multipart response
POST
https://api.app.authenteq.com/recognition/as-multipart
This endpoint allows you to perform document recognition and get the result in multipart response.
Headers
Authentication
string
Your client credentials combined with a colon separator, base64-encoded and prefixed with "Basic ".
Content-Type
string
Always multipart/form-data
.
Request Body
frontImage
object
The front side document image.
backImage
object
The back side document image.
Content-Type: multipart/mixed;boundary=S1SPHauV7jaDgqMljnwfF-gQ2I1AcxAYrwgCt
--S1SPHauV7jaDgqMljnwfF-gQ2I1AcxAYrwgCt
Content-Disposition: form-data; name="documentData"
Content-Type: application/json
{
"documentType": "NID",
"documentNumber": "1234567890",
"issuingCountry": "USA",
"jurisdiction": "UT",
"nationality": "USA",
"surnameAndGivenNames": "JOHN DOE",
"surname": "DOE",
"givenNames": "JOHN",
"namePrefixes": "MR",
"nameSuffixes": "JR",
"sex": "M",
"dateOfBirth": "1964-12-30",
"dateOfIssue": "2012-12-30",
"dateOfExpiry": "2022-12-30",
"address": "430-985 ELEIFEND^DULUTH WA 92611"
}
--S1SPHauV7jaDgqMljnwfF-gQ2I1AcxAYrwgCt
Content-Disposition: form-data; name="croppedFrontImage"
Content-Type: image/jpeg
--S1SPHauV7jaDgqMljnwfF-gQ2I1AcxAYrwgCt
Content-Disposition: form-data; name="croppedBackImage"
Content-Type: image/jpeg
--S1SPHauV7jaDgqMljnwfF-gQ2I1AcxAYrwgCt
Content-Disposition: form-data; name="faceImage"
Content-Type: image/jpeg
--S1SPHauV7jaDgqMljnwfF-gQ2I1AcxAYrwgCt--
Last updated
Was this helpful?