Submit a candidate for one or more tests. It is up to the evaluation provider to specify whether Comeet should send a message to the candidate to complete the test at a specified link.

The evaluation partner can specify whether the request should allow multiple tests or only one test at a time.
The Optional/Required fields in the request can be customized per the evaluation partner's needs. For example, if the candidate’s email is required by the service, it can be defined as required, preventing the user from submitting any candidates lacking defined email addresses.

In case of an error submitting a candidate for evaluation, the recruiter will be notified and requested to review the error message.

Request

Payload:

Name	Type	Optional	Description
test_ids	array[string]	required	Array of evaluation partner test_id
candidate	object	required	Candidate details
candidate.uid	string	required
candidate.first_name	string	required
candidate.middle_name	string	optional
candidate.last_name	string	optional
candidate.phone	string	optional
candidate.email	string	optional
candidate.resume	object	optional
candidate.resume.name	string	optional	File name of the resume
candidate.resume.url	string	optional	URL to the resume. The link expires 3 minutes after it was submitted
candidate.offers[]	array	optional	Included if the Evaluation app has permission to access offer letters
candidate.offers[].url	string	optional	URL to the PDF file of the offer letter, valid for 300 seconds. Authorization header is required as explained here. An unsigned offer letter will include the attributes `{signature:employee}` and `{signature:employer}`.
position	object	required	The position for which the candidate is being considered
position.uid	string	required
position.name	string	required
assignees	array	required	The users who are responsible for this step in the hiring process
assignees[].first_name	string	required
assignees[].middle_name	string	optional
assignees[].last_name	string	optional
assignees[].email	string	required

HTTP Headers

Name	Value
Content-Type	application/json
Authorization	Bearer XXXXXXXXXXXXXXXXXXXXX

POST https://www.evaluation-partner.com/api/tests/submit

{
    "test_ids": ["5354343", "4324343"],
    "candidate":
    {
        "uid": "AAA.00",        
        "first_name": "Harry",
        "middle_name": "James",
        "last_name": "Potter",
        "phone": "123-456-7890",
        "email": "[email protected]",
        "resume": {
              "name": "harry_cv.pdf",
              "url": "https://comeet-euw-qa.s3-eu-west-1.amazonaws.com/65c0a9ff2166g"
        }
    },
    "position":
    {      
        "uid":"87.405",
        "name":"Account Executive"
    },
    "assignees": [
      {
        "first_name": "Cory",
        "middle_name": "",
        "last_name": "James",
        "email": "[email protected]"       
      },
      {
        "first_name": "Collin",
        "middle_name": "Charles",
        "last_name": "Cha",
        "email": "[email protected]"      
      }      
    ]
}

Response

Name	Type	Optional	Description
candidate_evaluation_id	string	required	Unique ID of the candidate submission for requested tests
test_url_for_candidate	string	optional	When provided Comeet will send an email message to the candidate requesting to complete the test at the specified URL
instructions_for_candidate	string	optional	Plain text, limited to 2000 characters. Only applicable when test_url_for_candidate is provided. When provided, these instructions will be included as part of the message to the candidate

{
    "candidate_evaluation_id": "98765"
}

{
    "candidate_evaluation_id": "98765",
    "test_url_for_candidate": "https://www.evaluation-partner.com/tests/98765",
    "instructions_for_candidate": "The test should take one hour to complete."
}