Skip to main content
POST
Order Assessments Request

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Headers

x-account-id
string
required

The account identifier

Prefer
string

Set to "heartbeat" to enable keep-alive newline heartbeats during long-running requests. Response includes Preference-Applied: heartbeat header when honored. (RFC 7240)

Example:

"heartbeat"

Body

application/json
id
string | null

Unique identifier

Example:

"8187e5da-dc77-475e-9949-af0f1fa4e4e3"

package
object | null
application
object | null
job
object | null
candidate
object | null
requester
object | null
results_update_url
string | null

Results update url

Example:

"https://exmaple.com/integrations/results/update"

passthrough
object | null

Value to pass through to the provider

Example:

Response

The order request of the assessment for candidate.

id
string | null

Unique identifier

Example:

"8187e5da-dc77-475e-9949-af0f1fa4e4e3"

remote_id
string | null

Provider's unique identifier

Example:

"8187e5da-dc77-475e-9949-af0f1fa4e4e3"

test_url
string | null

Test url

Example:

"https://exmaple.com/integrations/candidate/test"