Address Verification Service
At Verified.africa, our address verification services enable our customers to carry out thorough background checks of their own customers & employees by securely verifying both individual and business addresses.
With our address verification service, you are guaranteed detailed feedback containing images of the customer’s place of residence, consultation with the customer’s neighbor, closest landmark report, street name, and nearest bus stop.
Our Address verification services can be accessed by:
• Companies
• Individuals
Overview
The Address Verification Service accepts the lastName, Street name, LGA, phone number, kyc type and searchParameter and returns detailed information on the address verified to the customer's webhook. This article will guide you on how to integrate to the Address Verification Service.
Important!
Before you proceed, ensure you review the prerequisites for integrating to our APIs for a more detailed guide.
API Endpoint
https://api.verified.africa/sfx-verify/v3/id-service/
Headers
Our service accepts headers for authentication. See below the headers to pass to the API
| Header | Type | Description |
|---|---|---|
| userid | String | This is your user id retrieved from the portal. Check the getting started article to understand how to retrieve your userid |
| apiKey | String | This is your api key retrieved from the portal. Check the getting started article to understand how to retrieve your apiKey |
Request
| Request Parameter | Status | Description | Test Data |
|---|---|---|---|
| firstName | Optional | The first name will be passed into this field | John |
| lastName | Required | The last name will be passed into this field | Doe |
| dob | Optional | The date of birth will be passed into this field | 04-04-1944 |
| phone | Required | The phone number will be passed into this field | 08121234567 |
| verificationType | Required | This field is used to identify the service being called. Ensure to use the value provided exactly as provided | ADDRESS-VERIFICATION |
| kycType | Required | This field depicts the Identity type to be used for the verification | frsc |
| callbackUrl | Required | The callback url is inputted here | "https://webhook.site/7518d538-18ad-4eeb-b944-e168c54d020f" |
| searchParameter | Required | The driver's license number will be passed into this field | PQR41659AA50 |
| street | Required | The street name will be passed into this field | 270 Murtala Muhammed Way, Alagomeji. Yaba |
| lga | Required | The local government area will be passed into this field | surulere |
| city | Optional | The city will be passed into this field | lagos |
| state | Required | The state will be passed into this field | lagos |
| landmark | Optional | The landmark will be passed into this field | Beside GTbank |
{
"firstName":"John",
"lastName":"Doe",
"dob":"04-04-1944",
"phone":"08121234567",
"verificationType":"ADDRESS-VERIFICATION",
"kycType": "frsc",
"callbackUrl": "https://webhook.site/7518d538-18ad-4eeb-b944-e168c54d020f",
"searchParameter":"PQR41659AA50",
"street": "270 Murtala Muhammed Way, Alagomeji. Yaba",
"lga": "surulere",
"city": "lagos",
"state": "lagos",
"landmark": "Beside GTbank"
}
Response
| Response Parameter | Type | Description |
|---|---|---|
| responseCode | String | Please reference Response Codes page for details on all possible responses. |
| description | String | This is a description of the response received. |
| verificationType | String | The same verificationType passed in request will be returned here |
| verificationStatus | String | This field lets you know if the identity verification was successful. Options are: VERIFIED: This means that the ADDRESS-VERIFICATION is valid. NOT VERIFIED This means that the ADDRESS-VERIFICATION is invalid PENDING This status means that the verification could not be completed. Refer to the responseCode for the specific failure reason. |
| transactionStatus | String | This indicates the wallet debit status. The options are successful or failed. |
| transactionReference | String | If you supplied a transactionReference, the same will be returned here. Else, we would generate a reference and return that to you in this field. |
| transactionDate | String | Date the transaction was done |
| searchParameter | String | Driver's License number used for the address verification |
| response | Json | This is a json containing all the actual ADDRESS VERIFICATION data as retrieved from the service provider. |
{
"responseCode": "00",
"description": "Success",
"verificationType": "ADDRESS-VERIFICATION",
"verificationStatus": "VERIFIED",
"transactionStatus": "SUCCESSFUL",
"transactionReference": "null",
"transactionDate": "1669884508175",
"searchParameter": "PQR41659AA50",
"livenessScore": 0,
"response": {
"applicant": {
"firstname": "John",
"lastname": "Doe",
"phone": "08121234567",
"idType": "frsc",
"idNumber": "PQR41659AA50",
"middlename": "BISMARK",
"photo": "/9j/4AAQSkZJRgABAQAASABIAAD/"
,
"gender": "Male",
"birthdate": "04-04-1944",
"formattedAddress": "270 Murtala Muhammed Way, Alagomeji. Yaba lagos"
},
"createdAt": "2022-12-01T08:48:28.160",
"completedAt": "2022-12-01T08:48:28.160",
"lattitude": "9.081999",
"comment": "Address is valid.",
"agentSubmittedAt": "2022-12-01T08:48:28.160",
"longitude": "8.675277",
"photos": [
"https://unsplash.com/photos/Hh18POSx5qk",
"https://unsplash.com/photos/2d4lAQAlbDA"
],
"neighbor": {
"isAvailable": false,
"name": "Jane Doe",
"comment": "Nice neighbor",
"phone": "080900000000"
},
"status": {
"status": "VERIFIED",
"subStatus": "VERIFIED",
"state": "COMPLETE"
},
"city": "lagos",
"street": "270 Murtala Muhammed Way, Alagomeji. Yaba",
"lga": "surulere",
"state": "lagos",
"country": "Nigeria",
"callBackUrl": "https://webhook.site/55156e97-94e9-4f3a-80ae-42662e304e84"
}
}
Updated 6 months ago