Send ID-Verification link
This endpoint Sends a ID-Verification link to the Candidates’s email address.
Endpoint
POST https://api.ezyhire.com/swagger-ui.html#/test-controller/sendIdVerificationLinkUsingPOSTRequest
Headers
USER-Key: User/API key for authentication
Body: json
{
"email": "string",
"externalCandidateId": "string",
"firstName": "string",
"lastName": "string"
}
Response
Successful Response
Status Code: 200 OK
Content:json
{
"status": 200,
"message": "Email for ID Verificatoin sent successfully.",
"data": "TRUE"
}Error Response
Status Code: 401 Bad Request
Content:json
{
"status": 401,
"message": "Invalid User/API key",
"data": "Please provide a valid User/API key"
}Error Response
Status Code: 401 Unauthorized
Content:json
{
"status": 401,
"message": "You dont have licence to use the Id Verification feature.",
"data": "Please acquire the necessary product key"
}Error Response
Status Code: 401 Unauthorized
Content:json
{
"status": 401,
"message": "Licence exhausted for Id Verification.",
"data": "Please purchase a new licence"
}Error Response
Status Code: 500 Internal Server Error
Content:json
{
"status": 500,
"error": "Exception occured. Error message"
}