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

# SA National ID

> Verify a South African National ID and fetch holder details from the national population register. With or without photograph.

### SA National ID without photograph

### Request

```http [GET] theme={null}
{{baseURL}}/api/v1/za/kyc/id
```

### 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 | South African National ID Number | required |

### Sample Response

```json Response theme={null}
{
    "entity": {
        "id_number": "1234567890192",
        "first_name": "JOHN",
        "last_name": "MUSA",
        "middle_name": "DOE",
        "date_of_birth": "1900-12-18",
        "phone_number": "",
        "address": "",
        "marital_status": "SINGLE",
        "gender": "Male",
        "issued_date": "2020-01-20",
        "full_name": "JOHN DOE MUSA",
        "smart_card_issued": "YES",
        "card_date": "2020-01-20",
        "book_date": "2020-01-20",
        "living_status": "ALIVE"
    }
}
```

### Response Fields

| Field                      | Type   | Description                                         |
| -------------------------- | ------ | --------------------------------------------------- |
| entity                     | object | Contains the verification response data             |
| entity.id\_number          | string | South African National ID Number                    |
| entity.first\_name         | string | First name of the individual                        |
| entity.last\_name          | string | Last name of the individual                         |
| entity.middle\_name        | string | Middle name of the individual                       |
| entity.date\_of\_birth     | string | Date of birth in YYYY-MM-DD format                  |
| entity.phone\_number       | string | Phone number of the individual                      |
| entity.address             | string | Residential address of the individual               |
| entity.marital\_status     | string | Marital status (e.g., SINGLE, MARRIED)              |
| entity.gender              | string | Gender of the individual                            |
| entity.issued\_date        | string | Date the ID was issued in YYYY-MM-DD format         |
| entity.full\_name          | string | Full name of the individual                         |
| entity.smart\_card\_issued | string | Whether a smart ID card was issued (YES or NO)      |
| entity.card\_date          | string | Date the smart card was issued in YYYY-MM-DD format |
| entity.book\_date          | string | Date the ID book was issued in YYYY-MM-DD format    |
| entity.living\_status      | string | Living status of the individual (e.g., ALIVE)       |

### SA National ID with photograph

### Request

```http [GET] theme={null}
{{baseURL}}/api/v1/za/kyc/id_withphoto
```

### 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 | South African National ID Number | required |

### Sample Response

```json Response theme={null}
{
    "entity": {
        "id_number": "1234567890192",
        "first_name": "JOHN",
        "last_name": "MUSA",
        "middle_name": "DOE",
        "date_of_birth": "1900-12-18",
        "phone_number": "",
        "address": "",
        "photo": "/9j/2wBDA19sjwj2j2j2j2j2j1w",
        "marital_status": "SINGLE",
        "gender": "Male",
        "issued_date": "2020-01-20",
        "full_name": "JOHN DOE MUSA",
        "smart_card_issued": "YES",
        "card_date": "2020-01-20",
        "book_date": "2020-01-20",
        "living_status": "ALIVE"
    }
}
```

### Response Fields

| Field                      | Type   | Description                                         |
| -------------------------- | ------ | --------------------------------------------------- |
| entity                     | object | Contains the verification response data             |
| entity.id\_number          | string | South African National ID Number                    |
| entity.first\_name         | string | First name of the individual                        |
| entity.last\_name          | string | Last name of the individual                         |
| entity.middle\_name        | string | Middle name of the individual                       |
| entity.date\_of\_birth     | string | Date of birth in YYYY-MM-DD format                  |
| entity.phone\_number       | string | Phone number of the individual                      |
| entity.address             | string | Residential address of the individual               |
| entity.photo               | string | Base64-encoded photograph of the individual         |
| entity.marital\_status     | string | Marital status (e.g., SINGLE, MARRIED)              |
| entity.gender              | string | Gender of the individual                            |
| entity.issued\_date        | string | Date the ID was issued in YYYY-MM-DD format         |
| entity.full\_name          | string | Full name of the individual                         |
| entity.smart\_card\_issued | string | Whether a smart ID card was issued (YES or NO)      |
| entity.card\_date          | string | Date the smart card was issued in YYYY-MM-DD format |
| entity.book\_date          | string | Date the ID book was issued in YYYY-MM-DD format    |
| entity.living\_status      | string | Living status of the individual (e.g., ALIVE)       |