Contracts
Contract Eligibility

Create contract eligibility

Create contract eligibility for an employment.

This will create a new contract eligibility for the employment.

Authentication

This endpoint accepts any one of the following token types:

  • Company-scoped access token (OAuth2AuthorizationCode) — obtained through the Authorization Code flow or the Refresh Token flow. See Authentication for partners.
  • Customer API token (CustomerAPIToken) — generated by the customer on their Integration Settings page. See Authorization for customers.

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

Request

  • Base URL: https://gateway.remote.com
  • URL: https://gateway.remote.com/v1/employments/{employment_id}/contract-eligibility
  • Auth: HTTP bearer and OAuth 2 (authorization code, authorization URL /auth/oauth2/authorize, token URL /auth/oauth2/token, scopes: https://gateway.remote.com/company.manage, contract_eligibility:write, employment_documents, all:write)

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"
  }
}

Changes

No recorded changes to this operation across all 65 revisions of this API.