post https://in.staging.decentro.tech/v2/financial_services/credit_bureau/credit_report/summary
Important Note
Please use only Staging Credentials on each API Reference page to test the APIs directly from our Documentation.
API Endpoints
| Environment | Endpoint |
|---|---|
| Staging / Sandbox | https://in.staging.decentro.tech/v2/financial_services/credit_bureau/credit_report/summary |
| Production | https://in.decentro.tech/v2/financial_services/credit_bureau/credit_report/summary |
Generate and fetch credit reports using detailed parameters or just using Mobile numbers and Names. Basis the request payload, Decentro hits the relevant report in the backend accordingly.
Note: Decentro recommends using all the parameters for higher accuracy.
Also, Decentro would recommend using its KYC validation API to check the PAN number and other ID details to verify if only the mobile number and name are used to pull the report.
Credit Report API
The below-mentioned response keys will be passed as part of the Credit Report API.
| Response Key | Scenario |
|---|---|
| success_credit_report | Credit Report fetched successfully. |
| error_decentro_error | Internal Server Error. Kindly retry the transaction after sometime |
| error_provider_error | Unexpected response received from the underlying provider. |
| error_empty_module_secret | An empty module secret was passed. |
| error_invalid_module_secret | An invalid module secret was passed. |
| error_empty_consent | Consent cannot be null or empty. Hint: consent (boolean) |
| error_invalid_consent | Consent should be of boolean type. Hint: consent (boolean) |
| error_false_consent | Consent cannot be false. Hint: consent (boolean) |
| error_malformed_request | A malformed JSON request was passed. |
| error_empty_address_type | Address type is empty. Hint: Allowed types are H, O and X. |
| error_invalid_address_type | Address Type is invalid. Hint: Allowed types are H, O and X. |
| error_empty_pincode | Pin code cannot be null or empty. |
| error_invalid_pincode | Invalid Format for Pin code is found. |
| error_unsanitized_values | Unsanitized values detected for key(s) |
| error_empty_name | Name cannot be null or empty. Hint: name (string). |
| error_duplicate_reference_id | Duplicate Request Reference ID |
| error_module_credits_exhausted | You have consumed your credits. Please connect with our team on [email protected] for credit renewal. |
| error_unauthorized_module | Authorization failed for accessing the module |
| error_no_subscription_found | No subscription details found for this module. Please subscribe this module to access the APIs. |
| error_empty_mobile | Mobile Number cannot be null or empty. Hint: mobile (string) |
| error_unauthorized_provider | Provider Not Authorized For Company |
| error_unexpected_response | Unexpected response received from underlying provider. |
Customer Data Pull
The below mentioned response keys will be passed as part of the Customer Data Pull API.
| Response Key | Scenario |
|---|---|
| success_customer_data_pull | Customer data pulled successfully |
| error_decentro_error | Internal Server Error. Kindly retry the transaction after sometime |
| error_provider_error | Unexpected response received from the underlying provider. |
| error_empty_module_secret | An empty module secret was passed. |
| error_invalid_module_secret | An invalid module secret was passed |
| error_empty_consent | Consent cannot be null or empty. Hint: consent (boolean) |
| error_invalid_consent | Consent should be of boolean type. Hint: consent (boolean) |
| error_false_consent | Consent cannot be false. Hint: consent (boolean) |
| error_malformed_request | A malformed JSON request was passed. |
| error_unsanitized_values | Unsanitized values detected for key(s) |
| error_empty_name | Name cannot be null or empty. Hint: name (string). |
| error_duplicate_reference_id | Duplicate Request Reference ID |
| error_module_credits_exhausted | You have consumed your credits. Please connect with our team on [email protected] for credit renewal. |
| error_unauthorized_module | Authorization failed for accessing the module |
| error_no_subscription_found | No subscription details found for this module. Please subscribe this module to access the APIs. |
| error_empty_mobile | Mobile Number cannot be null or empty. Hint: mobile (string) |
| error_unauthorized_provider | Provider Not Authorized For Company |
| error_unexpected_response | Unexpected response received from underlying provider. |