Send a reference check
send_reference_checkSends a reference check for one candidate. HiveRef emails the candidate a secure link to add their referees, then contacts the referees; the check counts towards the organisation's plan. Sending emails a real person and can't be undone from here. The questions come from custom_questions (up to 40) or a question_template_id; with neither, HiveRef's general template is used. Custom questions go through HiveRef's compliance check, which can reject a question and give the reason. A repeat call for the same candidate and role within 24 hours sends nothing unless send_again is true, so a retry does not email the candidate twice.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"candidate_first_name": "<candidate_first_name>",
"candidate_last_name": "<candidate_last_name>",
"candidate_email": "<candidate_email>",
"role_title": "<role_title>",
"user_confirmed": "<user_confirmed>"
},
"name": "send_reference_check"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| role_title | Yes | The role the candidate is being hired for. | |
| send_again | No | True sends a second check to a candidate who was already sent one for this role in the last 24 hours. Default false. | |
| user_confirmed | Yes | Must be true. Records that the user reviewed the candidate, email, role, referee count and questions and asked for this check to be sent. | |
| candidate_email | Yes | The candidate's email address. | |
| job_description | No | The job description, if the user gave one. Helps the compliance check judge custom questions. | |
| target_referees | No | How many referees the candidate is asked for, 1 to 6. Default 2. | |
| custom_questions | No | The questions to ask referees. Leave out to use a template. | |
| candidate_last_name | Yes | The candidate's last name. | |
| candidate_first_name | Yes | The candidate's first name. | |
| question_template_id | No | The id of a HiveRef question template. Leave out when sending custom_questions. |