🚨 Error Codes
This section details the error codes returned by Digital Identity VLens APIs, which include both HTTP status codes and VLens-specific error codes. Understanding these codes is crucial for proper error handling and debugging.
🚨 Error Codes
Overview: This section details the error codes returned by VLens APIs, which include both HTTP status codes and VLens-specific error codes. Understanding these codes is crucial for proper error handling and debugging.
HTTP Error Codes:
400
Bad Request - The request is invalid, usually due to missing required information, incorrect parameters, or a formatting error like invalid JSON.
Make sure all the required parameters are included.
Please provide a valid base64 encoded image.
401
Unauthorized
Make sure you are using the correct credentials and try again.
403
Forbidden
Generate and include a valid access token and try again.
415
Unsupported Media Type
Please re-check your image format.
422
Unprocessable Entity
Check the custom error code returned in the response, and refer to the Vlens Error Codes table for more information.
500
Internal Server Error
Well-formed request received, but an unexpected error occurred. Try again later.
VLens Error Codes:
3001-3006
Document Validation Errors
Each code represents the below respectively:
Invalid ID Number
Invalid BirthDate,
Invalid Govern
Invalid ID_Key
Invalid Gender,
Invalid ReleaseDate
Ensure the document is properly aligned, well-lit, and focused for accurate reading.
3007-3009
Wrong Date Format
Verify that all dates in right format, each code represents a specific date:
BirthDate
ReleaseDate
ExpiryDate
3010
Document Expired
Ensure the expiry date of the submitted document has not passed.
3011
Card Not Detected
Ensure the document is visible.
3013
Invalid MRZ
Ensure the MRZ (Machine Readable Zone) is clear.
3101
ID Number Mismatch
Ensure the ID numbers on the front and back of the document match.
3102
Name Mismatch
Ensure the name on the ID and car license documents match.
3104
ID number is duplicated for same tenant
Ensure that you login with the same user.
4001
Invalid Bundle Key
Ensure that your bundle key is entered correctly.
4002
Insufficient Quota
Your bundle's quota is depleted. Please recharge your bundle.
4003
Exceeded Number of Trials
The allowed number of trials has been exceeded. Try again later.
4004
Unregistered Service
Ensure the service is included in your bundle.
4005
Disabled Bundle
Contact the server admin to reactivate your bundle.
4006
Not Subscribed
Subscribe to a bundle to access the service.
4007
Subscription Expired
Renew your subscription to continue using the service.
4206
Multiple Faces Detected
Please make sure to have only one face in the image.
4207
Make sure a face is visible.
No Face Detected
4208
Couldn’t Extract Facial Features
Please make sure that there is a face in the image.
4209
Face Not Matching
Please recapture your face and ensure the same face feature from NID.
4210
Face is Not Live
Please recapture your face and ensure the capture is clear.
5000
General Error
Something went wrong. Contact support.
5001
Unsupported Document
Please enter a supported document.
5002
Maximum Image Size Exceeded
Make sure each provided image does not exceed the 3MB limit.
5003
Maximum Image Resolution Exceeded
Make sure each provided image does not exceed the 25 Million pixel limit.
5004
Transaction Not Found
Check the Transaction ID/token sent in the request.
5005
Spoofed Document
Please make sure you're capturing a real document
5006
Blurred Image
Please recapture image and make sure it is focused
5007
Invalid Classification
Document is supported but wrong end point was called
5008
Data misassigned
One or more field are undetectable from the image.
6102
Phone number is existing
Phone number already exists
6103
Email is existing
Email already exists
6104
Phone number ownership could not be verified
The NTRA check returned false, meaning the phone number is NOT registered with the same ID number.
6105
OTP code has expired
OTP code has expired, please request a new one
6106
OTP code is incorrect
OTP code is wrong, please insert the right code sent via SMS
6107
CSO check failed Deprecated
CSO check is not verified
6109
FRA service is currently unavailable
FRA service is unreachable, please try again later.
6111
The Person name doesn’t match
First name on NID doesn't match CSO records, please retake clearer image, or verify NID.
6112
The Person Other Names doesn’t match
Rest of names on NID doesn't match CSO records, please retake clearer image, or verify NID.
6113
The Factory Number doesn’t match
Factory number on NID doesn't match CSO records, please retake clearer image, or verify NID.
6114
The Card Expiration Date doesn’t match
Expiration date on NID doesn't match CSO records, please retake clearer image, or verify NID.
6116
Phone OwnerShip Service Error
NTRA service is currently unavailable, please try again later.
6117
The contract already exists with the same status
You are trying to do an operation that has already been completed before to the same contract.
6118
Customer JWT is required. Please try again.
Unable to find authorization header, please refresh or re-login.
6119
The JWT token format is invalid. Please re-authenticate.
Error in reading authorization header, please refresh or re-login.
6120
Authentication failed. Contract API could not be authenticated by the tenant provider.
While signing contract, FRA are unable to validate the customer's access token communicated by the identity provider.
6121
The contract PDF is not valid. Please send a valid file.
PDF contract format is not valid, please try again or contact administrator.
7000
Multiple cards general error
Several cards detected, please take clear image of single card.
7001
ID front card general error
Unable to identify ID front card image, please retry with clearer image.
7002
ID back card general error
Unable to identify ID back card image, please retry with clearer image.
7003
Car license back card general error
Unable to identify car license back image, please retry with clearer image.
7004
Car license front card general error
Unable to identify car license front image, please retry with clearer image.
7005
Driving license card general error
Unable to identify car license card, please retry with clearer image.
7006
Passport card general error
Unable to identify passport image, please retry with clearer image.
7008
Face match general error
Unable to match selfie image with NID image, please retry.
7009
OCR service unreachable
Service temporarily unavailable, please try again
7010
Transliteration service unreachable
Transliteration service temporarily unavailable or turned off, please try again
đź’ˇ Helpful Tips
API Debugging: Use the provided error messages to pinpoint and resolve issues quickly. Remember to check both HTTP and VLens-specific error codes.
Image and Document Uploads: Ensure documents are clear, well-lit, and within size limits. For images, use online tools to compress or resize before uploading.
Subscription Management: Regularly monitor your bundle and subscription status to avoid interruptions in service.
Best Practices: Always validate user inputs and handle errors gracefully to improve user experience.
Last updated