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

# Numéro National d'Identité (NIN)

> Vérifiez l'identité d'un client à l'aide de son Numéro National d'Identification à 11 chiffres.

L'endpoint NIN récupère les données d'identité vérifiées d'un client depuis la base de données de la National Identity Management Commission (NIMC). Il renvoie des détails personnels complets incluant les données biographiques, les informations de contact de proche et une photo du client.

## Endpoint

```
POST /api/onboarding/nigeria_kyc/nin/
```

## 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                                                 |
| ----------------------- | ------ | ------ | ----------------------------------------------------------- |
| `identification_number` | string | Oui    | Le Numéro National d'Identification à 11 chiffres du client |

### Exemple

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

  ```javascript Node.js theme={null}
  const response = await fetch(
    "https://adhere-api.smartcomply.com/api/onboarding/nigeria_kyc/nin/",
    {
      method: "POST",
      headers: {
        "x-access-token": "YOUR_SECRET_KEY",
        "Content-Type": "application/json",
      },
      body: JSON.stringify({ identification_number: "70123456789" }),
    }
  );
  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.post(
      "https://adhere-api.smartcomply.com/api/onboarding/nigeria_kyc/nin/",
      headers={
          "x-access-token": "YOUR_SECRET_KEY",
          "Content-Type": "application/json",
      },
      json={"identification_number": "70123456789"},
  )
  data = response.json()
  ```
</CodeGroup>

## Réponse

### 200 OK

| Champ                   | Type           | Description                                     |
| ----------------------- | -------------- | ----------------------------------------------- |
| `data.nin`              | string         | Le NIN qui a été interrogé                      |
| `data.firstName`        | string         | Prénom                                          |
| `data.middleName`       | string         | Deuxième prénom                                 |
| `data.lastName`         | string         | Nom de famille                                  |
| `data.gender`           | string         | `"male"` ou `"female"`                          |
| `data.dateOfBirth`      | string         | Date de naissance au format `YYYY-MM-DD`        |
| `data.birthState`       | string         | État de naissance                               |
| `data.birthLga`         | string         | Zone de gouvernement local de naissance         |
| `data.telephoneNo`      | string         | Numéro de téléphone enregistré                  |
| `data.email`            | string \| null | Adresse e-mail (si disponible)                  |
| `data.residenceAddress` | string         | Adresse de résidence actuelle                   |
| `data.residenceState`   | string         | État de résidence                               |
| `data.residenceLga`     | string         | Zone de gouvernement local de résidence         |
| `data.residenceTown`    | string         | Ville de résidence                              |
| `data.maritalStatus`    | string         | Par ex. `"single"`, `"married"`, `"separated"`  |
| `data.educationalLevel` | string         | Niveau d'éducation le plus élevé                |
| `data.employmentStatus` | string         | Par ex. `"employed"`, `"unemployed"`            |
| `data.religion`         | string         | Religion                                        |
| `data.spokenLanguage`   | string         | Langue principale parlée                        |
| `data.height`           | string         | Taille en centimètres                           |
| `data.profession`       | string         | Profession déclarée                             |
| `data.nokFirstname`     | string         | Prénom du contact de proche                     |
| `data.nokSurname`       | string         | Nom de famille du contact de proche             |
| `data.nokAddress1`      | string         | Adresse du contact de proche                    |
| `data.nokState`         | string         | État du contact de proche                       |
| `data.nokLga`           | string         | Zone de gouvernement local du contact de proche |
| `data.image`            | string         | Photo du client encodée en base64               |
| `data.trackingId`       | string         | Référence de suivi NIMC                         |

```json theme={null}
{
  "status": "success",
  "data": {
    "title": "mr",
    "lastName": "DOE",
    "firstName": "JOHN",
    "middleName": "JOSEPH",
    "gender": "male",
    "dateOfBirth": "2000-10-21",
    "birthLga": "Olamaboro",
    "birthState": "Kogi",
    "centralID": "",
    "educationalLevel": "secondary",
    "email": null,
    "nin": "12345678901",
    "employmentStatus": "unemployed",
    "height": "180",
    "maritalStatus": "separated",
    "religion": "christianity",
    "telephoneNo": "08050003000",
    "residenceAddress": "MR SNUFUSS'S HOUSE SNUFUSS STREET PHASE 3",
    "residenceLga": "Gwagwalada",
    "residenceState": "FCT Abuja",
    "residenceTown": "GWAGWALADA",
    "nokFirstname": "JOHN",
    "nokSurname": "DOE",
    "nokAddress1": "NO 6 ADUM ROAD OGUGU CENTRE",
    "nokState": "Kogi",
    "nokLga": "Olamaboro",
    "profession": "STUDENT",
    "spokenLanguage": "IGALA",
    "trackingId": "S2R0NYFO01113TR",
    "image": "<base64-encoded-jpeg>"
  },
  "message": "National Identification Number details retrieved successfully"
}
```

### 400 Bad Request

Renvoyé lorsque le NIN est manquant, malformé ou introuvable.

```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/nigeria_kyc/nin/
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/nigeria_kyc/nin/:
    post:
      tags:
        - Nigeria KYC
      summary: NIN Verification
      operationId: nin
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - identification_number
              properties:
                identification_number:
                  type: string
                  description: 11-digit National Identification Number
                  example: '70123456789'
      responses:
        '200':
          description: NIN verified successfully
        '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

````