Scanner - Response Keys

This page gives an overview of all the response keys passed by Decentro under the Scanner module.

Scan & Extract (OCR)

The below mentioned response keys will be passed as part of the OCR API.

Response KeyScenario
error_empty_request_bodyAn empty request body was passed
error_invalid_file_sizeThe file size is greater than 6 MB
error_empty_file_nameAn empty or unsupported file name was passed
error_invalid_file_formatThe invalid file format was passed
error_empty_document_urlEmpty document or document url was passed
error_empty_reference_idEmpty reference id was passed
error_empty_document_idEmpty document id type was was passed
error_invalid_document_idInvalid document id type was passed
error_empty_consentEmpty consent was passed
error_invalid_consentInvalid consent was passed
error_invalid_kyc_validateInvalid kyc validate value was passed
error_invalid_document_urlInvalid document or document url was passed
success_ocrOCR was completed successfully
success_ocr_initiatedOCR transaction was initiated successfully
success_pan_ocrOCR for PAN was successful
success_voterid_ocrOCR for Voter ID was successful
success_dl_ocrOCR for DL was successful
success_aadhaar_ocrOCR for Aadhaar was successful
success_passport_ocrOCR for Passport was successful

OCR History

Response KeyScenario
error_unsanitized_valuesUnsanitized values passed in the api request
error_empty_from_dateEmpty from_date was passed
error_invalid_from_dateInvalid form_date format or a future date was passed
error_empty_to_dateEmpty to_date was passed
error_invalid_to_dateInvalid to_date format or a future date was passed
error_invalid_date_rangeInvalid date range was passed
error_invalid_kyc_statusUnsupported kyc_status value was passed
error_invalid_ocr_statusUnsupported ocr_status value was passed
success_ocr_historyOCR History fetched successfully

FaceMatch

Response KeyScenario
error_empty_file_nameEmpty file name was passed
error_invalid_file_formatInvalid/Unsupported file format was passed
error_invalid_file_nameInvalid/Unsupported file name was passed
error_invalid_file_sizeInvalid/large file size was passed
success_face_scanFaceMath completed successfully
error_invalid_requestInvalid FaceMatch request was passed
error_invalid_threshold_typeInvalid/Unsupported value was passed in threshold
error_invalid_thresholdInvalid value was passed in threshold
error_empty_imageEmpty image or image_url was passed
error_invalid_image_urlInvalid/Unsupported image_url was passed

Image Quality

Response KeyScenario
success_image_quality_checkImage Quality Check performed successfully
error_invalid_requestInvalid Image Quality Check request was passed
error_invalid_threshold_typeInvalid/Unsupported value was passed in threshold
error_invalid_thresholdInvalid value was passed in threshold
error_empty_imageEmpty image or image_url was passed
error_invalid_image_urlInvalid/Unsupported image_url was passed
error_invalid_quality_parameter_typeInvalid/Unsupported value was passed in quality_parameter
error_invalid_quality_parameterInvalid value was passed in quality_parameter
error_invalid_file_formatInvalid/Unsupported file format was passed

PhotoCopy Check

Response KeyScenario
success_photocopy_checkPhotoCopy check performed successfully
error_empty_imageEmpty image or image_url was passed
error_invalid_image_urlInvalid/Unsupported image_url was passed
error_invalid_file_formatInvalid/Unsupported file format was passed

Video Liveness

Response KeyScenario
success_liveness_checkVideo Liveness check performed successfully
error_empty_videoEmpty video or video_url was passed
error_invalid_video_urlInvalid/Unsupported video_url was passed
error_invalid_file_formatInvalid/Unsupported file format was passed
error_invalid_video_durationInvalid/Unsupported video duration file was passed
errro_invalid_videoInvalid video or video_url was passed
error_face_not_detectedFace was not detected in the video or vide_url

ID Classification

Response KeyScenario
error_empty_document_typeEmpty value was passed in document_type
error_invalid_document_typeInvalid/Unsupported value was passed in document_type
error_invalid_file_nameInvalid/Unsupported value was passed in file name
error_empty_document_urlEmpty document or document_url was passed
error_invalid_file_formatInvalid/Unsupported file format was passed
error_invalid_document_urlInvalid/Unsupported documnet_url was passed
error_empty_file_nameEmpty file name was passed in document
error_invalid_file_sizeInvalid/large file size was passed
success_id_classificationID Classification was successful
success_id_classification_mismatchID Classification performed successfully but document_type and file do not match

Text Match

Response KeyScenario
error_empty_text1Empty value was passed in text1
error_empty_text2Empty value was passed in text2
error_invalid_text1Invalid/Unsupported value was passed in text1
error_invalid_text2Invalid/Unsupported value was passed in text2
error_long_text1Long value was passed in text1 (More than 50 chars)
error_long_text2Long value was passed in text2 (More than 50 chars)
error_empty_thresholdEmpty value was passed in threshold
error_invalid_threshold_typeInvalid/Unsupported value was passed in threshold
error_invalid_thresholdInvalid value was passed in threshold (0 <= threshold <= 100)
success_text_match_completedText Match completed successfully

Aadhaar UID Masking

Response KeyScenario
error_invalid_imageInvalid/Unsupported/Low Quality image or image_url was passed
error_empty_imageEmpty image or image_url was passed
error_invalid_documentInvalid/Unsupported pdf file was passed (PDF should contain only a single page)
error_invalid_file_formatInvalid/Unsupported file format was passed
error_invalid_image_urlInvalid/Unsupported image_url was passed
error_invalid_file_sizeInvalid/Unsupported file size was passed
error_empty_file_nameEmpty file name was passed in image
error_invalid_file_nameInvalid file name was passed in the image
success_aadhaar_maskingAadhaar Masking completed successfully

Did this page help you?