Error Responses
DIVE API 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 Name | Error Codes | Error Descriptions |
|---|---|---|
| AdditionalCheckError | "AdditionalCheckError" | "An error in the additional check." |
| AntiSpoofing | "AntiSpoofing" | "Antispoofing analysis has failed." |
| CannotRecognizeASDK | "AsdkError" | "Unable to capture data from the document." |
| BackImageRequired | "BackImageOrTrackStringNotPresentError" | "A Back image or a TrackString is not present." |
| BackImageRequired | "BackImageOrTrackStringNotPresentError" | "A Back image for this document is required." |
| BackSideMismatch | "DocumentSidesMismatch" | "The back side of the document was uploaded instead of the front side of the document. Please check the uploaded images." |
| DocumentSidesMismatch | "DocumentSidesMismatch" | "Provided sides belong to different documents." |
| EmptyRequestModel | "BadRequest" | "The request contains an empty model." |
| CaptureFacesError | "CaptureFacesError" | "Error to capture faces." |
| CompareFacesError | "CompareFacesError" | "Face comparison error" |
| DocumentSidesMismatch | "DocumentSidesMismatch" | "Provided sides belong to different documents." |
| DocumentTypeError | "DocumentTypeError" | "The document type is required." |
| DocumentTypeMismatchError | "DocumentTypeMismatchError" | "The selected document type does not match the detected one." |
| VerifyIDError | "DocumentVerifyServiceError" | "Unable to verify. Please use an alternative ID." |
| IncorrectSettings (Shufti is on/off) |
"BadRequest" | "You need to enable at least one setting connected with the input content." + "Such as Face Matching, {VisualSetting(hasShufti)} or Processing of the Back image.") |
| InternalError | "InternalError" | "Unable to process the request." |
| FaceDocNotFoundServiceError | "FaceDocNotDetectError" | "The face could not be located in the front image." |
| FacePhotoNotFoundServiceError | FaceDocNotDetectError | "The face could not be located on the image." |
| FrontImageRequiredError | FrontImageRequiredError | "The Front image is required." |
| FaceImageRequiredError | "FaceImageRequiredError" | "The Face image is required." |
| TrackStringParserServiceError | "TrackStringParserServiceError" | "Failed to parse the TrackString." |
| MrzIsNotPresentError | "MrzIsNotPresentError" | "An image with MRZ is not present." |
| CannotRecognizeMRZ | "MrzOcrError" | "Unable to capture the Machine-Readable Zone (MRZ) from the image of the document." |
| DocTypeNotFound | "NotFound" | "The document type was not recognized." |
| NotSupportedDocument | "DocumentTypeError" | "This document type is not supported in this API." |
| NotSupportedCountry | "NotSupportedCountry" | "This country is not supported." |
| OcrLowConfidence | "OCRError" | "OCR has low confidence." |
| OcrProcessingRequired | "OCRError" | "Enabled OCR is required for this document." |
| CannotRecognize | "OCRError" | "Unable to capture data from the front of the document." |
| CannotDecodePdf417 | "Pdf417Error" | "Unable to decode Barcode from the image of the document." |
| PreProcessingError | "PreProcessingError" | "Error during the pre-processing (maybe low quality)." |
| ParsingDataNotFound | "PreProcessingError" | "The uploaded image does not have data for {parsingType} parsing. Check image quality or upload another image." *the endpoint name used - MRZ/OCR/PDF417 - is inserted instead of {parsingType} |
| ProhibitedRegion | "ProhibitedRegion" | "Validation from your region is prohibited." |
| QualityWarning | "QualityWarning" | "Quality warning is detected." |
| RequestAlreadyProcessed | "RequestAlreadyProcessed" | "This request has already been processed." |
| RequestCreatedError | "RequestError" | "The request cannot be created." |
| RequestExpired | "RequestExpired" | "This request has expired." |
| SignatureNotFound | "SignatureNotFound" | "The signature has not been found." |
| SuspiciousActivityWarning | "SuspiciousActivityWarning" | "Suspicious Activity was detected." |
| TemplateNotFound | "NotFound" | "The document template could not be found. Please try submitting a different document or a different document type, such as a Driver's License, Passport, or International ID." |