The below mentioned response keys will be passed as part of the OCR API.
| Response Key | Scenario |
|---|
| error_empty_request_body | An empty request body was passed |
| error_invalid_file_size | The file size is greater than 6 MB |
| error_empty_file_name | An empty or unsupported file name was passed |
| error_invalid_file_format | The invalid file format was passed |
| error_empty_document_url | Empty document or document url was passed |
| error_empty_reference_id | Empty reference id was passed |
| error_empty_document_id | Empty document id type was was passed |
| error_invalid_document_id | Invalid document id type was passed |
| error_empty_consent | Empty consent was passed |
| error_invalid_consent | Invalid consent was passed |
| error_invalid_kyc_validate | Invalid kyc validate value was passed |
| error_invalid_document_url | Invalid document or document url was passed |
| success_ocr | OCR was completed successfully |
| success_ocr_initiated | OCR transaction was initiated successfully |
| success_pan_ocr | OCR for PAN was successful |
| success_voterid_ocr | OCR for Voter ID was successful |
| success_dl_ocr | OCR for DL was successful |
| success_aadhaar_ocr | OCR for Aadhaar was successful |
| success_passport_ocr | OCR for Passport was successful |
| Response Key | Scenario |
|---|
| error_unsanitized_values | Unsanitized values passed in the api request |
| error_empty_from_date | Empty from_date was passed |
| error_invalid_from_date | Invalid form_date format or a future date was passed |
| error_empty_to_date | Empty to_date was passed |
| error_invalid_to_date | Invalid to_date format or a future date was passed |
| error_invalid_date_range | Invalid date range was passed |
| error_invalid_kyc_status | Unsupported kyc_status value was passed |
| error_invalid_ocr_status | Unsupported ocr_status value was passed |
| success_ocr_history | OCR History fetched successfully |
| Response Key | Scenario |
|---|
| error_empty_file_name | Empty file name was passed |
| error_invalid_file_format | Invalid/Unsupported file format was passed |
| error_invalid_file_name | Invalid/Unsupported file name was passed |
| error_invalid_file_size | Invalid/large file size was passed |
| success_face_scan | FaceMath completed successfully |
| error_invalid_request | Invalid FaceMatch request was passed |
| error_invalid_threshold_type | Invalid/Unsupported value was passed in threshold |
| error_invalid_threshold | Invalid value was passed in threshold |
| error_empty_image | Empty image or image_url was passed |
| error_invalid_image_url | Invalid/Unsupported image_url was passed |
| Response Key | Scenario |
|---|
| success_image_quality_check | Image Quality Check performed successfully |
| error_invalid_request | Invalid Image Quality Check request was passed |
| error_invalid_threshold_type | Invalid/Unsupported value was passed in threshold |
| error_invalid_threshold | Invalid value was passed in threshold |
| error_empty_image | Empty image or image_url was passed |
| error_invalid_image_url | Invalid/Unsupported image_url was passed |
| error_invalid_quality_parameter_type | Invalid/Unsupported value was passed in quality_parameter |
| error_invalid_quality_parameter | Invalid value was passed in quality_parameter |
| error_invalid_file_format | Invalid/Unsupported file format was passed |
| Response Key | Scenario |
|---|
| success_photocopy_check | PhotoCopy check performed successfully |
| error_empty_image | Empty image or image_url was passed |
| error_invalid_image_url | Invalid/Unsupported image_url was passed |
| error_invalid_file_format | Invalid/Unsupported file format was passed |
| Response Key | Scenario |
|---|
| success_liveness_check | Video Liveness check performed successfully |
| error_empty_video | Empty video or video_url was passed |
| error_invalid_video_url | Invalid/Unsupported video_url was passed |
| error_invalid_file_format | Invalid/Unsupported file format was passed |
| error_invalid_video_duration | Invalid/Unsupported video duration file was passed |
| errro_invalid_video | Invalid video or video_url was passed |
| error_face_not_detected | Face was not detected in the video or vide_url |
| Response Key | Scenario |
|---|
| error_empty_document_type | Empty value was passed in document_type |
| error_invalid_document_type | Invalid/Unsupported value was passed in document_type |
| error_invalid_file_name | Invalid/Unsupported value was passed in file name |
| error_empty_document_url | Empty document or document_url was passed |
| error_invalid_file_format | Invalid/Unsupported file format was passed |
| error_invalid_document_url | Invalid/Unsupported documnet_url was passed |
| error_empty_file_name | Empty file name was passed in document |
| error_invalid_file_size | Invalid/large file size was passed |
| success_id_classification | ID Classification was successful |
| success_id_classification_mismatch | ID Classification performed successfully but document_type and file do not match |
| Response Key | Scenario |
|---|
| error_empty_text1 | Empty value was passed in text1 |
| error_empty_text2 | Empty value was passed in text2 |
| error_invalid_text1 | Invalid/Unsupported value was passed in text1 |
| error_invalid_text2 | Invalid/Unsupported value was passed in text2 |
| error_long_text1 | Long value was passed in text1 (More than 50 chars) |
| error_long_text2 | Long value was passed in text2 (More than 50 chars) |
| error_empty_threshold | Empty value was passed in threshold |
| error_invalid_threshold_type | Invalid/Unsupported value was passed in threshold |
| error_invalid_threshold | Invalid value was passed in threshold (0 <= threshold <= 100) |
| success_text_match_completed | Text Match completed successfully |
| Response Key | Scenario |
|---|
| error_invalid_image | Invalid/Unsupported/Low Quality image or image_url was passed |
| error_empty_image | Empty image or image_url was passed |
| error_invalid_document | Invalid/Unsupported pdf file was passed (PDF should contain only a single page) |
| error_invalid_file_format | Invalid/Unsupported file format was passed |
| error_invalid_image_url | Invalid/Unsupported image_url was passed |
| error_invalid_file_size | Invalid/Unsupported file size was passed |
| error_empty_file_name | Empty file name was passed in image |
| error_invalid_file_name | Invalid file name was passed in the image |
| success_aadhaar_masking | Aadhaar Masking completed successfully |