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

# Alien ID

> Vérifiez l'identité d'un client à l'aide de son numéro d'identification Alien du Kenya.

L'endpoint Alien ID valide un numéro d'identification Alien du Kenya et renvoie les détails personnels associés depuis le registre national.

## Endpoint

```
POST /api/onboarding/kenya_kyc/alien_id/
```

## Requête

### En-têtes

| En-tête          | Valeur                | Requis |
| ---------------- | --------------------- | ------ |
| `x-access-token` | Votre clé secrète API | Oui    |
| `Content-Type`   | `application/json`    | Oui    |

### Paramètres de corps

| Paramètre  | Type   | Requis | Description                                |
| ---------- | ------ | ------ | ------------------------------------------ |
| `alien_id` | string | Oui    | Le numéro d'identification Alien du client |

### Exemple

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

## Réponse

### 200 OK

| Champ                | Type    | Description                       |
| -------------------- | ------- | --------------------------------- |
| `data.valid`         | boolean | Si la carte d'identité est valide |
| `data.id_number`     | string  | Numéro Alien ID                   |
| `data.first_name`    | string  | Prénom                            |
| `data.last_name`     | string  | Nom de famille                    |
| `data.middle_name`   | string  | Deuxième prénom                   |
| `data.date_of_birth` | string  | Date de naissance                 |
| `data.gender`        | string  | Genre                             |
| `data.nationality`   | string  | Nationalité                       |

```json theme={null}
{
  "status": "success",
  "data": {
    "valid": true,
    "id_number": "1000000",
    "first_name": "JAMES",
    "last_name": "KARIUKI",
    "middle_name": "MWANGI",
    "date_of_birth": "1990-04-15",
    "gender": "Male",
    "nationality": "Ugandan"
  },
  "message": "Alien ID 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"
}
```


## OpenAPI

````yaml POST /api/onboarding/kenya_kyc/alien_id/
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: Document Verification
  - 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/alien_id/:
    post:
      tags:
        - Kenya KYC
      summary: Kenya Alien ID
      operationId: kenyaAlienId
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - alien_id
              properties:
                alien_id:
                  type: string
                  description: Alien ID number for non-citizen residents
      responses:
        '200':
          description: Alien ID verified
        '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

````