v1

latestOpenAPI 3.1.02026-07-2418201.6 MB

Credit Report API

post/v2/financial_services/credit_bureau/credit_report

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 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

decentroTxnIdstring

statusstring

responseCodestring

messagestring

Example response

{
  "decentroTxnId": "5296XXXXXXXXXXXXXXXXXXXXXXXXXXXX",
  "status": "SUCCESS",
  "responseCode": "S00000",
  "message": "Credit Report fetched successfully",
  "data": {
    "cCRResponse": {
      "status": "1",
      "cIRReportDataLst": [
        {
          "error": {
            "errorCode": "00",
            "errorDesc": "Consumer not found in bureau"
          }
        }
      ]
    }
  }
}