/v3/kyc/national-id
identity:read
National ID
Looks up a person by their national identity number and returns the matched record (names, date of birth, gender and registry photo where available).
Try it
Sandbox returns deterministic mock data, no wallet charge. Checking Live availability…
Request body
Body parameters
| Field | Type | Description |
|---|---|---|
numberrequired |
string | The national ID number to verify. |
country_code |
string | ISO-3166 alpha-2 country code (KE, UG, TZ, …). |
Example responses
200 · Result
{
"request_id": "req_8f2c1a9b7d3e4f60",
"live": true,
"ok": true,
"response_code": "00",
"status": "VERIFIED",
"found": true,
"soft_error": false,
"async_pending": false,
"reference": "VR-D4ACE26C68A3",
"message": "Verification successful.",
"data": {
"first_name": "JANE",
"last_name": "WANJIKU",
"date_of_birth": "1990-04-12",
"gender": "F",
"national_id": "31234567"
},
"provider": "Farmsky Verify"
}
400 · Bad request
{
"error": "invalid_request",
"message": "number (national ID) is required"
}
401 · Unauthorized
{
"error": "unauthorized",
"message": "API credentials required. Send Authorization: Bearer <client_id>:<secret>."
}
Runs use your signed-in session. For system-to-system integration, issue a keypair in the
Console and send
Authorization: Bearer <client_id>:<secret> against
https://credit.farmsky.africa (Sandbox https://sandbox.credit.farmsky.africa).