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

# Carte d'identité Ghana

> Vérifiez l'identité d'un client à l'aide de son numéro de Carte d'identité Ghana.

L'endpoint Carte d'identité Ghana valide un numéro de Carte d'identité Ghana et renvoie les détails personnels associés incluant le nom, la date de naissance, l'adresse et la photo.

## Endpoint

```
POST /api/onboarding/ghana_kyc/id_card/
```

## 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 de Carte d'identité Ghana du client (format : `GHA-000000000-0`) |

### Exemple

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

## Réponse

### 200 OK

| Champ               | Type   | Description                       |
| ------------------- | ------ | --------------------------------- |
| `data.FullName`     | string | Nom complet                       |
| `data.FirstName`    | string | Prénom                            |
| `data.LastName`     | string | Nom de famille                    |
| `data.OtherNames`   | string | Autres noms                       |
| `data.DOB`          | string | Date de naissance (`YYYY-MM-DD`)  |
| `data.Gender`       | string | Genre                             |
| `data.PhoneNumber`  | string | Numéro de téléphone enregistré    |
| `data.Address`      | string | Adresse enregistrée               |
| `data.Country`      | string | Pays                              |
| `data.IDNumber`     | string | Numéro de Carte d'identité Ghana  |
| `data.IssuanceDate` | string | Date de délivrance de la carte    |
| `data.ExpiryDate`   | string | Date d'expiration de la carte     |
| `data.Photo`        | string | Photo du client encodée en base64 |

```json theme={null}
{
  "status": "success",
  "data": {
    "FullName": "JOHN DOE",
    "FirstName": "JOHN",
    "LastName": "DOE",
    "OtherNames": "",
    "DOB": "1990-01-15",
    "Gender": "Male",
    "PhoneNumber": "+233501234567",
    "Address": "ACCRA",
    "Country": "GHANA",
    "IDNumber": "GHA-000000000-0",
    "IssuanceDate": "2020-01-15",
    "ExpiryDate": "2030-01-15",
    "Photo": "<base64-encoded-jpeg>"
  },
  "message": "ID Card 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/ghana_kyc/id_card/
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/ghana_kyc/id_card/:
    post:
      tags:
        - Ghana KYC
      summary: Ghana ID Card
      operationId: ghanaIdCard
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - identification_number
              properties:
                identification_number:
                  type: string
                  description: The customer's Ghana Card number
      responses:
        '200':
          description: ID card 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

````