​
Generate credit history data with Credit Registry

Adhere’s First Central 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/credit_registry_summary/

  • Media-Type: application/json

​
Status Codes

  • 200 OK: 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": "Credit Registry 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": {
      "totalNoOfLoans": 16,
      "totalNoOfInstitutions": 5,
      "totalNoOfActiveLoans": 1,
      "totalNoOfClosedLoans": 15,
      "totalNoOfPerformingLoans": 16,
      "totalNoOfDelinquentFacilities": 0,
      "highestLoanAmount": 1134330,
      "totalMonthlyInstallment": 0,
      "totalBorrowed": 3761267,
      "totalOutstanding": 0,
      "totalOverdue": 0,
      "maxNoOfDays": 0,
      "creditors": false,
      "creditEnquiries": false,
      "creditEnquiriesSummary": false,
      "loanPerformance": false,
      "loanHistory": false
    },
    "searchedDate": "2023-11-23T14:46:37.552Z"
  }
}

​
Field Descriptions

FieldDescriptionType
statusThis is the returned status of the request either success or failed.String
codeThis is the operational code.Number
dataThis is an array of objects which contains every transaction data.Object
- _idThe unique identifier or specific code assigned to a particular user within the database.String
- bvnThe BVN of the user.String
- customerIdThe unique identifier or specific code assigned to a particular customer.String
- businessIdThe unique identifier or specific code assigned to a particular business.String
- nameThe full name of the BVN holder.String
- phoneThe phone number of the BVN holder.String
- genderThe gender of the BVN holder.String
- dateOfBirthThe date of birth of the BVN holder.String
- addressThe address of the BVN holder.String
- emailThe email of the BVN holder.String
- scoreThis is an array of objects which contains every score.Object
-- totalNoOfDelinquentFacilitiesThe count of accounts or credit facilities that are overdue or behind on payments according to the credit report.Number
-- lastReportedDateThe most recent date on which information about an account, transaction, or activity was updated or submitted to the credit bureau.Number
-- totalNoOfLoansThe overall count of active loan accounts listed in the credit report.Number
-- totalNoOfInstitutionsThe count of different financial institutions or lenders where the user holds accounts listed within their credit report or financial records.Number
-- totalNoOfActiveLoansThe count of currently open and operational loan accounts listed in a user’s credit report or financial records.Number
-- totalBorrowedThe amount of money that an individual has borrowed across all loans, credit lines, or financial obligations listed within their credit report or financial records.Number
-- totalOutstandingThe overall amount of money that remains unpaid or outstanding across all active loans, credit accounts, or financial obligations listed within the credit report or financial records.Number
-- totalOverdueThe amount that is past due or overdue across all active loans or credit accounts listed within the credit report or financial records.Number
-- maxNoOfDaysThe longest duration an account or payment has been overdue.Number
-- totalNoOfClosedLoansThe overall count of loan accounts that have been successfully paid off or closed by the individual and are no longer active in their credit report or financial records.Number
-- crcReportOrderNumberThe report order number of the credit bureau.String
- searchedDateThe date the credit report was searched.String