Documentation
  • Introduction
  • Quick Start
  • Reference
    • API Reference
      • Documents OCR
      • Face Matching & Liveness
      • AML & blacklisting
      • Transliteration
      • Error Codes
      • OTP
Powered by GitBook
On this page
  1. Reference
  2. API Reference

Error Codes

Each API call should return response code, there are 2 types of responses in Vlens APIs, HTTP responses and Vlens error codes, below table is showing both.

Code
Description
Message
Type

400

Bad Request - invalid request received (e.g. missing Bundle key, required parameters or invalid json)

Make sure all the required parameters are included.

HTTP

401

Invalid API Key

Make sure you are using the correct credentials and try again.

HTTP

403

Invalid Bundle Key

Generate and include a valid access token and try again.

HTTP

415

Unsupported Media Type

Please re-check your image format.

HTTP

422

Unprocessable Entity

Check the custom error code returned in the response, and refer to the Vlens Error Codes table for more information.

HTTP

400

Base64 Encoding Error

Please provide a valid base64 encoded image.

HTTP

500

Internal Server Error

Well-formed request received, but an unexpected error has occurred. Try again later.

HTTP

3001

Document Validation Error "Invalid ID number"

Error, Please make sure the document is in a good lighting condition and well focused.

Vlens

3002

Document Validation Error "Invalid BirthDate"

Error, Please make sure the document is in a good lighting condition and well focused.

Vlens

3003

Document Validation Error "Invalid Govern"

Error, Please make sure the document is in a good lighting condition and well focused.

Vlens

3004

Document Validation Error "Invalid ID_Key"

Error, Please make sure the document is in a good lighting condition and well focused.

Vlens

3005

Document Validation Error "Invalid Gender"

Error, Please make sure the document is in a good lighting condition and well focused.

Vlens

3006

Document Validation Error "Invalid releaseDate"

Error, Please make sure the document is in a good lighting condition and well focused.

Vlens

3007

Wrong date format(BirthDate)

Make sure dates in the ID are in correct format

Vlens

3008

Wrong date format(releaseDate)

Make sure dates in the ID are in correct format

Vlens

3009

Wrong date format(ExpiryDate)

Make sure dates in the ID are in correct format

Vlens

3010

Document Expired

Make sure the expiry date of the submitted document has not passed.

Vlens

3011

card not detected from image

Error, Please make sure the document is in a good lighting condition and well focused.

Vlens

3013

Invalid MRZ

Error, Please make sure the document is in a good lighting condition and well focused.

Vlens

3101

ID number mismatch

ID number in ID front and back documents are not matched

Vlens

3102

Name mismatch

Name in ID front and car license documents are not matched

Vlens

4001

Invalid Bundle Key

Please re-enter your bundle key correctly.

Vlens

4002

Insufficient Quota

Please recharge your bundle and try again.

Vlens

4003

Exceeded number of trials

Number of trials exceeded the limit. Try again later.

Vlens

4004

Unregistered Service

Make sure the service being called is registered in your bundle.

Vlens

4005

Disabled Bundle

The bundle has been disabled, please contact the server admin for re-activation.

Vlens

4006

Not Subscribed

You are not subscribed to any bundle

Vlens

4007

Subscription Expired

Your subscription is expired, please renew your subscription

Vlens

4206

Face Match Error

Please make sure to have only one face in the image.

Vlens

4207

Face Match Error

No Face detected

Vlens

4208

Couldn't Extract Facial Features

Please make sure that there is a face in the image.

Vlens

4209

Face not matching

Please recapture your face and ensure the capture is clear.

Vlens

4210

Face is not Live

Please recapture your face and ensure the capture is clear.

Vlens

5000

General Error

Something went wrong, please contact support

Vlens

5001

Unsupported Document

Please enter a supported document.

Vlens

5002

Maximum image size exceeded.

Make sure each provided image does not exceed the 5MB limit.

Vlens

5003

Maximum image resolution exceeded.

Make sure each provided image does not exceed the 25 Million pixel limit.

Vlens

5004

Transaction not Found

Check the Transaction ID/token sent in the request.

Vlens

5005

spoofed doc

please make sure you're capturing a real document

Vlens

5006

Blurred image

Please recapture image and make sure it is focused

Vlens

5007

Invalid classification

Document is supported but wrong end point was called

Vlens

5008

Data Misassigned

There was an issue assigning data to the correct fields.

Vlens

3014

ID Face Not Detected

The system could not detect a face in the ID image.

Vlens

7000

Multiple Cards General Error

A general error occurred while processing multiple cards.

Vlens

7001

ID Front Card General Error

A general error occurred while processing the front side of the ID card.

Vlens

7002

ID Back Card General Error

A general error occurred while processing the back side of the ID card.

Vlens

7003

Car License Back Card General Error

A general error occurred while processing the back side of the car license.

Vlens

7004

Car License Front Card General Error

A general error occurred while processing the front side of the car license.

Vlens

7005

Driving License Card General Error

A general error occurred while processing the driving license.

Vlens

7006

Passport Card General Error

A general error occurred while processing the passport.

Vlens

7008

Face Match General Error

A general error occurred while matching the face image.

Vlens

PreviousTransliterationNextOTP

Last updated 8 months ago