Error Responses

DVS uses conventional HTTP response codes to indicate the success or failure of an API request.

200 Level Response Code

Codes in the 200 range indicate success.

400 Level Response Code

Codes in the 400 range indicate a client side error based on the provided information (e.g. a required parameter was omitted, a document's verification failed, etc.). All 400 level errors will include an error code that briefly explains the error reported.

500 Level Response Code

Codes in the 500 range indicate a server side error. All 500 level errors include an error code "ApiError" and a message that briefly explains the error being reported. If the server is running in the development mode then the error message will include a field named DeveloperMessage with additional details describing the error.

Sample Response JSON Object:

{
  "code": "string",
  "message": "string",
  "propertyErrors": {},
  "multipleErrors": [
    null
  ]
}

Error Object Attributes:

• code (string) The type of error returned. One of Error Codes.
• message (string) A human-readable message about the error.
• propertyErrors (object) Dictionary, which contains the fields from the model where the errors have been found. Key: field name from the model, meaning: error message. The error code will appear as 'ValidationError'.
• multipleErrors (Error's array) a set of errors of the same structure as a describable object. The error code will appear as 'MultipleErrors'.

Error Codes Summary for 400 HTTP Status Code:

Error Code	Meaning
ValidationError	Request fields validation is failed
MultipleErrors	Multiple errors
OCRError	Unable to capture data from the front of the document
MRZOCRError	Unable to capture MRZ from the image of the document
MrzIsNotPresentError	Image with MRZ is not present
FrontImageRequiredError	Front image is required
BackImageOrTrackStringNotPresentError	Back image or TrackString is not present
PDF417Error	Unable to capture data from the back of the document
FaceDocNotDetectError	The face has not been found on the document
FacePhotoNotDetectError	The face has not been found on the photo
DocumentVerifyError	Unable to Verify the Document(s)
TrackStringParserError	Failed to parse the TrackString
CompareFacesError	Error to compare faces
CaptureFacesError	Error to capture faces
RequestAlreadyProcessed	This request has already been processed
RequestExpired	This request has expire
AntiSpoofing	Anti spoofing analyzing failed

Error Codes Summary for 404 HTTP Status Code:

Error Code	Meaning
NotFound	The requested resource doesn't exist