> ## Documentation Index
> Fetch the complete documentation index at: https://docs.dojah.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Credit summary

> Pull a consolidated credit report for a customer from the Nigerian credit bureaus using their BVN.

<div className="dj-endpoint">
  <span className={`dj-method dj-method-get`}>GET</span>
  <code>/api/v1/credit\_bureau</code>
</div>

Pull a consolidated credit report for a customer by BVN — aggregating CRC, Credit Registry and FirstCentral — with their loan history, enquiries, creditors, and portfolio totals.

## 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 Bank Verification Number. |

## Response

Returns an `entity` with the customer’s bio-data and a `score` object aggregating each bureau’s status, credit enquiries, creditors, loan history and performance, and portfolio totals. The example is representative; the live response can be large.

## Errors

| Code  | Meaning                                                                                       |
| ----- | --------------------------------------------------------------------------------------------- |
| `400` | Bad request — a required parameter is missing or malformed.                                   |
| `401` | Unauthorized — check your key and `AppId` (no `Bearer` prefix).                               |
| `402` | Insufficient wallet balance. [Fund your wallet](/api-reference/core-concepts/wallet-billing). |
| `404` | No record found for the supplied identifier.                                                  |
| `429` | Too many requests — back off and retry.                                                       |

<RequestExample>
  ```bash cURL theme={null}
  curl --request GET \
    "https://api.dojah.io/api/v1/credit_bureau?bvn=22345678901" \
    -H "Authorization: {{secret_key}}" \
    -H "AppId: {{app_id}}"
  ```

  ```js Node.js theme={null}
  const params = new URLSearchParams({
    "bvn": "22345678901",
  });

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

  ```python Python theme={null}
  import os, requests

  res = requests.get(
      "https://api.dojah.io/api/v1/credit_bureau",
      headers={
          "Authorization": os.environ["DOJAH_SECRET_KEY"],
          "AppId": os.environ["DOJAH_APP_ID"],
      },
      params={ "bvn": "22345678901" },
  )
  data = res.json()
  ```
</RequestExample>

<ResponseExample>
  ```json GET /api/v1/credit_bureau theme={null}
  {
    "entity": {
      "address": "ELEGANZA HOUSE,15B JOSEPH WESLEY STR.BROAD STREET   025 NG   LAGOS NIGERIA ",
      "bvn": "1*****78901",
      "dateOfBirth": "01/01/1904",
      "email": "",
      "gender": "Male",
      "name": "John Doe Anon",
      "phone": "080123456789",
      "score": {
        "bureauStatus": {
          "crc": "success",
          "creditRegistry": "success",
          "firstCentral": "success"
        },
        "creditEnquiries": [
          {
            "source": "CREDIT_REGISTRY",
            "value": [
              {
                "contactPhone": "234 (1) 2798800",
                "date": "2022-11-13T00:00:00",
                "loanProvider": "Suretree Systems Limited",
                "reason": "N/A"
              }
            ]
          }
        ],
        "creditEnquiriesSummary": [
          {
            "source": "CREDIT_REGISTRY",
            "value": {
              "Last12MonthCount": "38",
              "Last36MonthCount": "101",
              "Last3MonthCount": "4"
            }
          }
        ],
        "creditors": [
          {
            "source": "CREDIT_REGISTRY",
            "value": [
              {
                "Address": "Stallion Plaza 36 Marina Lagos Island Lagos",
                "Name": "Union Bank of Nigeria Plc",
                "Phone": "0123456789",
                "Subscriber_ID": "734289734289248261"
              }
            ]
          }
        ],
        "highestLoanAmount": [ { "source": "CRC", "value": 5000 } ],
        "lastReportedDate": [ { "source": "CRC", "value": "13/Nov/2022" } ],
        "loanHistory": [
          {
            "source": "CRC",
            "value": [
              {
                "accountNumber": "01234567893",
                "dateReported": "30-Apr-2019",
                "installmentAmount": "",
                "lastPaymentDate": "",
                "loanAmount": "5000",
                "loanDuration": null,
                "loanProvider": "UNION BANK OF NIGERIA PLC",
                "outstandingBalance": "0",
                "overdueAmount": "0",
                "paymentHistory": [],
                "performanceStatus": "Performing",
                "status": "Open",
                "type": "Overdraft"
              }
            ]
          }
        ],
        "loanPerformance": [
          {
            "source": "FIRST_CENTRAL",
            "value": [
              {
                "accountNumber": "12345678928181192",
                "loanAmount": 250800,
                "loanCount": 1,
                "loanProvider": "Union Bank Nigeria Plc Lagos",
                "noOfNonPerforming": 0,
                "noOfPerforming": 1,
                "outstandingBalance": 0,
                "overdueAmount": 0,
                "performanceStatus": "Performing",
                "status": "Closed"
              }
            ]
          }
        ],
        "maxNoOfDays": [ { "source": "CRC", "value": null } ],
        "totalBorrowed": [ { "source": "CRC", "value": 445800 } ],
        "totalMonthlyInstallment": [ { "source": "CRC", "value": 10000 } ],
        "totalNoOfActiveLoans": [ { "source": "CRC", "value": 1 } ],
        "totalNoOfClosedLoans": [ { "source": "CRC", "value": 2 } ],
        "totalNoOfDelinquentFacilities": [ { "source": "CRC", "value": 0 } ],
        "totalNoOfInstitutions": [ { "source": "CRC", "value": 1 } ],
        "totalNoOfLoans": [ { "source": "CRC", "value": 3 } ],
        "totalNoOfOverdueAccounts": [ { "source": "CRC", "value": 0 } ],
        "totalNoOfPerformingLoans": [ { "source": "CRC", "value": 3 } ],
        "totalOutstanding": [ { "source": "CRC", "value": 0 } ],
        "totalOverdue": [ { "source": "CRC", "value": 0 } ]
      },
      "searchedDate": "2023-12-13T08:42:25.835Z"
    }
  }
  ```
</ResponseExample>