Request a Business Address Verification

This endpoint request business 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.

Company Address Request

POST {{baseurl}}/v2/api/addresses/business/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
business*	Object	Business object
name*	String	Business name
email*	String	Business email
mobile*	String	Business mobile
registrationNumber*	String	Business registrationNumber
metadata	Object	Metadata object. Any valid object can be passed here. It gets returned as is.

Sample Request

{
    "candidateId": "6184e3c081ee238921cb9e86",
    "description": "Verify the candidate and business",
    "business": {
        "name": "Youcheck Online Services Limited",
        "email": "[email protected]",
        "mobile": "08036xxxxxx",
        "registrationNumber": "123456789"
    },
    "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"
},
}

Success Response

HTTP/1.1 201 CREATED
{
            "success": true,
            "statusCode": 201,
            "message": "Address requested successfully!",
            "data": {
                "candidate": {
                    "candidateId": "618e33dd0b96f3c4397332f1",
                    "firstName": "FAMOUS",
                    "middleName": "PRIOR",
                    "lastName": "EHICHIOYA",
                    "photo": null,
                    "email": null,
                    "mobile": "08036xxxxxx"
                },
                "business": {
                    "name": "Youcheck Online Services Limited",
                    "registrationNumber": "123456789",
                    "email": "[email protected]",
                    "mobile": "08036000000"
                },
                "agent": {
                    "firstName": null,
                    "middleName": null,
                    "lastName": null,
                    "signature": null,
                    "photo": null
                },
                "address": {
                    "latlong": {
                        "lat": "0",
                        "lon": "0"
                    },
                    "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"
                },
                "referenceId": "61ba87d3b559f",
                "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 and business",
                "reportId": "reports_23e42a91-28b3-4a45-9b12-2ae12a28c124",
                "downloadUrl": null,
                "businessType": "organization",
                "businessId": "619b683ecb55a2a588f4b83c",
                "userId": "619b683ecb55a2a588f4b839",
                "type": "business",
                "createdAt": "2021-12-16T00:27:07.801Z",
                "lastModifiedAt": "2021-12-16T00:27:07.801Z",
                "_createdAt": "2021-12-16T01:27:077+01:00",
                "_lastModifiedAt": "2021-12-16T01:27:077+01:00",
                "verificationId": "61ba87d3b559f",
                "id": "61ba87dbf5e3a21724ad8219"
            },
            "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": {}
}