Business Address Verification

This endpoint request business address verification

POST

{{baseurl}}/candidates/:candidateId/merchants

Header

Field	Type	Description
token	String	Secret API token

Parameter

Field	Type	Description
subject_consent	Boolean	Candidate consent. Must be true
description optional	String	Description or any information for the agent
address	Object	Candidate address object
flat_number optional	String	Address flat number
building_name optional	String	Address building name
building_number	String	Address building number
landmark	String	Address landmark
street	String	Address street
sub_street optional	String	Address sub street
state	String	Address state
city	String	Address city
postcode optional	String	Address postcode
merchant	Object	Business object
name	String	Business name
email	String	Business email
mobile	String	Business mobile
registration_number	String	Business registration number

Sample Request

{
    "description": "Hello",
    "merchant": {
        "name": "CAC Consult",
        "email": "[e-mail]",
        "mobile": "08000000000",
        "registration_number": "123456789"
    },
    "address": {
        "flat_number": "5",
        "building_name": "White Building",
        "building_number": "3",
        "street": "13B Bishop Street",
        "landmark": "Opposit Ilupeju Police station",
        "sub_street": "Bishop",
        "state": "Lagos",
        "city": "Ilupeju",
        "postcode": "234001",
        "country": "Nigeria"
    }
}

Found Response

HTTP/1.1 200 OK
{
        "message": "Successful",
        "data": {
            "id": "reports_e3c2e12f-3efb-4a8a-a538-c29fbf338762",
            "reference_id": "61f9d6f29c64d",
            "subject_consent": true,
            "candidate": {
                "id": "e4f7320c-527b-471b-9670-725958a633e3",
                "reference_id": "YV61f9097146dfe3308",
                "name": "Ehichioya Prior Famous",
                "first_name": "Famous",
                "last_name": "Ehichioya",
                "middle_name": "Prior",
                "email": "[e-mail]",
                "mobile": "08030000000",
                "has_live_photo": true,
                "live_photo_path": "https://youverify-api-bucket.nyc3.digitaloceanspaces.com/reports/live_photos/2022-02-01/photo_61f9ab425c5f67328.jpg"
            },
            "start_time": "2022-02-02",
            "end_time": "2022-02-02",
            "execution_date": "",
            "submitted_at": "",
            "completed_at": null,
            "accepted_at": null,
            "revalidation_date": "2022-05-02",
            "status": "unassigned",
            "task_status": "PENDING",
            "reason": null,
            "task_created_by": "Chinook Devops",
            "package": "merchant_verification",
            "download_url": null,
            "description": "Verify subject",
            "package_name": "Merchant Verification",
            "details": {
                "id": 117,
                "uuid": "d1d9c6a0-59de-4ad4-a306-56b266f71053",
                "address_id": 20305,
                "candidate_id": 4734567,
                "status": "PENDING",
                "registration_number": "123456789",
                "name": "CAC Consult",
                "email": "[e-mail]",
                "mobile": "08000000000",
                "telephone": "",
                "deleted_at": null,
                "created_at": "2022-02-02 01:57:22",
                "updated_at": "2022-02-02 01:57:22",
                "address": {
                    "uuid": "a49493c4-67c1-405b-8195-85a88c009acc",
                    "user_id": 1,
                    "user_type": "user",
                    "candidate_id": 4734567,
                    "flat_number": null,
                    "building_name": "White Building",
                    "building_number": "3",
                    "sub_street": "Bishop",
                    "street": "13B Bishop Street",
                    "landmark": "Opposit Ilupeju Police station",
                    "state": "lagos",
                    "city": "Ilupeju",
                    "post_code": null,
                    "country": "Nigeria",
                    "longitude": null,
                    "latitude": null,
                    "what3words": "",
                    "what3words_map": "",
                    "agent_geo": null,
                    "start_date": null,
                    "end_date": null,
                    "status": "PENDING",
                    "reason_for_fail": null,
                    "item_id": "0",
                    "item_type": "merchant_verification",
                    "created_at": "2022-02-02 01:57:21",
                    "updated_at": "2022-02-02 01:57:21",
                    "formatted": "Flat Number , White Building, 3, Sub Street Bishop, 13b Bishop  Street, Opposit Ilupeju Police Station, Ilupeju, Lagos, Nigeria, ",
                    "map_format": "3 13b Bishop Street, Ilupeju , Lagos, Nigeria",
                    "map_address_url": null,
                    "map_geolocation_url": null
                }
            },
            "has_address": true,
            "notes": [],
            "signature": [],
            "is_flagged": 0,
            "awaiting_qa": false,
            "reportable_id": "d1d9c6a0-59de-4ad4-a306-56b266f71053",
            "created_at": "2022-02-02 01:57:22",
            "last_updated_at": "2022-02-02 01:57:22",
            "what3words": null,
            "what3words_map_link": null,
            "digital_address_code": null,
            "digital_address_url": null,
            "map_address_url": null,
            "map_geolocation_url": null,
            "report_geolocation_url": null,
            "report_longitude": null,
            "report_latitude": null,
            "can_view_report": true,
            "business": "Youverify",
            "reasons_for_failure": [
                "Address does not exist",
                "Address not accessible",
                "Candidate does not live there",
                "Incorrect Address",
                "Nobody to confirm candidate lives at the address"
            ],
            "submission_distance_in_meters": 0,
            "building_type": null,
            "building_color": null,
            "gate_present": null,
            "gate_color": null,
            "availability_confirmed_by": null,
            "closest_landmark": null,
            "additional_info": null,
            "report_agent_access": null,
            "incident_report": null,
            "images": {
                "data": []
            }
        },
        "status_code": 200
    }

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": {}
}