Validate a Ghana Digital Address - Dojah Inc

curl --request GET \
  "https://api.dojah.io/api/v1/gh/kyc/address/gps?address=AK-012-3456" \
  -H "Authorization: {{secret_key}}" \
  -H "AppId: {{app_id}}"

const params = new URLSearchParams({
  "address": "AK-012-3456",
});

const url = "https://api.dojah.io/api/v1/gh/kyc/address/gps?" + params;
const res = await fetch(url, {
  headers: {
    Authorization: process.env.DOJAH_SECRET_KEY,
    AppId: process.env.DOJAH_APP_ID,
  },
});
const data = await res.json();

import os, requests

res = requests.get(
    "https://api.dojah.io/api/v1/gh/kyc/address/gps",
    headers={
        "Authorization": os.environ["DOJAH_SECRET_KEY"],
        "AppId": os.environ["DOJAH_APP_ID"],
    },
    params={ "address": "AK-012-3456" },
)
data = res.json()

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

GET/api/v1/gh/kyc/address/gps

Validate a Ghana digital address (GhanaPost GPS code) and return its location details.

Headers

Header	Required	Description
`Authorization`	Yes	Your app’s secret key, sent as-is — not `Bearer`.
`AppId`	Yes	The App ID from your dashboard.

Query parameters

Parameter	Type	Required	Description
`address`	string	Yes	The digital address / GhanaPost GPS code, e.g. `AK-012-3456`.

Response

Returns an entity object with the record for the supplied identifier.

Errors

Code	Meaning
`400`	Bad request — a required parameter is missing or malformed.
`401`	Unauthorized — check your key and `AppId` (no `Bearer` prefix).
`402`	Insufficient wallet balance. Fund your wallet.
`404`	No record found for the supplied identifier.
`424`	The upstream source was unavailable — retry shortly.
`429`	Too many requests — back off and retry.

curl --request GET \
  "https://api.dojah.io/api/v1/gh/kyc/address/gps?address=AK-012-3456" \
  -H "Authorization: {{secret_key}}" \
  -H "AppId: {{app_id}}"

const params = new URLSearchParams({
  "address": "AK-012-3456",
});

const url = "https://api.dojah.io/api/v1/gh/kyc/address/gps?" + params;
const res = await fetch(url, {
  headers: {
    Authorization: process.env.DOJAH_SECRET_KEY,
    AppId: process.env.DOJAH_APP_ID,
  },
});
const data = await res.json();

import os, requests

res = requests.get(
    "https://api.dojah.io/api/v1/gh/kyc/address/gps",
    headers={
        "Authorization": os.environ["DOJAH_SECRET_KEY"],
        "AppId": os.environ["DOJAH_APP_ID"],
    },
    params={ "address": "AK-012-3456" },
)
data = res.json()

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