Fetch address verification data - Dojah Inc

curl --request GET \
  "https://api.dojah.io/api/v1/kyc/address?reference_id=69e10264-4b90-64fe-b4b7-c9dddafd0241" \
  -H "Authorization: {{secret_key}}" \
  -H "AppId: {{app_id}}"

const params = new URLSearchParams({
  "reference_id": "69e10264-4b90-64fe-b4b7-c9dddafd0241",
});

const url = "https://api.dojah.io/api/v1/kyc/address?" + 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/kyc/address",
    headers={
        "Authorization": os.environ["DOJAH_SECRET_KEY"],
        "AppId": os.environ["DOJAH_APP_ID"],
    },
    params={ "reference_id": "69e10264-4b90-64fe-b4b7-c9dddafd0241" },
)
data = res.json()

{
  "entity": {
    "status": "pending",
    "reference_id": "69e10264-4b90-64fe-b4b7-c9dddafd0241",
    "data": {
      "applicant": {
        "first_name": "John",
        "last_name": "Musa",
        "phone": "08012345678",
        "middle_name": "Doe",
        "photo": "",
        "gender": "Male",
        "dob": "17/01/1988"
      },
      "location": "7.081273, 8.232523",
      "photos": [""],
      "neighbor": {
        "name": "Musa Garba",
        "comment": "Very friendly",
        "phone": "080987654321"
      },
      "city": "oshodi",
      "street": "270 Murtala Muhammed Way, Alagomeji. Yaba",
      "lga": "lagos mainland",
      "state": "Lagos",
      "country": "Nigeria",
      "comments": ""
    }
  }
}

GET/api/v1/kyc/address

Address verifications run asynchronously — after submitting one you receive a reference_id. Use this endpoint to fetch the verification’s status and collected data by that reference.

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
`reference_id`	string	Yes	The unique reference returned when the address verification was submitted.

Response

Returns an entity with the verification status, the reference_id, and a data object holding the applicant, location, neighbour and address details collected.

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.
`429`	Too many requests — back off and retry.

curl --request GET \
  "https://api.dojah.io/api/v1/kyc/address?reference_id=69e10264-4b90-64fe-b4b7-c9dddafd0241" \
  -H "Authorization: {{secret_key}}" \
  -H "AppId: {{app_id}}"

const params = new URLSearchParams({
  "reference_id": "69e10264-4b90-64fe-b4b7-c9dddafd0241",
});

const url = "https://api.dojah.io/api/v1/kyc/address?" + 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/kyc/address",
    headers={
        "Authorization": os.environ["DOJAH_SECRET_KEY"],
        "AppId": os.environ["DOJAH_APP_ID"],
    },
    params={ "reference_id": "69e10264-4b90-64fe-b4b7-c9dddafd0241" },
)
data = res.json()

{
  "entity": {
    "status": "pending",
    "reference_id": "69e10264-4b90-64fe-b4b7-c9dddafd0241",
    "data": {
      "applicant": {
        "first_name": "John",
        "last_name": "Musa",
        "phone": "08012345678",
        "middle_name": "Doe",
        "photo": "",
        "gender": "Male",
        "dob": "17/01/1988"
      },
      "location": "7.081273, 8.232523",
      "photos": [""],
      "neighbor": {
        "name": "Musa Garba",
        "comment": "Very friendly",
        "phone": "080987654321"
      },
      "city": "oshodi",
      "street": "270 Murtala Muhammed Way, Alagomeji. Yaba",
      "lga": "lagos mainland",
      "state": "Lagos",
      "country": "Nigeria",
      "comments": ""
    }
  }
}