Search for a Candidate

This retrieves a created candidate

GET {{baseurl}}/v2/api/addresses/candidates/:candidateId

Headers

Name	Type	Description
token*	String	API secret token

Found Response

HTTP/1.1 200 OK
{
            "success": true,
            "statusCode": 201,
            "message": "Candidate retrieved successfully!",
            "data": {
                "firstName": "FAMOUS",
                "middleName": "PRIOR",
                "lastName": "EHICHIOYA",
                "dateOfBirth": "2000-01-01",
                "photo": "data:image/jpg;base64,/9j/4AAQSkZJRgABAgAAAQABAAD/2wBDAAgGBgcGBQgHBwcJCQgKD",
                "email": null,
                "mobile": "08036xxxxxx",
                "idNumber": "22328xxxxxx",
                "businessId": "615c2deb203b96532838418b",
                "type": "bvn",
                "medium": "identity",
                "createdAt": "2021-11-12T09:29:01.516Z",
                "lastModifiedAt": "2021-11-12T09:29:01.516Z",
                "_createdAt": "2021-11-12T10:29:011+01:00",
                "_lastModifiedAt": "2021-11-12T10:29:011+01:00",
                "id": "618e33dd0b96f3c4397332f1"
            },
            "links": []
        }

Error Responses

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