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

# Ghana ID Card

> Verify a customer's identity using their Ghana Card number.

The Ghana ID Card endpoint validates a Ghana Card number and returns the associated personal details including name, date of birth, address, and photo.

## Endpoint

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

## Request

### Headers

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

### Body Parameters

| Parameter               | Type   | Required | Description                                                  |
| ----------------------- | ------ | -------- | ------------------------------------------------------------ |
| `identification_number` | string | Yes      | The customer's Ghana Card number (format: `GHA-000000000-0`) |

### Example

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

## Response

### 200 OK

| Field                      | Type   | Description                     |
| -------------------------- | ------ | ------------------------------- |
| `data.FullName`            | string | Full name                       |
| `data.FirstName`           | string | First name                      |
| `data.LastName`            | string | Last name                       |
| `data.OtherNames`          | string | Other names                     |
| `data.DOB`                 | string | Date of birth (`YYYY-MM-DD`)    |
| `data.Gender`              | string | Gender                          |
| `data.PhoneNumber`         | string | Registered phone number         |
| `data.Address`             | string | Registered address              |
| `data.Country`             | string | Country                         |
| `data.IDNumber`            | string | Ghana Card number               |
| `data.IssuanceDate`        | string | Card issue date                 |
| `data.ExpirationDate`      | string | Card expiry date                |
| `data.Secondary_ID_Number` | string | Secondary identification number |
| `data.Photo`               | string | Base64-encoded ID photo         |

```json theme={null}
{
  "status": "success",
  "data": {
    "DOB": "2000-09-20",
    "Photo": "<base64-encoded-jpeg>",
    "Gender": "Male",
    "Address": "OPHELIA JUNCTION, Barimah Close, ESSERESO, BOSOMTWE, ASHANTI, Ghana",
    "Country": "Ghana",
    "FullName": "Joe Leo Doe",
    "IDNumber": "GHA-000000000-0",
    "LastName": "Leo",
    "FirstName": "Joe",
    "OtherNames": "Leo",
    "PhoneNumber": "0000000",
    "IssuanceDate": "2020-08-07",
    "ExpirationDate": "2030-08-07",
    "Secondary_ID_Number": "AQ0000000"
  },
  "message": "Ghana 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: 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
                - id_type
              properties:
                identification_number:
                  type: string
                  description: >-
                    Ghana Card, Passport, Voter ID, SSNIT, or Driver's License
                    number
                id_type:
                  type: string
                  description: GhanaCard, Passport, VoterID, SSNIT, or DriversLicense
      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

````