Individual Address Verification Service🧍🏽‍♂️

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 integrating to the Individual Address Verification Service.

🚧
Important!
Before you proceed, ensure you review the prerequisites for integrating to our APIs for a more detailed guide.

API Endpoint

{{Prod}}/sfx-v4-verify/v4/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	type	Test Data
firstName	Optional	The first name will be passed into this field	String	John
lastName	Required	The last name will be passed into this field	String	Doe
dob	Optional	The date of birth will be passed into this field	dateString	04-04-1944
phone	Required	The phone number will be passed into this field	String	08098289033
verificationType	Required	This field is used to identify the service being called. Ensure to use the value provided exactly as provided	String	BUSINESS-ADDRESS-VERIFICATION
kycType	Optional	This field depicts the Identity type to be used for the verification	enum : {nin, bvn, frsc, drivers_license }	frsc
callbackUrl	Required	The callback url is inputted here	String	"https://webhook.site/7518d538-18ad-4eeb-b944-e168c54d020f"
searchParameter	Required	The lD number will be passed into this field	String	PQR41659AA50
street	Required	The street name will be passed into this field	String	270 Murtala Muhammed Way, Alagomeji. Yaba
lga	Required	The local government area will be passed into this field	String	surulere
city	Optional	The city will be passed into this field	String	lagos
state	Required	The state will be passed into this field	String	lagos
landmark	Required	The landmark will be passed into this field	String	Beside GTbank

{
    "firstName": "John",
    "lastName": "Doe",
    "dob": "1944-02-01",
    "phone": "08098289033",
    "verificationType": "INDIVIDUAL-ADDRESS-VERIFICATION",
    "kycType": "frsc",
    "callbackUrl":"https://webhook.site/71f0e4a3-84a0-405d-97e6-9d4f1530ea86",
    "searchParameter": "PQR41659AA50",
    "street": "27 Murtala Muhammed Way, Alagomeji. Yaba",
    "lga": "surulere",
    "city": "lagos",
    "state": "lagos",
    "landmark": "Beside GTbank"
}

Initial Response

(This is the response you would get when you submit a response for Individual Address Verification)

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 INDIVIDUAL ADDRESS VERIFICATION data as retrieved from the service provider.

{
    "responseCode": "00",
    "description": "Successful",
    "verificationType": "INDIVIDUAL-ADDRESS-VERIFICATION",
    "verificationStatus": "VERIFIED",
    "transactionStatus": "SUCCESSFUL",
    "transactionReference": "1630321373727-SVGHQECS-1718896234196-03040cb0-4374-4d98-afb2-c68d1834e4a2",
    "transactionDate": "1718896235805",
    "searchParameter": "PQR41659AA50",
    "callBackUrl": null,
    "livenessScore": null,
    "paymentRef": null,
    "response": {
        "id": 4196337,
        "customerReference": "1630321373727-SVGHQECS-1718896234196-03040cb0-4374-4d98-afb2-c68d1834e4a2",
        "status": 0,
        "statusCode": 0,
        "message": null,
        "error": null,
        "applicant": {
            "organisationId": 164295,
            "customerReference": "1630321373727-SVGHQECS-1718896234196-03040cb0-4374-4d98-afb2-c68d1834e4a2",
            "firstname": "John",
            "lastname": "Doe",
            "phone": "+2348098289033",
            "dob": "1944-02-01",
            "gender": null,
            "maritalStatus": null,
            "photo": null,
            "imageId": null,
            "faceId": null,
            "email": null
        },
        "summary": {
            "address_check": "IN_PROGRESS"
        },
        "address": {
            "verificationTypeCode": "address",
            "organisationId": 164295,
            "requestedAt": "2024-06-20T15:10:35.000Z",
            "requestSource": "api",
            "archived": false,
            "stateId": 25,
            "stateName": "Lagos",
            "lgaId": 519,
            "lgaName": "Surulere",
            "applicationId": 5209,
            "countryName": "Nigeria",
            "location": {
                "city": "lagos",
                "initialLatitude": 6.4920043,
                "initialLongitude": 3.3789529,
                "landmark": "Beside GTbank",
                "latitude": 6.4920043,
                "lgaName": "Surulere",
                "locationUrl": "https://maps.google.com/?q=6.4920043,3.3789529",
                "longitude": 3.3789529,
                "stateName": "lagos",
                "street": "27 Murtala Muhammed Way, Alagomeji. Yaba"
            },
            "addressBasic": {
                "addressType": ""
            },
            "customerReference": "1630321373727-SVGHQECS-1718896234196-03040cb0-4374-4d98-afb2-c68d1834e4a2",
            "paymentMethodCode": "standard",
            "status": {
                "status": "IN_PROGRESS",
                "subStatus": "IN PROGRESS",
                "state": "IN_PROGRESS"
            },
            "live": false,
            "duplicate": false,
            "vague": false
        }
    },
    "faceMatch": null,
    "licenseSessionId": null,
    "remainingLicenseSessionRound": null
}

