Address Verification

Verify an address

Address verification is a pivotal step in Know Your Customer (KYC) processes and various other applications. Providing a complete and accurate address is essential for various purposes, such as shipping, billing, and contact information. Our Address Verification Endpoint is designed to help you verify and validate addresses, ensuring that your data is up-to-date and reliable. To utilize this endpoint, merchants must ensure to provide a full address as this is what would be used to confirm the validity of the address. The address verification process takes a minimum of 48 hours to complete depending on the location.

Our Address Verification Status feature lets you keep an eye on the verification process. It allows merchants to see how their requests are progressing and get updates on the status of their address verification.

Incorporating our Address Verification Endpoint into your workflow will help you maintain the quality and reliability of your address data, ultimately improving your customer experience and operational efficiency.

πŸ‘

TEST DATA

Address Verification

first_name: john

last_name: doe

phone: 08012345678

address: 11c Atinuke Street, Off Gwalada Road, Ikeja, Lagos.

landmark: ikeja mall

state: lagos

lga: ikeja

latitude: 3.123456789999

longitude: 2.123456789999

address_verification_due_date: 2023-01-1-01

Address Verification Status

job_id: 64dcca7ea3c46f74ecc28564

πŸ“˜

POST

Address Verification: {{URL}}/identitypass/verification/address

Address Verification Status: {{URL}}/identitypass/verification/address/status

Header

KeyDescription
app-idYour App ID
x-api-keyYour Secret Key

Body

Address Verification

KeyDescription
first_nameFirst name of the customer
last_nameLast name of the customer
phonePhone number of the customer
addressAddress location of the customer
landmarkLandmark associated with the address of the customer
stateState of the address of the customer
lgaLocal Government Area of the address of the customer
latitudeLatitude of the customer's address
longitudeLongitude of the customer's address
address_verification_due_dateDue date of the address verification

Address Verification Status

KeyDescription
job_idThis is the value for the field "_id" in the address verification response. It is the unique reference for any particular verification

"Address Verification" Response

{
    "status": true,
    "response_code": "00",
    "data": {
        "status": true,
        "message": {
            "address": {
                "log": [],
                "first_name": "john",
                "last_name": "doe",
                "phone": "08012345678",
                "address": "405b, landmark close, lagos",
                "latitude": "7.348330",
                "longitude": "7.348330",
                "landmark": "Opposite john doe supermarket",
                "state": "Lagos",
                "lga": "Ikeja"
            },
            "guarantor": {
                "log": [],
                "testify": false
            },
            "business": {
                "interior_images": [],
                "financials_image": []
            },
            "location": {
                "type": "Point",
                "coordinates": [
                    2.516059970855714,
                    1.9351301193237305
                ]
            },
            "company_confirmed": false,
            "lastModified": "2023-08-15T16:45:16.634Z",
            "status": "unassigned",
            "created_date": "2023-08-15T16:45:16.634Z",
            "dueDateCheck": false,
            "notificationCheck": false,
            "_id": "64dcca7ea3c46f74ecc28564",
            "type": "address",
            "class": "individual",
            "reference": "EP/12345678901",
            "__v": 0
        }
    },
    "verification": {
        "reference": "868001f6-4e23-42b7-9fa0-6044a28f7714"
    },
    "session": {}
}

"Address Verification Status" Response

{
    "status": true,
    "response_code": "00",
    "data": {
        "status": true,
        "message": {
            "address": {
                "log": [],
                "first_name": "john",
                "last_name": "doe",
                "phone": "08012345678",
                "address": "405b, landmark close, lagos",
                "latitude": "7.348330",
                "longitude": "7.348330",
                "landmark": "Opposite john doe supermarket",
                "state": "Lagos",
                "lga": "Ikeja"
            },
            "guarantor": {
                "log": [],
                "testify": false
            },
            "business": {
                "interior_images": [],
                "financials_image": []
            },
            "location": {
                "type": "Point",
                "coordinates": [
                    2.516059970855714,
                    1.9351301193237305
                ]
            },
            "company_confirmed": false,
            "lastModified": "2023-08-15T16:45:16.634Z",
            "status": "unassigned",
            "created_date": "2023-08-15T16:45:16.634Z",
            "dueDateCheck": false,
            "notificationCheck": false,
            "_id": "64dcca7ea3c46f74ecc28564",
            "type": "address",
            "class": "individual",
            "reference": "EP/12345678901",
            "__v": 0
        }
    },
    "verification": {
        "reference": "868001f6-4e23-42b7-9fa0-6044a28f7714"
    },
    "session": {}
}

Response Description (Address Verification)

ResponseDescription
statusBoolean indicating the verification status.
response_codeResponse code indicating the outcome of verification.
dataData related to the verification process.
addressInformation about the address being verified.
logLog related to the address verification.
first_nameFirst name associated with the address.
last_nameLast name associated with the address.
phonePhone number associated with the address.
addressAddress details.
latitudeLatitude coordinate of the address.
longitudeLongitude coordinate of the address.
landmarkLandmark associated with the address.
stateState where the address is located.
lgaLocal Government Area (LGA) of the address.
guarantorInformation about the guarantor.
testifyBoolean indicating whether the guarantor testifies.
businessInformation about the business.
interior_imagesInterior images related to the business.
financials_imageFinancial images related to the business.
locationGeospatial location information.
typeType of verification.
coordinatesCoordinates of the location.
company_confirmedBoolean indicating whether the company is confirmed.
lastModifiedDate and time of the last modification.
statusStatus of the verification.
logsLogs related to the verification.
created_dateDate and time of creation.
dueDateCheckBoolean indicating due date check status.
notificationCheckBoolean indicating notification check status.
_idUnique identifier.
admin_idIdentifier of the admin associated with the verification.
created_byIdentifier of the creator.
classVerification class.
referenceReference code associated with the verification.
__vVersion number.
verificationVerification reference.
referenceReference code for verification.
sessionPlaceholder for session data.

Response Description (Address Verification Status)

ResponseDescription
statusBoolean indicating the verification status.
response_codeResponse code indicating the outcome of verification.
dataData related to the verification process.
statusStatus of the verification process.
messageInformation related to the verification message.
addressInformation about the address being verified.
logLog related to the address verification.
first_nameFirst name associated with the address.
last_nameLast name associated with the address.
phonePhone number associated with the address.
addressAddress details.
latitudeLatitude coordinate of the address.
longitudeLongitude coordinate of the address.
landmarkLandmark associated with the address.
stateState where the address is located.
lgaLocal Government Area (LGA) of the address.
guarantorInformation about the guarantor.
testifyBoolean indicating whether the guarantor testifies.
businessInformation about the business.
interior_imagesInterior images related to the business.
financials_imageFinancial images related to the business.
locationGeospatial location information.
typeType of verification.
coordinatesCoordinates of the location.
company_confirmedBoolean indicating whether the company is confirmed.
lastModifiedDate and time of the last modification.
statusStatus of the verification.
logsLogs related to the verification.
created_dateDate and time of creation.
dueDateCheckBoolean indicating due date check status.
notificationCheckBoolean indicating notification check status.
_idUnique identifier.
admin_idIdentifier of the admin associated with the verification.
created_byIdentifier of the creator.
classVerification class.
referenceReference code associated with the verification.
__vVersion number.
verificationVerification reference.
referenceReference code for verification.
sessionPlaceholder for session data.