> ## 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 (FCB)

> Run an FCB credit check for a Zimbabwean individual and return their credit score and status.

<div className="dj-endpoint">
  <span className={`dj-method dj-method-get`}>GET</span>
  <code>/api/v1/zw/kyc/fcb</code>
</div>

Run an FCB credit check for a Zimbabwean individual and return their credit score and status.

## 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                        |
| ---------------- | ------ | -------- | ---------------------------------- |
| `id_number`      | string | Yes      | The Zimbabwean National ID number. |
| `dob`            | string | Yes      | Date of birth, `YYYY-MM-DD`.       |
| `name`           | string | Yes      | The individual's first name.       |
| `surname`        | string | Yes      | The individual's last name.        |
| `gender`         | string | Yes      | `M` or `F`.                        |
| `marital_status` | string | Yes      | `M` (married) or `S` (single).     |
| `mobile_number`  | string | Yes      | The individual's contact number.   |

## Response

Returns an `entity` object with the individual’s credit score and status.

## 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.                                                  |
| `424` | The upstream source was unavailable — retry shortly.                                          |
| `429` | Too many requests — back off and retry.                                                       |

<RequestExample>
  ```bash cURL theme={null}
  curl --request GET \
    "https://api.dojah.io/api/v1/zw/kyc/fcb?id_number=12345678A90&dob=1990-01-01&name=JOHN&surname=DOE&gender=M&marital_status=S&mobile_number=263771234567" \
    -H "Authorization: {{secret_key}}" \
    -H "AppId: {{app_id}}"
  ```

  ```js Node.js theme={null}
  const params = new URLSearchParams({
    "id_number": "12345678A90",
    "dob": "1990-01-01",
    "name": "JOHN",
    "surname": "DOE",
    "gender": "M",
    "marital_status": "S",
    "mobile_number": "263771234567",
  });

  const url = "https://api.dojah.io/api/v1/zw/kyc/fcb?" + 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/zw/kyc/fcb",
      headers={
          "Authorization": os.environ["DOJAH_SECRET_KEY"],
          "AppId": os.environ["DOJAH_APP_ID"],
      },
      params={
          "id_number": "12345678A90",
          "dob": "1990-01-01",
          "name": "JOHN",
          "surname": "DOE",
          "gender": "M",
          "marital_status": "S",
          "mobile_number": "263771234567",
      },
  )
  data = res.json()
  ```
</RequestExample>

<ResponseExample>
  ```json GET /api/v1/zw/kyc/fcb theme={null}
  {
    "entity": {
      "id_number": "12345678A90",
      "full_name": "JOHN DOE MUSA",
      "dob": "1901-01-01",
      "gender": "F",
      "score": 288,
      "status": "GOOD"
    }
  }
  ```
</ResponseExample>
