Accept / Reject assessment orders

🛑
Assessment API Sunset
This API has been deprecated since September 4, 2023. The sunset date is May 10, 2024. If you are an assessment provider or looking to build an assessment integration with SmartRecruiters, please consider using the new Assessment API (2021).

Accept assessment order

Accepting the assessment order is the first step to begin working on your order. You can accept the assessment order by passing the AssessmentComment object to the following endpoint

curl -i
     -H "X-SmartToken:abc123"
     -H "Content-Type: application/json;charset=utf-8"
     -d @body.json
     -X POST
     https://api.smartrecruiters.com/v1/assessments/511a3942300469a9c33819d1/accept

body.json:

{
    "message": "We are starting work on this. This assessment should take about 3 business days.",
    "assessmentURL": "https://assessmentvendor.com/start-assessment/sdf32k23ll43",
    "messageToCandidate": "Hi Mark, Orlando Magic Inc. asked us to perform an assessment for you. Please follow steps under the below link: https://assessmentvendor.com/start-assessment/sdf32k23ll43. Wish you luck!",
    "author": {
        "firstName": "John",
        "lastName": "Mnemonic",
        "email": "[email protected]",
        "phone": "(123) 321 32 1231"
    }
}

Please remember to pass a URL to take an assessment together with a message containing any instructions (although all instructions should be placed on a landing page when taking an assessment). This information will be surfaced on a Candidate Portal in the future.

Note: surfacing the message in the Candidate Portal is going to be an additional channel to notify candidates. You as a partner, should still send an email to a candidate once the order is accepted with an appropriate message and a link to the assessment. SmartRecruiters will NOT send any emails to the candidate related to the assessment order.

On accepting the request, the status of the assessment order changes from NEW to IN_PROGRESS.

Reject assessment order

To reject an assessment order, you can send the following POST request,

curl -i
     -H "X-SmartToken:abc123"
     -H "Content-Type: application/json;charset=utf-8"
     -d @body.json
     -X POST
     https://api.smartrecruiters.com/v1/assessments/511a3942300469a9c33819d1/reject

body.json:

{
    "message": "Candidate is not responding to emails and is not answering the calls. We can't reach him, and unfortunately we need to reject this order",
    "author": {
        "firstName": "John",
        "lastName": "Mnemonic",
        "email": "[email protected]",
        "phone": "(123) 321 32 1231"
    }
}

On rejecting the request, the status of the assessment order changes to REJECTED.

Assessment order statuses

The 4 possible assessment order statuses are,

NEW – assessment order takes this status immediately after creation
IN_PROGRESS – status changes to IN_PROGRESS once you accept the order
REJECTED – status changes to REJECTED on rejecting the order
COMPLETED – status changes to COMPLETED after sending a complete request