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 by a company manager through the Authorization Code flow or the Refresh Token flow. See Authentication for partners.
Company-scoped access token (assertion) (OAuth2CompanyManagerAssertion) — obtained through the urn:ietf:params:oauth:grant-type:jwt-bearer grant for a company manager. See OAuth Assertion.
Customer API token (CustomerAPIToken) — generated by the customer on their Integration Settings page, with the scopes they choose there. See Authorization for customers.

Any one of the scopes in a token type's row is enough. all:write works too.

Token type	Category	Read only Scope	Write only Scope (read access implicit)
Company-scoped access token	Manage employment documents (employment_documents)	-	Manage contract eligibility (contract_eligibility:write)
Company-scoped access token (assertion)	Manage employment documents (employment_documents)	-	Manage contract eligibility (contract_eligibility:write)
Customer API token	Manage employment documents (employment_documents)	-	Manage contract eligibility (contract_eligibility:write)

post/v1/employments/{employment_id}/contract-eligibility

Base URL
https://gateway.remote.com
URL
https://gateway.remote.com/v1/employments/{employment_id}/contract-eligibility
Auth
- OAuth 2
  Authorization code: /auth/oauth2/authorize
  Token URL: /auth/oauth2/token scopes: https://gateway.remote.com/company.manage
- or OAuth 2
  Authorization code: /auth/oauth2/authorize
  Token URL: /auth/oauth2/token scopes: contract_eligibility:write
- or OAuth 2
  Authorization code: /auth/oauth2/authorize
  Token URL: /auth/oauth2/token scopes: all:write
- or OAuth 2
  Client credentials
  Token URL: /auth/oauth2/token scopes: contract_eligibility:write
- or OAuth 2
  Client credentials
  Token URL: /auth/oauth2/token scopes: all:write
- or HTTP bearer

employment_idstring required

Employment ID

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

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

Success

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

No recorded changes to this operation across all 1 revision of this API.