Final Response (Received via Webhook)

{
    "event": "address",
    "event_type": "verification_completed",
    "data": {
        "id": 1,
        "summary": null,
        "customerReference": "1630321373727-SOJZP2Z2-1716208583375-5376c4f7-0c76-4c10-b720-2cfa357bf21b",
        "address": {
            "id": 1,
            "verificationTypeCode": "address",
            "organisationId": 1,
            "userId": null,
            "approvedAt": "2023-08-04T15:57:53.000Z",
            "requestedAt": "2023-08-04T11:42:30.000Z",
            "identityVerificationId": null,
            "requestSource": "api",
            "archived": false,
            "apiReference": null,
            "stateId": 25,
            "stateName": "Lagos",
            "lgaId": 514,
            "lgaName": "Lagos Mainland",
            "applicationId": 1,
            "neighbor": {
                "comment": "The address exists and the applicant lives at the address and this was confirmed by a neighbor living in the compound. The nearest landmark to the address is carwash bus stop",
                "firstname": null,
                "lastname": null,
                "phone": ""
            },
            "countryName": "Nigeria",
            "isLive": true,
            "isDuplicate": false,
            "location": {
                "city": "ADEKUNLE",
                "initialLatitude": 6.4883519,
                "initialLongitude": 3.3820116,
                "landmark": "ADEKUNLE",
                "latitude": 6.4860838,
                "lgaName": "Lagos Mainland",
                "locationUrl": "https://maps.google.com/?q=6.4883519,3.3820116",
                "longitude": 3.3063121,
                "stateName": "Lagos",
                "street": "EBUTE META, GLOVER STREET"
            },
            "addressBasic": {
                "addressType": ""
            },
            "business": {
                "area": "commercial",
                "businessName": null,
                "businessType": null,
                "canContactPoc": null,
                "id": null,
                "isKnown": null,
                "isOwnerKnown": null,
                "name": null,
                "nameFound": "",
                "ownerVisitsFrequently": null,
                "rcNumber": null,
                "type": null
            },
            "isVague": true,
            "customerReference": "1",
            "paymentMethodCode": "standard",
            "applicant": {
                "organisationId": 1,
                "applicantId": null,
                "customerReference": "1",
                "firstname": "John",
                "middlename": null,
                "lastname": "Doe",
                "phone": "+2347030000000",
                "email": null,
                "dob": "1960-10-01",
                "gender": null,
                "maritalStatus": null,
                "photo": null,
                "imageId": null,
                "faceId": null
            },
            "price": 2,
            "agentComment": "Verification completed",
            "agentSubmittedAt": "2023-08-04T15:51:00.000Z",
            "rejectedAt": null,
            "interiorPhotos": {},
            "exteriorPhotos": {
                "photo1": "https://seamfix.com/image/...",
                "photo2": "https://seamfix.com/image/..",
                "photo3": "https://seamfix.com/image/.."
            },
            "extraPhotos": {},
            "status": {
                "status": "VERIFIED",
                "subStatus": "VERIFIED",
                "state": "COMPLETE"
            }
        }
    }
}

Overview

🚧Important!

API Endpoint

Headers

Request

Initial Response

Final Response (Received via Webhook)

🚧
Important!