> ## 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 Score

> The Credit Score API provides a score and comprehensive summary of an individual's credit history, linked to their Bank Verification Number (BVN). This API is designed to give financial institutions, lenders, and credit agencies a quick and accurate overview of a user's creditworthiness, including outstanding loans, repayment history, and overall credit behavior.

Use with the BVN Number

### Request

```http [GET] theme={null}
{{baseUrl}}/api/v1/fico_score
```

### Header

| Header        | Type   | Description                                                                                         |
| ------------- | ------ | --------------------------------------------------------------------------------------------------- |
| AppId         | string | Create an app to get your app ID on dashboard [here](https://app.dojah.io/developers/configuration) |
| Authorization | string | Private/secret key. Use `<key>` not `Bearer <key>`                                                  |

### Query parameter

| Parameter | Type   | Description            | Required |
| --------- | ------ | ---------------------- | -------- |
| bvn       | string | BVN Number of Customer | required |

### Sample response

```json Response theme={null}
{
    "entity": {
        "bvn": "1*****78901",
        "name": "Ndaka Kadir Hassan",
        "phone": "081234567789",
        "gender": "Male",
        "dateOfBirth": "18/02/1994",
        "address": "ELEGANZA HOUSE,15B JOSEPH WESLEY STR.BROAD STREET   025 NG   LAGOS NIGERIA ",
        "email": "",
        "score": {
            "totalNoOfDelinquentFacilities": 2,
            "hasLoans": "YES",
            "ficoScore": {
                "score": 610,
                "rating": "AVERAGE",
                "reasons": "There is serious delinquency on the accounts, adverse record or collection filed on the credit report. Lack of recent revolving/charge account information on the credit report. There is delinquency on the accounts on credit report. Lack of recent revolving/charge account information on the credit report."
            },
            "lastReportedDate": "30-APR-2021",
            "crcReportOrderNumber": "W-0032057385/2021"
        },
        "searchedDate": "2023-12-20T11:56:38.886Z",
        "customer_id": "25379c18-40a9-4b24-9504-fcdc0f1d47ab"
    }
}
```

### Response Fields

| Field                                      | Type   | Description                                               |
| ------------------------------------------ | ------ | --------------------------------------------------------- |
| entity                                     | object | Contains the credit score response data                   |
| entity.bvn                                 | string | The Bank Verification Number                              |
| entity.name                                | string | Full name of the individual                               |
| entity.phone                               | string | Phone number associated with the BVN                      |
| entity.gender                              | string | Gender of the individual                                  |
| entity.dateOfBirth                         | string | Date of birth of the individual (DD/MM/YYYY)              |
| entity.address                             | string | Registered address of the individual                      |
| entity.email                               | string | Email address of the individual (may be empty)            |
| entity.score                               | object | Credit score and loan summary                             |
| entity.score.totalNoOfDelinquentFacilities | number | Total number of delinquent (defaulting) credit facilities |
| entity.score.hasLoans                      | string | Whether the individual has loans (`YES` or `NO`)          |
| entity.score.ficoScore                     | object | FICO credit score details                                 |
| entity.score.ficoScore.score               | number | Numeric FICO score (typically 300–850)                    |
| entity.score.ficoScore.rating              | string | Credit rating category (e.g., `AVERAGE`, `GOOD`, `POOR`)  |
| entity.score.ficoScore.reasons             | string | Explanation of factors affecting the credit score         |
| entity.score.lastReportedDate              | string | Date of the most recent credit report entry (DD-MMM-YYYY) |
| entity.score.crcReportOrderNumber          | string | CRC report order reference number                         |
| entity.searchedDate                        | string | ISO 8601 timestamp of when the query was performed        |
| entity.customer\_id                        | string | Unique customer identifier for the query                  |