v1

latestOpenAPI 3.1.02026-07-242735131.1 MB
Contract Eligibility

Create contract eligibility

Create contract eligibility for an employment.

This will create a new contract eligibility for the employment.

Scopes

CategoryRead only ScopeWrite only Scope (read access implicit)
Manage employment documents (employment_documents)-Manage contract eligibility (contract_eligibility:write)
post/v1/employments/{employment_id}/contract-eligibility

Path parameters

employment_idstring required

Employment ID

Request body

eligible_to_work_in_residing_country'citizen' | 'permanent_resident' | 'temporary_resident' required

type of employment eligibility to work in residing country

employer_or_work_restrictionsboolean required

whether the employer or work restrictions apply

Example request

{
  "eligible_to_work_in_residing_country": "citizen",
  "employer_or_work_restrictions": false
}

Response

Success

Example response

{
  "data": {
    "status": "ok"
  }
}