KYC & Onboarding

KYC - Generic Response Keys

Response KeyScenario
error_decentro_errorSomething wrong happened at Decentro level
error_missing_configurationPlan not configured for the company
error_empty_module_secretEmpty module secret was passed
error_no_subscription_foundCompany not subscribed to this module
error_unauthorized_moduleAuthentication failed for this module
error_module_access_expiredModule subscription has expired
error_module_credits_exhaustedModule credits exhausted for the company
error_malformed_requestMalformed JSON request was passed
error_duplicate_reference_idDuplicate reference id was passed in the request
error_ip_not_configuredIP not configured to access CKYC API
error_insufficient_account_balanceInsufficient account balance to access CKYC API
error_invalid_endpointInvalid API endpoint was passed
error_empty_reference_idEmpty reference_id was passed
error_invalid_consent_typeInvalid consent type was passed
error_invalid_purposeInvalid consent purpose was passed
error_empty_purposeEmpty purpose was passed
error_consent_falseFalse consent was passed
error_short_purpose_lengthShort purpose length was passed
error_long_purpose_lengthLong purpose length was passed
error_provider_errorProvider responded with a failure
error_unexpected_responseUnexpected response received from the provider
error_invalid_reference_idInvalid reference_id was passed

Scan & Extract (OCR)

Response KeyScenario
error_empty_request_bodyEmpty request body was passed
error_invalid_file_sizeFile size is greater than 6 MB
error_empty_file_nameEmpty or unsupported file name was passed
error_invalid_file_formatInvalid 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

CKYC Search & Download

Response KeyScenario
error_invalid_perform_ocrInvalid perform_ocr value was passed
error_invalid_auth_factorInvalid auth_factor value was passed
error_invalid_auth_factor_typeInvalid auth_factor_type value was passed
error_empty_auth_factor_typeEmpty auth_factor_type was passed
error_invalid_auth_factor_type_valueInvalid auth_factor_type value was passed
error_empty_auth_factorEmpty auth_factor was passed
error_invalid_ckyc_idInvalid CKYC ID was passed
error_invalid_dobInvalid dob was passed
error_invalid_pincode_yobInvalid Pin Code and YOB value was passed
error_invalid_mobileInvalid mobile number was passed
success_ckyc_downloadCKYC Download was successful
success_ckyc_searchCKYC Search was successful
error_empty_document_typeEmpty document_type was passed
error_invalid_document_typeInvalid document_type was passed
error_invalid_id_numberInvalid id_number was passed
error_invalid_document_idUnsupported or invalid document_type was passed
error_invalid_panInvalid PAN was passed in id_number
error_invalid_driving_licenseInvalid DL was passed in id_number
error_empty_id_numberEmpty id_number was passed
error_no_record_foundNo CKYC record was found
error_ckyc_not_authorizedClient not authorized to access CKYC API

Aadhaar XML

Response KeyScenario
error_invalid_sessionThe session you are trying to access is invalid
success_session_createdSession created successfully
error_empty_transaction_idEmpty Initiation_transaction_id was passed
error_invalid_transaction_idInvalid Initiation_transaction_id was passed
success_otp_generatedOTP generated successfully
error_invalid_captchaInvalid captcha was passed
error_invalid_aadhaar_numberInvalid Aadhaar number was passed
error_empty_aadhaar_numberEmpty Aadhaar number was passed
error_empty_captchaEmpty captcha was passed
error_invalid_aadhaarInvalid Aadhaar was passed
error_session_expiredCaptcha session has expired
error_otp_limit_exceededOTP attempt limit exceeded
error_resend_otpPlease wait for 30 sec before resending OTP
success_aadhaar_fetchedAadhaar data fetched successfully
error_invalid_share_codeInvalid share_code was passed
error_invalid_share_code_lengthInvalid share_code length value was passed
error_invalid_otpOTP entered is invalid
error_empty_otpEmpty OTP was passed
error_invalid_otp_requestInvalid OTP request
success_captcha_generatedCaptcha regenerated successfully

DigiLocker

