Generate credit score data with CRC

Adhere’s Credit Score endpoint provides users with essential insights into their credit history, enabling them to evaluate their creditworthiness, monitor changes, and identify the factors that impact their credit standing.

Request Endpoint

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

  • 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": "CRC Credit Score",
  "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,
      "hasLoans": "YES",
      "ficoScore": {
        "score": 717,
        "rating": "GOOD",
        "reasons": "Applicant is young relative to the other applicants scored. The length of time accounts have been established on the credit report is short relative to the other applicants scored. Time since most recent account opening on the credit report is too short relative to the other applicants scored. The length of time accounts have been established on the credit report is short relative to the other applicants scored."
      },
      "lastReportedDate": "30-SEP-2023",
      "crcReportOrderNumber": "W-0097887747/2023"
    },
    "searchedDate": "2023-11-23T14:25:54.210Z"
  }
}

Field Descriptions

FieldDescriptionType
statusThis is the returned status of the request either success or failed.String
codeThis is the operational codeNumber
dataThis is an array of objects which contains every transaction dataObject
- _idThe unique identifier or specific code assigned to a particular user within the databaseString
- bvnThe bvn of the userString
- customerIdThe unique identifier or specific code assigned to a particular customerString
- businessIdThe unique identifier or specific code assigned to a particular businessString
- nameThe full name of the BVN holderString
- phoneThe phone number of the BVN holderString
- genderThe gender of the BVN holderString
- dateOfBirthThe date of birth of the BVN holderString
- addressThe address of the BVN holderString
- emailThe email of the BVN holderString
- scoreThis is an array of objects which contains every scoreObject
-- totalNoOfDelinquentFacilitiesThe count of accounts or credit facilities that are overdue or behind on payments according to the credit reportNumber
-- hasLoansThis refers to whether an individual has an active loan or credit account listed within their credit report or financial recordsString
-- ficoScoreThe credit scoring model used to assess an individual’s credit risk and determine their creditworthinessNum
--- scoreThe credit score of an individualNumber
--- ratingThis refers to the rating of an individual based on their creditworthinessString
--- reasonsThis refers to the factors or explanations influencing an individual credit scoreString
-- lastReportedDateThis refers to the most recent date on which information about an account, transaction, or activity was updated or submitted to the credit bureauString
-- crcReportOrderNumberThe report order number of the credit bureauString
-searchedDateThe date the credit report was searchedString