GET
Verify a Ugandan National Identification Number (NIN) and fetch the holderβs details.
/api/v1/ug/kyc/ninHeaders
| 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 |
|---|---|---|---|
nin | string | Yes | National Identification Number (NIN). |
first_name | string | No | The first name of the document holder. |
last_name | string | No | The last name of the document holder. |
Response
Returns anentity object with the holderβs record.
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/ug/kyc/nin?nin=CM123456789AB" \
-H "Authorization: {{secret_key}}" \
-H "AppId: {{app_id}}"
const params = new URLSearchParams({
"nin": "CM123456789AB",
});
const url = "https://api.dojah.io/api/v1/ug/kyc/nin?" + 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/ug/kyc/nin",
headers={
"Authorization": os.environ["DOJAH_SECRET_KEY"],
"AppId": os.environ["DOJAH_APP_ID"],
},
params={ "nin": "CM123456789AB" },
)
data = res.json()
{
"entity": {
"id_number": "CM123456789AB",
"first_name": "John",
"last_name": "Musa",
"middle_name": "Doe",
"date_of_birth": "1990-01-01"
}
}