Skip to main content
POST
/
invites
Create an assessment invite
curl --request POST \
  --url https://alfaone.app/api/v1/invites \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "assessmentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "recipientEmail": "jsmith@example.com",
  "questionReplayLimit": 1,
  "answerRecordLimit": 1,
  "expiresInDays": 30,
  "proctoringSettings": {
    "screenRecording": true,
    "webcamMonitoring": true,
    "requireIdCapture": true
  }
}
'
{
  "invite": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "assessmentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "assessmentName": "<string>",
    "recipientEmail": "jsmith@example.com",
    "recipientName": "<string>",
    "questionReplayLimit": 123,
    "answerRecordLimit": 123,
    "sentAt": "2023-11-07T05:31:56Z",
    "expiresAt": "2023-11-07T05:31:56Z",
    "acceptedAt": "2023-11-07T05:31:56Z",
    "startedAt": "2023-11-07T05:31:56Z",
    "completedAt": "2023-11-07T05:31:56Z"
  }
}

Documentation Index

Fetch the complete documentation index at: https://v4-docs.alfaone.app/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-api-key
string
header
required

API key for authentication. Format: ak_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Body

application/json
​
assessmentId
string<uuid>
required

ID of the assessment to invite the candidate to

​
recipientEmail
string<email>
required

Email address of the candidate

​
questionReplayLimit
integer
default:1

Maximum number of times a candidate can replay each question

Required range: x >= 1
​
answerRecordLimit
integer
default:1

Maximum number of recording attempts per answer

Required range: x >= 1
​
expiresInDays
integer
default:30

Number of days until the invite expires

Required range: x >= 1
​
proctoringSettings
object

Proctoring configuration. All options default to true if omitted.

Response

Invite created successfully

​
invite
object