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

[GET]

{{baseUrl}}/api/v1/gh/kyc/address/gps

Header

Header	Type	Description
AppId	string	Create an app to get your app ID on dashboard here
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

Response

{
  "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)