​
Generate credit history data with CRC

Adhere’s CRC Credit Summary endpoint provides users with a comprehensive record of their credit-related activities, including credit accounts, payment timelines, credit utilization, account closures, and instances of delinquency. By leveraging this endpoint, users can gain valuable insights into their credit behavior, assess their creditworthiness, and understand factors influencing their credit standing for effective monitoring and management.

​
Request Endpoint

POST: {{BASE_URL}}/api/onboarding/individual/crc_summary/

  • Media-Type: application/json

​
Status Codes

  • 201 Created: The request was successful, and the business’ credit information is returned successfully.
  • 400 Bad Request: The request could not be completed due to invalid or missing information.

​
Payload Fields

{
    "bvn": "22244545518"
}

​
200 OK Response

{
  "success": true,
  "statusCode": 200,
  "message": "CRC Credit History",
  "response_code": "00",
  "data": {
    "_id": "64f600608aaf9386c646de32",
    "bvn": "22244545518",
    "customerId": "505327",
    "businessId": "64db7ab8a26e603218838892",
    "name": "ADELEKE EMMANUEL AYORINDE",
    "phone": "",
    "gender": "Male",
    "dateOfBirth": "29/12/1994",
    "address": "",
    "email": "",
    "score": {
      "totalNoOfDelinquentFacilities": "0",
      "lastReportedDate": "30-SEP-2023",
      "totalNoOfLoans": "7",
      "totalNoOfInstitutions": "4",
      "totalNoOfActiveLoans": "6",
      "totalBorrowed": "3,541,267",
      "totalOutstanding": "1",
      "totalOverdue": "0",
      "maxNoOfDays": "0",
      "totalNoOfClosedLoans": 1,
      "crcReportOrderNumber": "W-0097884391/2023"
    },
    "searchedDate": "2023-11-23T14:04:03.722Z"
  }
}

​
Field Description

FieldDescriptionType
successIndicates whether the request was successful or not.Boolean
statusCodeThe HTTP status code of the response.Number
messageA message describing the result of the request.String
response_codeThe operational response code.String
dataAn object containing detailed information about the individual’s credit history.Object
- _idThe unique identifier for the credit history record.String
- bvnThe Bank Verification Number of the individual.String
- customerIdThe unique identifier assigned to the customer.String
- businessIdThe unique identifier assigned to the business.String
- nameThe full name of the individual.String
- phoneThe phone number of the individual, if available.String
- genderThe gender of the individual.String
- dateOfBirthThe date of birth of the individual.String
- addressThe address of the individual, if available.String
- emailThe email address of the individual, if available.String
- scoreAn object containing detailed credit score information.Object
-- totalNoOfDelinquentFacilitiesThe total number of delinquent facilities.String
-- lastReportedDateThe date when the credit information was last reported.String
-- totalNoOfLoansThe total number of loans taken by the individual.String
-- totalNoOfInstitutionsThe total number of institutions the individual has loans with.String
-- totalNoOfActiveLoansThe total number of active loans.String
-- totalBorrowedThe total amount borrowed by the individual.String
-- totalOutstandingThe total outstanding amount on loans.String
-- totalOverdueThe total overdue amount on loans.String
-- maxNoOfDaysThe maximum number of days overdue on any loan.String
-- totalNoOfClosedLoansThe total number of loans that have been closed.Number
-- crcReportOrderNumberThe order number of the CRC report.String
- searchedDateThe date and time when the credit history was searched.String