​
Generate Advanced Credit Registry History Report

​
Overview

Adhere’s CRC Credit Registry Report endpoint provides users with a detailed and comprehensive overview of their credit history. This includes information on credit accounts, payment timelines, credit utilization, account closures, and instances of delinquency. By utilizing this endpoint, users can effectively monitor and manage their credit standing, assess their creditworthiness, and gain insights into factors influencing their credit behavior.

​
Request Endpoint

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

  • 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": "Credit Registry Full Credit Report",
  "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": [
        {
          "Subscriber_ID": "737248693595559931",
          "Name": "NewEdge Finance Limited",
          "Phone": "008618824674241",
          "Address": "2a Isaac John Street Ikeja Lagos"
        },
        {
          "Subscriber_ID": "732699732699949972",
          "Name": "Zenith Bank Plc",
          "Phone": "012610249",
          "Address": "Zenith Heights plot 87 Ajose Adeogun Street Victoria Island Lagos"
        }
      ],
      "creditEnquiries": [
        {
          "loanProvider": "Lifegate Microfinance Bank Limited",
          "reason": "KYCCheck",
          "date": "2023-11-23T00:00:00",
          "contactPhone": "08129078564\t\t"
        },
        {
          "loanProvider": "RenMoney MFB Limited",
          "reason": "(Other)",
          "date": "2020-10-22T00:00:00",
          "contactPhone": "070073666639"
        }
      ],
      "creditEnquiriesSummary": {
        "Last3MonthCount": "3",
        "Last12MonthCount": "4",
        "Last36MonthCount": "6"
      },
      "loanPerformance": [
        {
          "loanProvider": "Sterling Bank Plc",
          "accountNumber": "0086575839",
          "loanAmount": 0,
          "outstandingBalance": 0,
          "status": "Open",
          "performanceStatus": "Performing",
          "overdueAmount": 0,
          "type": "",
          "loanDuration": "162",
          "repaymentFrequency": "",
          "repaymentBehavior": "None",
          "paymentProfile": "NNNNNNNNNNNNNNNNNN0N0N00",
          "dateAccountOpened": "2021-12-20T00:00:00",
          "lastUpdatedAt": "2023-08-22T11:24:36.21",
          "loanCount": 1,
          "monthlyInstallmentAmt": 0
        },
        {
          "loanProvider": "NewEdge Finance Limited",
          "accountNumber": "1502272832",
          "loanAmount": 35000,
          "outstandingBalance": 0,
          "status": "Closed",
          "performanceStatus": "Paid Off (Closed)",
          "overdueAmount": 0,
          "type": "Salary Advance",
          "loanDuration": "7",
          "repaymentFrequency": "Weekly",
          "repaymentBehavior": "None",
          "paymentProfile": "NNNNNNNN00NNNNNNNNNNNNNN",
          "dateAccountOpened": "2022-05-22T00:00:00",
          "lastUpdatedAt": "2023-05-12T07:37:45.837",
          "loanCount": 1,
          "monthlyInstallmentAmt": 0
        },
        {
          "loanProvider": "Page International Financial Service Limited",
          "loanProviderAddress": "23 Norman Williams St, \t\t\r\n Ikoyi Lagos",
          "accountNumber": "PM19020035779799",
          "type": "Revolving Loan",
          "loanAmount": 300000,
          "installmentAmount": 112752,
          "overdueAmount": 0,
          "lastPaymentDate": "2019-10-23T00:00:00",
          "loanDuration": "3",
          "dateReported": "2019-08-16T10:23:59.883",
          "disbursedDate": "2019-08-02T00:00:00",
          "maturityDate": "2023-09-30T00:00:00",
          "performanceStatus": "Paid Off (Closed)",
          "status": "Closed",
          "outstandingBalance": 0,
          "collateral": "",
          "collateralValue": 0,
          "guarantor": "",
          "purpose": "NA",
          "paymentHistory": "NNN000N00000080NN0N0000N",
          "lastUpdatedAt": "2023-10-13T18:33:43.007"
        },
        {
          "loanProvider": "Page International Financial Service Limited",
          "loanProviderAddress": "23 Norman Williams St, \t\t\r\n Ikoyi Lagos",
          "accountNumber": "PM19020035764935",
          "type": "Revolving Loan",
          "loanAmount": 670000,
          "installmentAmount": 86996,
          "overdueAmount": 0,
          "lastPaymentDate": "2020-02-23T00:00:00",
          "loanDuration": "12",
          "dateReported": "2019-03-22T19:02:45.997",
          "disbursedDate": "2019-02-14T00:00:00",
          "maturityDate": "2023-09-30T00:00:00",
          "performanceStatus": "Paid Off (Closed)",
          "status": "Closed",
          "outstandingBalance": 0,
          "collateral": "",
          "collateralValue": 0,
          "guarantor": "",
          "purpose": "NA",
          "paymentHistory": "NNN000N00000000000N0000N",
          "lastUpdatedAt": "2023-10-13T18:39:05.293"
        }
      ]
    },
    "searchedDate": "2023-11-23T14:47:42.824Z"
  }
}

​
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
-- totalNoOfLoansThe total number of loans taken by the individual.Number
-- totalNoOfInstitutionsThe total number of institutions the individual has loans with.Number
-- totalNoOfActiveLoansThe total number of active loans.Number
-- totalNoOfClosedLoansThe total number of loans that have been closed.Number
-- totalNoOfPerformingLoansThe total number of loans that are performing.Number
-- totalNoOfDelinquentFacilitiesThe total number of delinquent facilities.Number
-- highestLoanAmountThe highest loan amount taken by the individual.Number
-- totalMonthlyInstallmentThe total monthly installment amount, if available.Number
-- totalBorrowedThe total amount borrowed by the individual.Number
-- totalOutstandingThe total outstanding amount on loans.Number
-- totalOverdueThe total overdue amount on loans.Number
-- maxNoOfDaysThe maximum number of days overdue on any loan.Number
-- creditorsA list of creditors associated with the individual’s loans.Array
-- creditEnquiriesA list of credit enquiries made by the individual.Array
-- creditEnquiriesSummaryA summary of credit enquiries over different time periods.Object
-- loanPerformanceA list of loan performance details.Array
- searchedDateThe date and time when the credit history was searched.String