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

# Validate Ghana Digital Addresses

> Validate a Ghana digital address (GhanaPost GPS format) for any location in Ghana. Returns whether the address is valid and can be used for verification.

### Request

```http [GET] theme={null}
{{baseUrl}}/api/v1/gh/kyc/address/gps
```

### Header

| Header        | Type   | Description                                                                                         |
| ------------- | ------ | --------------------------------------------------------------------------------------------------- |
| AppId         | string | Create an app to get your app ID on dashboard [here](https://app.dojah.io/developers/configuration) |
| Authorization | string | Private/secret key. Use `<key>` not `Bearer <key>`                                                  |

### Query parameter

| Parameter | Type   | Description                              | Required |
| --------- | ------ | ---------------------------------------- | -------- |
| address   | string | The Digital Address Number (AK-012-3456) | required |

### Sample response

```json Response theme={null}
{
  "entity": {
     "street_name": "Mercy Cl",
     "region": "Western",
     "district": "District Name",
     "community": "Kwaso Community",
     "postal_area": "Western",
     "post_code": "WS001",
     "location": "4.930449802346897,-1.736600565930667"
  }
}
```

### Response Fields

| Field               | Type   | Description                                         |
| ------------------- | ------ | --------------------------------------------------- |
| entity              | object | Contains the verification response data             |
| entity.street\_name | string | Name of the street at the digital address           |
| entity.region       | string | Region where the address is located                 |
| entity.district     | string | District where the address is located               |
| entity.community    | string | Community or neighborhood name                      |
| entity.postal\_area | string | Postal area for the address                         |
| entity.post\_code   | string | Post code for the address                           |
| entity.location     | string | GPS coordinates of the address (latitude,longitude) |
