Image Quality Detection

Image quality detection response codes are returned in both the idcheck and OCR objects. The response codes are part of the an imageQualityFindings array, where each member contains one code and one message. Here is an example imageQualityFindings array with response code 301.

JSON

{
  "imageQualityFindings": [
      {
        "code": 301,
        "message": "Image submission warning: Processed back image found from image submitted via /submit-front"
      }
   ]
}

Response Codes

👍

These codes apply only to na_dl as the document_type. They do not pertain to passport or other.

300-399

Response codes in the 300 range are warnings. They indicate that the transaction was processed with a warning described in the message for each code.

Code 300

Image submission warning: Processed front image found from image submitted via /submit-back.
This code means the image was submitted to the wrong API endpoint, but it did not stop the transaction. The front image was incorrectly submitted to the /submit-back endpoint. The image was automatically applied to the correct API endpoint, /submit-front, in order to continue processing the transaction. The transaction workflow included both a front image and a back image.

Code 301

Image submission warning: Processed back image found from image submitted via /submit-front.
This code means the image was submitted to the wrong API endpoint, but it did not stop the transaction. The back image was incorrectly submitted to the /submit-front endpoint. The image was automatically applied to the correct API endpoint, /submit-back, in order to continue processing the transaction. The transaction workflow included both a front image and a back image.

400-499

Response codes in the 400 range are errors. They indicate that the transaction failed, and that a new transaction must be started.

Code: 400

Image submission error: Front side of document submitted via /submit-back.

This code means the image was submitted to the wrong API endpoint, and therefore, the transaction failed. A new transaction must be started. A front image without a barcode was incorrectly submitted to the /submit-back endpoint. The image was not automatically applied to the correct API endpoint, /submit-front, because that endpoint was not part of the transaction workflow.

Code 401

Image submission error: Blurry document image submitted via /submit-back.

This code means the image was submitted to the right API endpoint, but the transaction failed because the image was blurry. A new transaction must be started. A back image with a barcode was correctly submitted to the /submit-back endpoint. However, due to poor image quality, the barcode could not be scanned and processed.

Code 402

Image submission error: Unrecognizable document submitted via /submit-back.

This code means the image submitted to the /submit-back endpoint was an unknown image without a barcode, and therefore, the transaction failed. A new transaction must be started. The image could not be processed because it was not recognized as a back image with a barcode or as a front image.

Code: 403

Image submission error: Back side of document submitted via /submit-front.

This code means the image was submitted to the wrong API endpoint, and therefore, the transaction failed. A new transaction must be started. A back image with a barcode was incorrectly submitted to the /submit-front endpoint. The image was not automatically applied to the correct API endpoint, /submit-back, because that endpoint was not part of the transaction workflow.

Code: 404

Image submission error: Unrecognizable document submitted via /submit-front.

This code means the image submitted to the /submit-front endpoint was an unknown image, and therefore, the transaction failed. A new transaction must be started. The image could not be processed because it was not recognized as a front image or as a back image with a barcode.