Skip to main content
POST
Create an assessment

Authorizations

Authorization
string
header
required

Your company API token. Keep it on your server.

Body

application/json
purpose
string

Work From Anywhere or Hire From Anywhere. Purpose affects the applicable inputs.

Example:

"Work From Anywhere"

seniority
string

Seniority selection. Low is shown in the documented example.

Example:

"Low"

roleType
string

Role selection. Other is shown in the documented example.

Example:

"Other"

citizenship
string

Employee citizenship. Use the exact supported country name.

Example:

"Australia"

destination
string

Destination country. Use the exact supported country name.

Example:

"Argentina"

residency
string

Employee residency country. Use the exact supported country name.

Example:

"Australia"

salesContracts
string

Sales contract activity; documented example uses Yes.

Example:

"Yes"

pastTripsDuration
integer

Duration of prior trips.

Example:

0

Existing right to work; documented example uses No.

Example:

"No"

benefitLocalMarket
string

Local market activity; documented example uses No.

Example:

"No"

urgency
string

Timing selection; documented example uses 1-3 months.

Example:

"1-3 months"

numberHires
integer

Number of hires.

Example:

5

startDate
string

Start date in ISO 8601 format.

Example:

"2026-11-01T00:00:00.000Z"

endDate
string

End date in ISO 8601 format; must be on or after the start.

Example:

"2026-11-10T00:00:00.000Z"

workingDays
integer

Working days within the trip dates.

Example:

5

employeeId
string

Your external employee Staff ID.

Example:

"STAFF-001"

complianceTeamMemberId
string

Registered, activated compliance Staff ID in the token’s company.

managerId
string

External manager Staff ID.

Response

200 - application/json

Workflow response. Check the JSON status: HTTP 200 can include an application error. Other HTTP error statuses have not yet been verified.

Contains assessment_id and redirect_url. Exact nesting and envelope pending verification; no sample success payload supplied.