Response KeyScenario
error_no_digilocker_accountThe user is not on DigiLocker
error_no_mobile_with_aadhaarAadhaar does not have verified mobile number
error_uidai_errorNo response received from UIDAI
error_no_data_foundNo data found
error_no_aadhaar_linkedAadhaar is not linked to DigiLocker
error_digilocker_lockedDigiLocker account locked for 1 hour
success_issued_filesIssue files fetched successfully
error_invalid_transaction_idInvalid initial transaction id was passed
error_empty_transaction_idEmpty initial transaction id was passed
success_file_downloadFile downloaded successfully from DigiLocker
error_empty_file_urnEmpty file urn was passed
error_invalid_file_urn_typeInvalid file urn type was passed
error_invalid_file_urnInvalid file urn was passed
success_initiate_sessionSession initiated successfully
error_empty_redirect_urlEmpty redirect url was passed
error_invalid_redirect_urlInvalid redirect url was passed
success_access_tokenAccess toke generated successfully
error_empty_digilocker_codeEmpty digilocker_code was passed
error_invalid_digilocker_codeInvalid digilocker_code was passed
error_invalid_auth_codeInvalid or expired auth_code was passed
success_eaadhaar_downloadeAadhaar downloaded successfully
error_empty_generate_xmlEmpty generate_xml was passed
error_invalid_generate_xmlInvalid generate_xml was passed
error_empty_generate_pdfEmpty generate_pdf was passed
error_invalid_generate_pdfInvalid generate_pdf was passed
error_no_record_foundNo record found in DigiLocker

Validate

Response KeyScenario
error_no_record_foundNo record found
error_invalid_gstinInvalid GSTIN number was passed
error_empty_id_numberEmpty id_number was passed
error_invalid_panInvalid PAN was passed in id_number
error_invalid_cinInvalid CIN was passed in id_number
error_invalid_dinInvalid DIN was passed in id_number
error_invalid_rc_numberInvalid RC Number was passed in id_number
error_bad_inputsBad inputs were passed
error_empty_nameEmpty name parameter was passed for document_type passport
error_empty_last_nameEmpty last name was passed for document_type passport
error_empty_dobEmpty dob parameter was passed for document_type Passport
error_empty_expiry_dateEmpty expiry_date was passed for document_type Passport
error_invalid_genderEmpty gender was passed for document_type Passport
error_invalid_passport_typeInvalid passport type was passed
error_malformed_requestMalformed request body was passed
error_invalid_dob_nameInvalid Name and DOB were passed for document_type Passport
error_invalid_full_nameEmpty full_name was passed for document_type Passport
error_invalid_dobInvalid DOB was passed
error_invalid_fssai_numberInvalid FSSAI number was passed in id_number for document_type FSSAI
error_invalid_uam_numberInvalid UAM number was passed in id_number for document_type Udyam
error_kyc_check_failedKYC check failed
error_invalid_document_typeInvalid value was passed in document_type
error_empty_document_typeEmpty value was passed in document_type
error_invalid_id_numberInvalid/Unsupported id_number value was passed
error_empty_id_numberEmpty value was passed in id_number
error_invalid_nameInvalid value was passed in name for document_type Passport
error_invalid_voter_idInvalid Voter ID number was passed in id_number for document_type VOTERID
success_panPAN validated successfully
success_driving_licenseDriving License validated successfully
success_rcRC validated successfully
success_gstinGSTIN validated successfully
success_voteridVoter ID validated successfully
success_udyog_aadhaarUdyog Aadhaar validated successfully
success_fssaiFSSAI validated successfully
success_cinCIN validated successfully
success_dinDIN validated successfully
success_fcrnFCRN validated successfully
success_fllpinFLLPIN validated successfully
success_llpinLLPIN validated successfully

Validate History

Response KeyScenario
success_kyc_historyValidate history successfully fetched
error_empty_from_dateEmpty value was passed in from_date
error_invalid_from_dateInvalid value was passed in from_date
error_empty_to_dateEmpty value was passed in to_date
error_invalid_to_dateInvalid value was passed in to_date
error_invalid_date_rangeInvalid date_range was passed. to_date cannot be earlier than from_date
error_invalid_kyc_statusInvalid KYC Validate status

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