Credit Score & Credit Summary

GET/api/v1/fico_score

Pull a customer’s credit profile from the Nigerian bureaus using their BVN. Two views: a single FICO-style score with a rating, or a full multi-bureau summary of loans, enquiries and creditors.

Headers

Header	Required	Description
`Authorization`	Yes	Your app’s secret key, sent as-is — not `Bearer`.
`AppId`	Yes	The App ID from your dashboard.

Query parameters

Parameter	Type	Required	Description
`bvn`	string	Yes	The customer’s 11-digit Bank Verification Number.

Credit Score response

GET /api/v1/fico_score returns an entity with the customer’s identity (masked bvn, name, phone, gender, date of birth, address) and a score object holding the ficoScore — its numeric score, a rating (e.g. AVERAGE) and the reasons behind it — plus delinquency counts and the last reported date.

Credit Summary

Call GET /api/v1/credit_bureau with the same bvn for an aggregated view across the bureaus (CRC, CREDIT_REGISTRY, FIRST_CENTRAL). Inside score, bureauStatus reports per-bureau success, and metrics like loanHistory, creditEnquiries, creditors, totalNoOfActiveLoans and totalOutstanding are each an array of { source, value } objects keyed by bureau. Response trimmed below.

200 — /api/v1/credit_bureau

{
  "entity": {
    "bvn": "1*****78901",
    "name": "John Doe Anon",
    "phone": "080123456789",
    "gender": "Male",
    "dateOfBirth": "01/01/1904",
    "score": {
      "bureauStatus": {
        "crc": "success",
        "creditRegistry": "success",
        "firstCentral": "success"
      },
      "totalNoOfActiveLoans": [ { "source": "CRC", "value": 1 } ],
      "totalNoOfClosedLoans": [ { "source": "CRC", "value": 2 } ],
      "totalBorrowed": [ { "source": "CRC", "value": 445800 } ],
      "totalOutstanding": [ { "source": "CRC", "value": 0 } ],
      "loanHistory": [
        { "source": "CRC", "value": [ {
          "loanProvider": "UNION BANK OF NIGERIA PLC",
          "loanAmount": "5000",
          "performanceStatus": "Performing",
          "status": "Open"
        } ] }
      ]
    },
    "searchedDate": "2023-12-13T08:42:25.835Z"
  }
}

Errors

Code	Meaning
`400`	Bad request — `bvn` missing or malformed.
`401`	Unauthorized — check your key and `AppId` (no `Bearer` prefix).
`402`	Insufficient wallet balance. Fund your wallet.
`404`	No credit record found for the supplied BVN.
`424`	Failed dependency — a credit bureau is temporarily unavailable.
`429`	Too many requests — back off and retry.

curl --request GET \
  "https://api.dojah.io/api/v1/fico_score?bvn=22222222222" \
  -H "Authorization: {{secret_key}}" \
  -H "AppId: {{app_id}}"

const params = new URLSearchParams({ "bvn": "22222222222" });

const url = "https://api.dojah.io/api/v1/fico_score?" + params;
const res = await fetch(url, {
  headers: {
    Authorization: process.env.DOJAH_SECRET_KEY,
    AppId: process.env.DOJAH_APP_ID,
  },
});
const data = await res.json();

import os, requests

res = requests.get(
    "https://api.dojah.io/api/v1/fico_score",
    headers={
        "Authorization": os.environ["DOJAH_SECRET_KEY"],
        "AppId": os.environ["DOJAH_APP_ID"],
    },
    params={ "bvn": "22222222222" },
)
data = res.json()

{
  "entity": {
    "bvn": "1*****78901",
    "name": "Ndaka Kadir Hassan",
    "phone": "081234567789",
    "gender": "Male",
    "dateOfBirth": "18/02/1994",
    "score": {
      "hasLoans": "YES",
      "totalNoOfDelinquentFacilities": 2,
      "ficoScore": {
        "score": 610,
        "rating": "AVERAGE",
        "reasons": "There is serious delinquency on the accounts…"
      },
      "lastReportedDate": "30-APR-2021"
    },
    "searchedDate": "2023-12-20T11:56:38.886Z"
  }
}

Get started

Core concepts

API Endpoints

Widget SDKs

API clients

Credit Score & Credit Summary

Headers

Query parameters

Credit Score response

Credit Summary

Errors

​Headers

​Query parameters

​Credit Score response

​Credit Summary

​Errors

Headers

Query parameters

Credit Score response

Credit Summary

Errors