Request an Individual Address Verification

This is used to request for an individual address verification

Note: Before you create an address verification you must have created a candidate (the information of the person to be verified). If you missed how to create a candidate click here.

Individual Address Request

POST {{baseurl}}/v2/api/addresses/individual/request

Headers

Name	Type	Description
token*	String	API secret token

Request Body

Name	Type	Description
candidateId*	String	candidate ID
subjectConsent*	Boolean	Candidate consent. Must be true
description	String	Description or any information for the agent
address*	Object	Candidate address object
flatNumber	String	Address flat number
buildingName	String	Address building name
buildingNumber*	String	Address building number
landmark*	String	Address landmark
street*	String	Address street
subStreet	String	Address sub street
state*	String	Address state
city*	String	Address city
lga	String	Address local government
metadata	Object	Metadata object. Any valid object can be passed here. It gets returned as is.

Sample Request

{
    "candidateId": "6184e3c081ee238921cb9e86",
    "description": "Verify the candidate",
    "address": {
        "flatNumber": "1st floor",
        "buildingName": "Sum house",
        "buildingNumber": "350",
        "landmark": "Police Station",
        "street": "Borno way",
        "subStreet": "Hughes avenue",
        "state": "Lagos",
        "city": "Yaba",
        "lga": "Lagos Mainland"
    },
    "subjectConsent": true,
    "metadata": {
        "requestId": "1209348756"
},
        
}

Found Response

HTTP/1.1 201 CREATED
{
        "success": true,
        "statusCode": 201,
        "message": "Address requested successfully!",
        "data": {
            "referenceId": "61883f9ebc2c9",
            "candidate": {
                "candidateId": "6184e3c081ee238921cb9e86",
                "firstName": "FAMOUS",
                "middleName": "PRIOR",
                "lastName": "EHICHIOYA",
                "photo": "https://cdn.youverify.co/1655466566309-lLSfNTlhElMTtbXW-QE-q.jpg",
                "email": null,
                "mobile": "08036xxxxxx"
            },
            "agent": {
                "firstName": null,
                "middleName": null,
                "lastName": null,
                "signature": null,
                "photo": null
            },
            "address": {
                "latlong": {
                    "lat": "6.500871399999999",
                    "lon": "3.3765867"
                },
                "flatNumber": "1st floor",
                "buildingName": "Sum house",
                "buildingNumber": "350",
                "subStreet": "Hughes avenue",
                "street": "Borno way",
                "landmark": "Police Station",
                "state": "Lagos",
                "city": "Yaba",
                "country": "Nigeria",
                "lga": "Lagos Mainland"
            },
            "status": "pending",
            "taskStatus": "PENDING",
            "subjectConsent": "true",
            "startDate": null,
            "endDate": null,
            "submittedAt": null,
            "executionDate": null,
            "completedAt": null,
            "acceptedAt": null,
            "revalidationDate": null,
            "notes": [],
            "isFlagged": false,
            "agentSubmittedLongitude": null,
            "agentSubmittedLatitude": null,
            "reportGeolocationUrl": null,
            "mapAddressUrl": null,
            "submissionDistanceInMeters": null,
            "reasons": null,
            "signature": null,
            "images": [],
            "buildingType": null,
            "buildingColor": null,
            "gatePresent": null,
            "gateColor": null,
            "availabilityConfirmedBy": null,
            "closestLandmark": null,
            "additionalInfo": null,
            "reportAgentAccess": null,
            "incidentReport": null,
            "description": "Verify the candidate",
            "reportId": "reports_37fe307d-8112-4394-a4f1-303fe10f815a",
            "downloadUrl": null,
            "businessType": "admin",
            "businessId": "615c2deb203b96532838418b",
            "userId": "615c2deb203b96532838418c",
            "type": "individual",
            "createdAt": "2021-11-07T19:44:41.771Z",
            "lastModifiedAt": "2021-11-07T19:44:41.771Z",
            "_createdAt": "2021-11-07T20:44:4141+01:00",
            "_lastModifiedAt": "2021-11-07T20:44:4141+01:00",
            "id": "61882ca9a7422a684a3d0cdf"
        },
        "links": []
    }

Error Response

 HTTP/1.1 402 Payment Required
  {
    "success": false,
    "statusCode": 402,
    "message": "Insufficient fund",
    "name": "PaymentRequiredError",
    "data": {}
}


HTTP/1.1 500 Internal Server Error
{
    "success": false,
    "statusCode": 500,
    "message": "Service unavailable",
    "name": "Error",
    "data": {}
}

HTTP/1.1 403 Forbidden
{
    "success": false,
    "statusCode": 403,
    "message": "Permission denied",
    "name": "UnauthorizedError",
    "data": {}
}