Skip to main content
POST
/
api
/
onboarding
/
individual
/
credit_scores_first_central
First Central Credit Score
curl --request POST \
  --url https://adhere-api.smartcomply.com/api/onboarding/individual/credit_scores_first_central/ \
  --header 'Content-Type: application/json' \
  --header 'x-access-token: <api-key>' \
  --data '
{
  "bvn": "22244545518"
}
'
{
  "status": "failed",
  "data": [
    "<unknown>"
  ],
  "message": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.smartcomply.com/llms.txt

Use this file to discover all available pages before exploring further.

The First Central Credit Score endpoint returns an individual’s consumer credit score from the First Central bureau, along with account condition summaries, outstanding debt totals, and score breakdown metrics.

Endpoint

POST /api/onboarding/individual/credit_scores_first_central/

Request

Headers

HeaderValueRequired
x-access-tokenYour API secret keyYes
Content-Typeapplication/jsonYes

Body Parameters

ParameterTypeRequiredDescription
bvnstringYesThe individual’s 11-digit Bank Verification Number

Example

curl -X POST "https://adhere-api.smartcomply.com/api/onboarding/individual/credit_scores_first_central/" \
  -H "x-access-token: YOUR_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{"bvn": "22244545518"}'

Response

200 OK

FieldTypeDescription
data.score.totalConsumerScorestringOverall consumer credit score
data.score.descriptionstringRisk rating (e.g. "LOW RISK", "HIGH RISK")
data.score.totalAccountsstringTotal accounts on record
data.score.totalaccountinGoodconditionstringAccounts in good standing
data.score.totalaccountinBadconditionstringAccounts in bad standing
data.score.totalOutstandingDebtstringTotal outstanding debt
data.score.totalAmountOverduestringTotal amount overdue
data.score.repaymentHistoryScorestringRepayment history score component
data.score.firstCentralEnquiryResultIDstringFirst Central enquiry result ID
{
  "status": "success",
  "data": {
    "_id": "64f600608aaf9386c646de32",
    "bvn": "22244545518",
    "name": "ADELEKE EMMANUEL AYORINDE",
    "score": {
      "totalConsumerScore": "835",
      "description": "LOW RISK",
      "totalAccounts": "23",
      "scoreDate": "11/23/2023",
      "noOfAcctScore": "55/55",
      "totalaccountinGoodcondition": "23",
      "totalaccountinBadcondition": "0",
      "totalOutstandingDebt": "30,719.00",
      "totalAccountarrear": "0",
      "totalAmountOverdue": "0.00",
      "repaymentHistoryScore": "192/192",
      "totalAmountOwedScore": "165/165",
      "firstCentralEnquiryResultID": "37181617"
    },
    "searchedDate": "2023-11-23T14:37:04.152Z"
  },
  "message": "Credit Scores individual first central report details retrieved successfully"
}

400 Bad Request

{
  "status": "failed",
  "data": [],
  "message": "Sorry, your check cannot be processed at the moment. Please try again in a few minutes"
}

401 Unauthorized

{
  "status": "failed",
  "message": "Authentication credentials were not provided."
}

Authorizations

x-access-token
string
header
required

Your Adhere API secret key

Body

application/json
bvn
string
required
Example:

"22244545518"

Response

First Central credit score retrieved