v1

latestOpenAPI 3.1.02026-07-2418201.6 MB

Credit Report Summary

post/v2/financial_services/credit_bureau/credit_report/summary

Headers

client_idstring required

ID/identifier that is provided by Decentro to a specific client and environment. Please note, this may change based on the environment you are on.

client_secretstring required

The confidential credential provided by Decentro that is associated with the client_id

Request body

reference_idstring required

Any unique ID assigned by you for this API request.

consentboolean required

true/false based on the consent given by the customer. Mandatory as per regulation.

consent_purposestring required

The purpose of taking this consent from your customer. Mandatory as per regulation. (>20 characters)

namestring required

The name of the user as per the official documents. Length must be between 2-40 characters.

mobilestring required

The mobile number of the individual

inquiry_purposestring required

date_of_birthstring date

address_typestring

addressstring

pincodestring

document_typestring

document_idstring

Response

200

Example response

{
  "decentroTxnId": "XXXXXXXX",
  "status": "SUCCESS",
  "responseCode": "S00000",
  "message": "Credit Report fetched successfully",
  "data": {
    "cCRResponse": {
      "status": "1",
      "cIRReportDataLst": [
        {
          "cIRReportData": {
            "iDAndContactInfo": {
              "personalInfo": {
                "name": {
                  "fullName": "VIJAY MALLYA",
                  "firstName": "VIJAY",
                  "lastName": "MALLYA "
                },
                "dateOfBirth": "YYYY-MM-DD",
                "gender": "Male",
                "age": {
                  "age": "XXX"
                },
                "totalIncome": "XXXXXX",
                "occupation": "SALARIED"
              },
              "identityInfo": {
                "pANId": [
                  {
                    "seq": "1",
                    "reportedDate": "XXXX-XX-XX",
                    "idNumber": "XXXXXX"
                  }
                ],
                "passport": [
                  {
                    "seq": "1",
                    "reportedDate": "XXXX-XX-XX",
                    "idNumber": "XXXXXXXX"
                  }
                ]
              },
              "addressInfo": [
                {
                  "seq": "1",
                  "reportedDate": "YYYY-MM-DD",
                  "address": "XXXXX",
                  "state": "XX",
                  "postal": "XXXXXX",
                  "type": "Primary"
                }
              ],
              "phoneInfo": [
                {
                  "seq": "1",
                  "typeCode": "H",
                  "reportedDate": "YYYY-MM-DD",
                  "number": "9999999999"
                }
              ],
              "emailAddressInfo": [
                {
                  "seq": "1",
                  "reportedDate": "YYYY-MM-DD",
                  "emailAddress": "example@email.com"
                }
              ]
            },
            "retailAccountsSummary": {
              "noOfAccounts": "XX",
              "noOfActiveAccounts": "X",
              "noOfWriteOffs": "X",
              "totalPastDue": "XXXXX",
              "mostSevereStatusWithIn24Months": "XXXXXXX",
              "singleHighestCredit": "XXXXXXX",
              "singleHighestSanctionAmount": "XXXXXX",
              "totalHighCredit": "XXXXXX",
              "averageOpenBalance": "XXXXXX",
              "singleHighestBalance": "XXXXX",
              "noOfPastDueAccounts": "X",
              "noOfZeroBalanceAccounts": "X",
              "recentAccount": "XXXXXX",
              "oldestAccount": "XXXXXX",
              "totalBalanceAmount": "XXXXXXXX",
              "totalSanctionAmount": "XXXXXXXX",
              "totalCreditLimit": "XXXXX",
              "totalMonthlyPaymentAmount": "XXXXX"
            },
            "scoreDetails": [
              {
                "type": "ERS",
                "version": "4.0",
                "name": "ERS4.0",
                "value": "849",
                "scoringElements": [
                  {
                    "type": "RES",
                    "seq": "1",
                    "code": "803",
                    "description": "Total Utilization"
                  }
                ]
              }
            ],
            "otherKeyInd": {
              "ageOfOldestTrade": "XX",
              "numberOfOpenTrades": "X",
              "allLinesEVERWritten": "XXX",
              "allLinesEVERWrittenIn9Months": "X",
              "allLinesEVERWrittenIn6Months": "X"
            },
            "recentActivities": {
              "accountsDeliquent": "X",
              "accountsOpened": "X",
              "totalInquiries": "X",
              "accountsUpdated": "X"
            }
          }
        }
      ]
    }
  },
  "responseKey": "success_credit_report"
}