Update contract details

Updates employment's contract details.

A job title eligibility check verdict is required before contract details can be
submitted. Run POST /api/eor/v2/employments/{employment_id}/job-title-eligibility-check
first and send the check_id it returns as additional_job_title_eligibility_check_slug.
A missing verdict, or one recorded against a different job title or role answer, is
rejected — the check is never evaluated as part of this request.

This endpoint requires and returns country-specific data. The exact required and returned fields will
vary depending on which country the employment is in. To see the list of parameters for each country,
see the Show form schema endpoint under the Countries category.

Please note that the compliance requirements for each country are subject to change according to local
laws. Given its continual updates, using Remote's json-schema-form should be considered in order to avoid
compliance issues and to have the latest version of a country requirements.

If you are using this endpoint to build an integration, make sure you are dynamically collecting or
displaying the latest parameters for each country by querying the "Show form schema" endpoint.

For more information on JSON Schemas, see the How JSON Schemas work documentation.

To learn how you can dynamically generate forms to display in your UI, see the documentation for
the json-schema-form tool.

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 employments (employments)-Manage employments (employment:write)
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Employment ID

Query Params
≥ 1

Version of the contract_details form schema


Specific version number

boolean

Skips the dynamic benefits part of the schema if set. To be used when benefits are set via its own API.

Body Params

Employment contract details params

Employment contract details params.

contract_details
object
required

Contract information. As its properties may vary depending on the country,
you must query the Show form schema endpoint
passing the country code and contract_details as path parameters.

When the job title eligibility check requires an acknowledgement, present Remote's
responsibility statement to the employer and obtain their acceptance before sending
employer_acknowledges_risk as acknowledged. Sending it asserts that the employer
was informed of, and accepted, responsibility for, as applicable, employee safety,
training, health checks, any incidents connected to the employee's work environment,
and the employee holding the licensing the role requires.

Responses

Callback
Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json