Lookup Ghana Passport - Dojah Inc

curl --request GET \
  "https://api.dojah.io/api/v1/gh/kyc/passport?id=G0000000" \
  -H "Authorization: {{secret_key}}" \
  -H "AppId: {{app_id}}"

const params = new URLSearchParams({
  "id": "G0000000",
});

const url = "https://api.dojah.io/api/v1/gh/kyc/passport?" + 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/passport",
    headers={
        "Authorization": os.environ["DOJAH_SECRET_KEY"],
        "AppId": os.environ["DOJAH_APP_ID"],
    },
    params={ "id": "G0000000" },
)
data = res.json()

{
  "entity": {
    "id": "G0000000",
    "first_name": "John",
    "middle_name": "Doe",
    "last_name": "Musa",
    "date_of_birth": "1990-04-05",
    "gender": "MALE",
    "issue_date": "2017-11-03",
    "expiry_date": "2022-10-03",
    "place_of_birth": "TEMA",
    "place_of_issue": "ACCRA",
    "picture": "/9j/4AAQSkZJRg…",
    "is_first_name_match": false,
    "is_middle_name_match": true,
    "is_last_name_match": true,
    "is_date_of_birth_match": true
  }
}

GET/api/v1/gh/kyc/passport

Verify a Ghanaian international passport and fetch the holder’s details from the immigration database.

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
`id`	string	Yes	The passport number.

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/passport?id=G0000000" \
  -H "Authorization: {{secret_key}}" \
  -H "AppId: {{app_id}}"

const params = new URLSearchParams({
  "id": "G0000000",
});

const url = "https://api.dojah.io/api/v1/gh/kyc/passport?" + 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/passport",
    headers={
        "Authorization": os.environ["DOJAH_SECRET_KEY"],
        "AppId": os.environ["DOJAH_APP_ID"],
    },
    params={ "id": "G0000000" },
)
data = res.json()

{
  "entity": {
    "id": "G0000000",
    "first_name": "John",
    "middle_name": "Doe",
    "last_name": "Musa",
    "date_of_birth": "1990-04-05",
    "gender": "MALE",
    "issue_date": "2017-11-03",
    "expiry_date": "2022-10-03",
    "place_of_birth": "TEMA",
    "place_of_issue": "ACCRA",
    "picture": "/9j/4AAQSkZJRg…",
    "is_first_name_match": false,
    "is_middle_name_match": true,
    "is_last_name_match": true,
    "is_date_of_birth_match": true
  }
}