post
https://in.staging.decentro.tech/v2/financial_services/credit_bureau/credit_report
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 a credit report using the applicantâs name and mobile number and PAN along with the bureau_code of the bureau you want to pull the report from. Based on the request payload, Decentro routes the request to the relevant bureau report in the backend.
Note: Decentro recommends using all the parameters for higher accuracy.
Important Note: Customer Full Name
Please ensure that the customer's full name, as per their official documents or credit bureau records, is provided in the request. Passing only the first name or an incomplete name may result in a "Consumer Not Found" response or unsuccessful data retrieval.
Response Key Description
| Key | Description |
|---|---|
decentroTxnId | Transaction ID generated by Decentro for tracking the request. |
status | Overall status of the request (e.g., "SUCCESS" or "FAILURE"). |
responseCode | System-defined response code indicating the result of the request (e.g., "S00000" for success). |
message | Message providing additional information about the API response status. |
responseKey | Response identifier indicating the success or failure of the request. |
data | Primary container holding the detailed response payload. |
reportOrderNumber | Unique reference number generated for the credit report retrieval. |
cCRResponse | Container holding the Consumer Credit Report (CCR) returned by the bureau. |
cCRResponse.status | Status of the credit report returned by the bureau. |
cIRReportDataLst | List of Credit Information Report (CIR) records returned by the bureau. |
cIRReportDataLst.cIRReportData | Container holding a single Credit Information Report. |
cIRReportDataLst.error | Container holding the error details returned when no report could be generated. |
cIRReportDataLst.error.errorCode | Error code returned by the bureau for the request. |
cIRReportDataLst.error.errorDesc | Description of the error returned by the bureau for the request. |
iDAndContactInfo | Container for the identity and contact details of the individual. |
personalInfo | Container for personal demographic information of the individual. |
name | Container for the name of the individual as held in Bureau records. |
name.fullName | Full name of the individual as per Bureau records. |
name.firstName | First name of the individual. |
name.middleName | Middle name of the individual (if available in records else ""). |
dateOfBirth | Date of birth of the individual (Format: YYYY-MM-DD) |
gender | Gender of the individual :["Male", "Female"] |
age | Container for the age of the individual. |
age.age | Age of the individual in years. |
totalIncome | Total income value associated with the individual (if available in records else ""). |
phoneInfo | List of phone records associated with the individual. |
phoneInfo.seq | Unique sequence identifier for each phone record. |
phoneInfo.typeCode | Type of phone number (H = Home, M = Mobile, T = Telephone, O = Office). |
phoneInfo.reportedDate | Date on which the phone number was reported or last updated (Format: YYYY-MM-DD) |
phoneInfo.number | Phone number associated with the individual, including country code. |
emailAddressInfo | List of email records associated with the individual (empty if not available). |
emailAddressInfo.seq | Unique sequence identifier for each email record. |
emailAddressInfo.reportedDate | Date on which the email address was reported or last updated (Format: YYYY-MM-DD) |
emailAddressInfo.emailAddress | Email ID associated with the individual. |
addressInfo | List of address records associated with the individual. |
addressInfo.seq | Unique sequence identifier for each address record. |
addressInfo.reportedDate | Date on which the address was reported or last updated (Format: YYYY-MM-DD) |
addressInfo.address | Full address of the individual as available in records. |
addressInfo.state | State code corresponding to the address. |
addressInfo.postal | Postal code (PIN code) of the address. |
addressInfo.type | Address classification (e.g., Permanent, Residence, Office). |
identityInfo | Container for government-issued identity details linked to the individual. |
identityInfo.pANId | List containing PAN details (empty if not available). |
identityInfo.pANId.seq | Sequence identifier for the PAN record. |
identityInfo.pANId.idNumber | Permanent Account Number (PAN) of the individual. |
identityInfo.pANId.reportedDate | Date on which the PAN was reported or last updated (Format: YYYY-MM-DD) |
identityInfo.nationalIDCard | List containing national ID card details (empty if not available). |
identityInfo.nationalIDCard.seq | Sequence identifier for the national ID record. |
identityInfo.nationalIDCard.idNumber | National ID card number of the individual. |
identityInfo.nationalIDCard.reportedDate | Date on which the national ID was reported or last updated (Format: YYYY-MM-DD) |
identityInfo.otherId | List containing any additional identity documents (empty if not available). |
identityInfo.otherId.seq | Sequence identifier for the other ID record. |
identityInfo.otherId.idNumber | Identification number of the other document. |
identityInfo.otherId.reportedDate | Date on which the other ID was reported or last updated (Format: YYYY-MM-DD) |
retailAccountDetails | List of credit accounts (tradelines) held by the individual. |
retailAccountDetails.seq | Unique sequence identifier for each account record. |
retailAccountDetails.accountNumber | Masked account number of the credit account. |
retailAccountDetails.institution | Name of the lending institution reporting the account. |
retailAccountDetails.accountType | Type of credit account (e.g., Credit Card, Auto Loan, Personal Loan). |
retailAccountDetails.ownershipType | Ownership of the account (e.g., Individual, Joint, Guarantor). |
retailAccountDetails.balance | Current outstanding balance on the account. |
retailAccountDetails.pastDueAmount | Amount currently overdue on the account. |
retailAccountDetails.lastPayment | Last payment reported on the account. |
retailAccountDetails.open | Whether the account is currently open :["Yes", "No"] |
retailAccountDetails.sanctionAmount | Amount sanctioned by the lender for the account. |
retailAccountDetails.highCredit | Highest credit amount extended on the account. |
retailAccountDetails.creditLimit | Credit limit set on the account (if available in records else ""). |
retailAccountDetails.lastPaymentDate | Date of the last payment made on the account (Format: YYYY-MM-DD) |
retailAccountDetails.dateReported | Date on which the account was last reported to the bureau (Format: YYYY-MM-DD) |
retailAccountDetails.dateOpened | Date on which the account was opened (Format: YYYY-MM-DD) |
retailAccountDetails.dateClosed | Date on which the account was closed (Format: YYYY-MM-DD) (empty if the account is open). |
retailAccountDetails.interestRate | Rate of interest applicable on the account. |
retailAccountDetails.repaymentTenure | Repayment tenure of the account in months. |
retailAccountDetails.installmentAmount | Instalment amount payable on the account. |
retailAccountDetails.termFrequency | Frequency at which instalments are payable (e.g., Monthly). |
retailAccountDetails.collateralValue | Value of the collateral securing the account (if available in records else ""). |
retailAccountDetails.collateralType | Type of collateral securing the account (e.g., Property) (if available in records else ""). |
retailAccountDetails.accountStatus | Current status of the account (e.g., Current Account, Closed). |
retailAccountDetails.assetClassification | Asset classification of the account as reported by the lender. |
retailAccountDetails.writeOffAmount | Amount written off on the account (if available in records else ""). |
retailAccountDetails.reason | Reason reported against the account. |
retailAccountDetails.source | Source of the account record as reported to the bureau. |
retailAccountDetails.history48Months | Month-by-month payment history for the account, for up to the last 48 months. |
history48Months.key | Month and year the history entry refers to (Format: MM-YY) |
history48Months.paymentStatus | Payment status reported for that month. |
history48Months.suitFiledStatus | Suit filed status reported for that month ("*" where not reported). |
history48Months.assetClassificationStatus | Asset classification status reported for that month ("*" where not reported). |
retailAccountsSummary | Container summarising all credit accounts held by the individual. |
retailAccountsSummary.noOfAccounts | Total number of credit accounts. |
retailAccountsSummary.noOfActiveAccounts | Number of currently active accounts. |
retailAccountsSummary.noOfWriteOffs | Number of accounts written off. |
retailAccountsSummary.noOfPastDueAccounts | Number of accounts currently overdue. |
retailAccountsSummary.noOfZeroBalanceAccounts | Number of accounts with a zero balance. |
retailAccountsSummary.totalPastDue | Total amount overdue across all accounts. |
retailAccountsSummary.mostSevereStatusWithIn24Months | Most severe delinquency status reported in the last 24 months. |
retailAccountsSummary.singleHighestCredit | Highest credit amount extended on any single account. |
retailAccountsSummary.singleHighestSanctionAmount | Highest amount sanctioned on any single account. |
retailAccountsSummary.singleHighestBalance | Highest outstanding balance on any single account. |
retailAccountsSummary.totalHighCredit | Total of the highest credit amounts across all accounts. |
retailAccountsSummary.averageOpenBalance | Average outstanding balance across open accounts. |
retailAccountsSummary.totalBalanceAmount | Total outstanding balance across all accounts. |
retailAccountsSummary.totalSanctionAmount | Total amount sanctioned across all accounts. |
retailAccountsSummary.totalCreditLimit | Total credit limit across all accounts. |
retailAccountsSummary.totalMonthlyPaymentAmount | Total monthly payment due across all accounts. |
retailAccountsSummary.recentAccount | Most recently opened account, with the account type and opening date. |
retailAccountsSummary.oldestAccount | Oldest account held, with the account type and opening date. |
scoreDetails | List of credit scores returned for the individual. |
scoreDetails.type | Type of score returned (e.g., ERS). |
scoreDetails.version | Version of the scoring model used. |
scoreDetails.name | Name of the score, combining the score type and version. |
scoreDetails.value | Credit score value. |
scoreDetails.scoringElements | List of factors contributing to the score (empty if not available). |
scoringElements.seq | Sequence identifier for each scoring factor. |
scoringElements.type | Type of scoring factor. |
scoringElements.code | Code identifying the scoring factor. |
scoringElements.description | Description of the scoring factor (e.g., Total Utilization). |
enquiries | List of credit enquiries made against the individual (empty if not available). |
enquiries.seq | Unique sequence identifier for each enquiry record. |
enquiries.institution | Name of the institution that made the enquiry. |
enquiries.date | Date on which the enquiry was made (Format: YYYY-MM-DD) |
enquiries.time | Time at which the enquiry was made (Format: HH:MM) |
enquiries.requestPurpose | Purpose code for which the enquiry was made. |
enquiries.amount | Amount for which the enquiry was made. |
enquirySummary | Container summarising credit enquiries made against the individual. |
enquirySummary.purpose | Purpose the summary covers. |
enquirySummary.total | Total number of enquiries recorded. |
enquirySummary.past30Days | Number of enquiries in the last 30 days. |
enquirySummary.past12Months | Number of enquiries in the last 12 months. |
enquirySummary.past24Months | Number of enquiries in the last 24 months. |
enquirySummary.recent | Date of the most recent enquiry (Format: YYYY-MM-DD) |
otherKeyInd | Container for additional key indicators derived from the credit history. |
otherKeyInd.ageOfOldestTrade | Age of the oldest credit account in months. |
otherKeyInd.numberOfOpenTrades | Number of currently open credit accounts. |
otherKeyInd.allLinesEVERWritten | Total value of all credit lines ever written off. |
otherKeyInd.allLinesEVERWrittenIn9Months | Number of credit lines written off in the last 9 months. |
otherKeyInd.allLinesEVERWrittenIn6Months | Number of credit lines written off in the last 6 months. |
recentActivities | Container summarising recent activity on the credit file. |
recentActivities.accountsDeliquent | Number of accounts that became delinquent recently. |
recentActivities.accountsOpened | Number of accounts opened recently. |
recentActivities.accountsUpdated | Number of accounts updated recently. |
recentActivities.totalInquiries | Total number of recent enquiries. |
decentro_txn_id | Transaction ID generated by Decentro for tracking the request. Returned in place of decentroTxnId on gateway-level failures. |
response_code | System-defined response code indicating the result of the request. Returned in place of responseCode on gateway-level failures. |
request_id | Identifier for the request, returned by the gateway in place of decentroTxnId when the request is rejected before it reaches the module. |
Response Key Mapping
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. |