All file links (e.g. selfie URLs, document URLs) returned in the response expire within one hour. We strongly recommend transferring these documents and images to your own infrastructure as soon as you receive them. If a link expires before you are able to download the file, call the Fetch Address Verification Data endpoint to generate a new link — which will also expire in one hour.
Request
[POST]
{{baseUrl}}/api/v1/kyc/address
Header
| Header | Type | Description |
|---|---|---|
| AppId | string | Create an app to get your app ID on dashboard here |
| Authorization | string | Private/secret key. Use <key> not Bearer <key> |
Body parameter
| Parameter | Type | Description | Required |
|---|---|---|---|
| first_name | string | First name of Individual | required |
| last_name | string | Last name of Individual | required |
| middle_name | string | Middle name of Individual | optional |
| dob | string | Date of Birth of Individual in this format (yyyy-mm-dd) | optional |
| gender | string | Gender of Individual | optional |
| mobile | string | Active Mobile Number of Individual | required |
| street | string | House number, Street name | required |
| landmark | string | Closest landmark to the street | optional |
| lga | string | LGA | required |
| state | string | State | required |
Sample response
Response
{
"entity": {
"status":"pending" ,
"reference_id": "69e10264-4b90-64fe-b4b7-c9dddafd0241"
}
}
Response Fields
| Field | Type | Description |
|---|---|---|
| entity | object | Contains the response data |
| entity.status | string | Verification request status. Values: pending (verification in progress), completed (verification finished), failed (verification could not be completed) |
| entity.reference_id | string | Unique reference ID for tracking this verification request. Use this ID to fetch verification results later |