Skip to main content
POST
/
api
/
public
/
assessments
/
new
Create assessment
curl --request POST \
  --url http://localhost:3001/api/public/assessments/new \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "candidateIdentifier": "<string>",
  "problemId": "<string>",
  "shouldSendEmail": true,
  "bypassIDCheck": false
}'
{
  "success": true,
  "identifier": "<string>",
  "message": "<string>"
}

Authorizations

x-api-key
string
header
required

Body

application/json
candidateIdentifier
string
required

The identifier of the candidate

problemId
string
required

The identifier of the problem to assign

shouldSendEmail
boolean
default:true

Whether to send an email notification to the candidate

bypassIDCheck
boolean
default:false

Whether to bypass ID verification checks

Response

Successfully created assessment

success
boolean

Whether the operation was successful

identifier
string

Unique identifier for the newly created assessment

message
string

Success or error message