Starts a physical verification of a Nigerian residential or business address. Send the person's name and phone number with the full address, including house number, street, landmark, city, LGA and state. The check does not finish in this call: the response returns a job_id, which you pass to Address Verification Status to follow the request and collect the report when it is ready.
Authorization
ApiKeyAuth X-API-Key<token>
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
curl -X POST "https://example.com/api/v1/verification/api/address_verification_ng/" \ -H "Content-Type: application/json" \ -d '{ "verification_type": "e.g. INDIVIDUAL", "first_name": "Enter first name", "last_name": "Enter last name", "phone": "e.g. 07012345678 or +2347012345678", "house_number": "e.g. 12B", "street": "Enter address", "landmark": "Enter landmark", "state": "e.g. Lagos", "city": "Enter city", "lga": "Enter local government area" }'{ "data": { "lga": "test lga", "city": "lagos", "email": "test@email.com", "phone": "+2348011111678", "state": "lagos state", "job_id": "1d35eb48-0f71-480d-9b30-432c70b0a6ee", "street": "test address", "accountID": "RG170065035", "consented": false, "last_name": "Test", "first_name": "Test", "addressStatus": "pending", "identity_type": "BVN", "isReportReady": false, "identity_number": "12345678901", "verificationType": "Individual", "requestingCompany": "Prembly", "agreedToTermsOfUse": false, "isIDNumberVerified": false }, "status": true, "response_code": "00", "message": "string", "billing_info": { "was_charged": true, "amount": "string", "currency": "string" }}Response Codes & Statuses: Prembly API responses include custom
response_code values (e.g., 00 Success, 01 Not Found, 02 Unavailable).Prembly Slack Community
Join our developer Slack channel for real-time integration support, engineering updates, and direct Q&A with the Prembly team.
Join Slack Channel