Skip to navigation

Create the additional details of an EOR hire worker

Beta

Submit the additional details of an EOR hire as its worker, then read the hire intent again. Use it when the intent names additional_details or payroll_fields as the next action. Include the country payroll fields in the body: Deel requires them here, and refuses further country fields once the details are in. Send the worker token (PAT:WORKER) in Authorization. Send an Idempotency-Key to retry safely. The response is the hire intent after the write.

Token scopes: worker:write

Beta: this version requires the X-Beta: true request header and its contract may change before it is promoted to stable. It is scheduled to become stable on 2027-02-18.

Authentication

AuthorizationBearer

Authentication

The Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.

curl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \
  -H 'Authorization: Bearer YOUR-TOKEN-HERE'

Learn more about authentication

OR
AuthorizationBearer

Standard OAuth2 security scheme based on https://swagger.io/docs/specification/authentication/

Path parameters

contract_idstringRequired

Public id of the EOR contract (the client contract returned by POST /rest/eor)

Headers

X-BetaenumRequiredDefaults to true

Opts in to the beta version of this endpoint. Must be true.

Allowed values:

Request

This endpoint expects an object.
dataobjectRequired

The fields below are the same for every hire. Other keys are country fields: GET /rest/forms/eor/worker-additional-fields/{country_code} lists them.

Response

The EOR hire intent after the write
dataobject
The EOR hire intent, in the Deel Intent Standard envelope

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
500
Internal Server Error
502
Bad Gateway Error