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

# National ID Advanced

> Retrieve extended identity details for a Kenyan national ID, including photo, place of birth, and residence.

The National ID Advanced endpoint returns comprehensive identity information for a Kenyan national ID, including the registrant's photo, place of birth, place of residence, and issue details.

## Endpoint

```
POST /api/onboarding/kenya_kyc/national_id_advance/
```

## Request

### Headers

| Header           | Value               | Required |
| ---------------- | ------------------- | -------- |
| `x-access-token` | Your API secret key | Yes      |
| `Content-Type`   | `application/json`  | Yes      |

### Body Parameters

| Parameter     | Type    | Required | Description                              |
| ------------- | ------- | -------- | ---------------------------------------- |
| `national_id` | integer | Yes      | The customer's Kenyan national ID number |

### Example

<CodeGroup>
  ```bash cURL theme={null}
  curl -X POST "https://adhere-api.smartcomply.com/api/onboarding/kenya_kyc/national_id_advance/" \
    -H "x-access-token: YOUR_SECRET_KEY" \
    -H "Content-Type: application/json" \
    -d '{"national_id": 1010101010}'
  ```
</CodeGroup>

## Response

### 200 OK

| Field                 | Type   | Description                   |
| --------------------- | ------ | ----------------------------- |
| `data.First_Name`     | string | First name                    |
| `data.Surname`        | string | Surname                       |
| `data.Other_Name`     | string | Other/middle name             |
| `data.Gender`         | string | Gender (`"M"` or `"F"`)       |
| `data.Date_of_Birth`  | string | Date of birth                 |
| `data.Citizenship`    | string | Citizenship status            |
| `data.Date_of_Issue`  | string | ID issue date                 |
| `data.Place_of_Birth` | string | Place of birth                |
| `data.Place_of_Live`  | string | Registered place of residence |
| `data.Photo`          | string | Base64-encoded ID photo       |

```json theme={null}
{
  "status": "success",
  "data": {
    "Pin": "",
    "Clan": "",
    "Photo": "<base64-encoded-jpeg>",
    "Family": "",
    "Gender": "M",
    "Surname": "Leo",
    "RegOffice": "",
    "First_Name": "Joe",
    "Occupation": "",
    "Other_Name": "Doe",
    "Citizenship": "Kenyan",
    "Date_of_Birth": "2000-09-20 12:00:00 AM",
    "Date_of_Death": "",
    "Date_of_Issue": "1/27/2000 12:00:00 AM",
    "Place_of_Live": "BOX 12345-00800 NAIROBI\nKAREN\nKAREN\nLOCATION - LANGATA\nDIVISION - KIBERA\nDISTRICT - STAREHE",
    "Serial_Number": 0,
    "Place_of_Birth": "NAIROBI\nDISTRICT - STAREHE",
    "Place_of_Death": ""
  },
  "message": "National ID Advance details retrieved successfully"
}
```

### 400 Bad Request

```json theme={null}
{
  "status": "failed",
  "data": [],
  "message": "Sorry, your check cannot be processed at the moment. Please try again in a few minutes"
}
```

### 401 Unauthorized

```json theme={null}
{
  "status": "failed",
  "message": "Authentication credentials were not provided."
}
```


## OpenAPI

````yaml POST /api/onboarding/kenya_kyc/national_id_advance/
openapi: 3.0.3
info:
  title: Adhere API
  description: >-
    Identity verification, credit checks, transaction monitoring, and loan fraud
    detection across Africa.
  version: 3.0.0
servers:
  - url: https://adhere-api.smartcomply.com
    description: Production
security:
  - ApiKeyAuth: []
tags:
  - name: Nigeria KYC
  - name: Kenya KYC
  - name: Ghana KYC
  - name: Rwanda KYC
  - name: Uganda KYC
  - name: Biometrics
  - name: Individual Credit
  - name: Business Credit
  - name: Transaction Monitoring
  - name: Transaction Screening
  - name: Transaction KYC
  - name: Loan Fraud
  - name: User Journey
paths:
  /api/onboarding/kenya_kyc/national_id_advance/:
    post:
      tags:
        - Kenya KYC
      summary: Kenya National ID Advanced
      operationId: kenyaNationalIdAdvanced
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - id_number
              properties:
                id_number:
                  type: string
                  example: '12345678'
      responses:
        '200':
          description: National ID advanced data retrieved
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  responses:
    BadRequest:
      description: Bad Request
      content:
        application/json:
          schema:
            type: object
            properties:
              status:
                type: string
                example: failed
              data:
                type: array
                items: {}
              message:
                type: string
    Unauthorized:
      description: Unauthorized
      content:
        application/json:
          schema:
            type: object
            properties:
              status:
                type: string
                example: failed
              message:
                type: string
                example: Authentication credentials were not provided.
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-access-token
      description: Your Adhere API secret key

````