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

# Zimbabwe Credit Check

> Run a credit check for a Zimbabwean consumer. Returns credit report and score for lending and risk decisions.

### Request

```http [GET] theme={null}
{{baseURL}}/api/v1/zw/kyc/fcb
```

### 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 |
| ----------------- | ------ | ---------------------------------- | -------- |
| id\_number \*     | string | Zimbabwian National ID             | required |
| dob \*            | string | Date of birth in YYYY-MM-DD format | required |
| name \*           | string |                                    | required |
| surname \*        | string |                                    | required |
| gender\*          | string | M or F                             | required |
| marital\_status\* | string | M or S                             | required |
| mobile\_number\*  | string |                                    | required |

### Sample response

uxzz

```json Response theme={null}
{
    "entity": {
        "dob": "1901-01-01",
        "full_name": "JOHN DOE MUSA",
        "score": 288,
        "status": "GOOD",
        "gender": "F",
        "id_number": "12345678A90"
    }
}
```

### Response Fields

| Field             | Type   | Description                             |
| ----------------- | ------ | --------------------------------------- |
| entity            | object | Contains the credit check response data |
| entity.dob        | string | Date of birth in YYYY-MM-DD format      |
| entity.full\_name | string | Full name of the individual             |
| entity.score      | number | Credit score value                      |
| entity.status     | string | Credit status (e.g., GOOD, POOR)        |
| entity.gender     | string | Gender of the individual (M or F)       |
| entity.id\_number | string | Zimbabwean National ID Number           |