> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://developer.deel.com/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://developer.deel.com/_mcp/server. # Add additional information POST https://api.letsdeel.com/rest/eor/workers/contracts/{contract_id}/additional-information Content-Type: application/json Adds supplemental information fields to an EOR employee's contract record. **Token scopes**: `worker:write` Reference: https://developer.deel.com/api/eor-worker-endpoints/eor-worker-information/create-gp-worker-additional-information ## Authentication - `Authorization` header (bearer token, required) — ## 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 curl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \ -H 'Authorization: Bearer YOUR-TOKEN-HERE' ``` [Learn more about authentication](/api/authentication) - `Authorization` header (bearer token, required) — Standard OAuth2 security scheme based on https://swagger.io/docs/specification/authentication/ ## Servers - `https://api.letsdeel.com/rest` (Production, default) - `https://api-staging.letsdeel.com/rest` (Demo) ## Request ### Path parameters - `contract_id` (string, required) — Deel contract id. ### Body (application/json) This endpoint expects an object. - `data` (EorWorkersContractsContractIdAdditionalInformationPostRequestBodyContentApplicationJsonSchemaData, required) — Additional fields are country/state-specific and validated against the worker additional fields form for the employment country. ## Response ### 200 Successful operation. - `data` (EorWorkersContractsContractIdAdditionalInformationPostResponsesContentApplicationJsonSchemaData, required) ## Errors ### 400 Bad Request Error Bad request. Contract not found, contract is not EOR, required base fields are missing, or country-specific additional field validation failed. - `errors` (list of EorWorkersContractsContractIdAdditionalInformationPostResponsesContentApplicationJsonSchemaErrorsItems, required) - `translations` (list of EorWorkersContractsContractIdAdditionalInformationPostResponsesContentApplicationJsonSchemaTranslationsItems, optional) — Present when additional fields fail validation, to map internal field keys back to public API keys. ### 401 Unauthorized Error Authentication failed. Bearer token is missing, expired, or invalid. - `errors` (list of EorWorkersContractsContractIdAdditionalInformationPostResponsesContentApplicationJsonSchemaErrorsItems, required) ### 403 Forbidden Error Forbidden. The token lacks worker:write scope or the worker cannot update this contract. - `errors` (list of EorWorkersContractsContractIdAdditionalInformationPostResponsesContentApplicationJsonSchemaErrorsItems, required) ### 404 Not Found Error Not found. No additional information template exists for the employment country/state. - `errors` (list of EorWorkersContractsContractIdAdditionalInformationPostResponsesContentApplicationJsonSchemaErrorsItems, required) ### 429 Too Many Requests Error Rate limit exceeded. - `errors` (list of EorWorkersContractsContractIdAdditionalInformationPostResponsesContentApplicationJsonSchemaErrorsItems, required) ### 500 Internal Server Error Internal server error. - `errors` (list of EorWorkersContractsContractIdAdditionalInformationPostResponsesContentApplicationJsonSchemaErrorsItems, required) ## Types ### EorWorkersContractsContractIdAdditionalInformationPostRequestBodyContentApplicationJsonSchemaData Additional fields are country/state-specific and validated against the worker additional fields form for the employment country. - `city` (string, required) — City - `phone` (string, required) — Worker phone - `street` (string, required) — Street - `zip_code` (string, required) — Zipcode/Post code - `tax_residence` (string, required) — Worker tax residence - `is_payslip_access_allowed` (boolean, required) — Worker access to payslips - `is_compliance_access_allowed` (boolean, required) — Worker access to compliance documents - `state` (string, optional) — State/province (required for countries with provinces/states). ### EorWorkersContractsContractIdAdditionalInformationPostResponsesContentApplicationJsonSchemaData - `updated` (boolean, required) — Indicates if contract was updated ### EorWorkersContractsContractIdAdditionalInformationPostResponsesContentApplicationJsonSchemaErrorsItems - `message` (string, required) ### EorWorkersContractsContractIdAdditionalInformationPostResponsesContentApplicationJsonSchemaTranslationsItems - `originalKey` (string, required) - `publicApiKey` (string, required) ## Examples **Request** ```json { "data": { "city": "New York", "phone": "+1-555-123-4567", "street": "123 Main St", "zip_code": "10001", "tax_residence": "US", "is_payslip_access_allowed": true, "is_compliance_access_allowed": true } } ``` **Response** ```json { "data": { "updated": true } } ``` **SDK Code** ```python import requests url = "https://api.letsdeel.com/rest/eor/workers/contracts/37nex2x/additional-information" payload = { "data": { "city": "New York", "phone": "+1-555-123-4567", "street": "123 Main St", "zip_code": "10001", "tax_residence": "US", "is_payslip_access_allowed": True, "is_compliance_access_allowed": True } } headers = { "Authorization": "Bearer ", "Content-Type": "application/json" } response = requests.post(url, json=payload, headers=headers) print(response.json()) ``` ```javascript const url = 'https://api.letsdeel.com/rest/eor/workers/contracts/37nex2x/additional-information'; const options = { method: 'POST', headers: {Authorization: 'Bearer ', 'Content-Type': 'application/json'}, body: '{"data":{"city":"New York","phone":"+1-555-123-4567","street":"123 Main St","zip_code":"10001","tax_residence":"US","is_payslip_access_allowed":true,"is_compliance_access_allowed":true}}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://api.letsdeel.com/rest/eor/workers/contracts/37nex2x/additional-information" payload := strings.NewReader("{\n \"data\": {\n \"city\": \"New York\",\n \"phone\": \"+1-555-123-4567\",\n \"street\": \"123 Main St\",\n \"zip_code\": \"10001\",\n \"tax_residence\": \"US\",\n \"is_payslip_access_allowed\": true,\n \"is_compliance_access_allowed\": true\n }\n}") req, _ := http.NewRequest("POST", url, payload) req.Header.Add("Authorization", "Bearer ") req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://api.letsdeel.com/rest/eor/workers/contracts/37nex2x/additional-information") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Post.new(url) request["Authorization"] = 'Bearer ' request["Content-Type"] = 'application/json' request.body = "{\n \"data\": {\n \"city\": \"New York\",\n \"phone\": \"+1-555-123-4567\",\n \"street\": \"123 Main St\",\n \"zip_code\": \"10001\",\n \"tax_residence\": \"US\",\n \"is_payslip_access_allowed\": true,\n \"is_compliance_access_allowed\": true\n }\n}" response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.post("https://api.letsdeel.com/rest/eor/workers/contracts/37nex2x/additional-information") .header("Authorization", "Bearer ") .header("Content-Type", "application/json") .body("{\n \"data\": {\n \"city\": \"New York\",\n \"phone\": \"+1-555-123-4567\",\n \"street\": \"123 Main St\",\n \"zip_code\": \"10001\",\n \"tax_residence\": \"US\",\n \"is_payslip_access_allowed\": true,\n \"is_compliance_access_allowed\": true\n }\n}") .asString(); ``` ```php request('POST', 'https://api.letsdeel.com/rest/eor/workers/contracts/37nex2x/additional-information', [ 'body' => '{ "data": { "city": "New York", "phone": "+1-555-123-4567", "street": "123 Main St", "zip_code": "10001", "tax_residence": "US", "is_payslip_access_allowed": true, "is_compliance_access_allowed": true } }', 'headers' => [ 'Authorization' => 'Bearer ', 'Content-Type' => 'application/json', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://api.letsdeel.com/rest/eor/workers/contracts/37nex2x/additional-information"); var request = new RestRequest(Method.POST); request.AddHeader("Authorization", "Bearer "); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{\n \"data\": {\n \"city\": \"New York\",\n \"phone\": \"+1-555-123-4567\",\n \"street\": \"123 Main St\",\n \"zip_code\": \"10001\",\n \"tax_residence\": \"US\",\n \"is_payslip_access_allowed\": true,\n \"is_compliance_access_allowed\": true\n }\n}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = [ "Authorization": "Bearer ", "Content-Type": "application/json" ] let parameters = ["data": [ "city": "New York", "phone": "+1-555-123-4567", "street": "123 Main St", "zip_code": "10001", "tax_residence": "US", "is_payslip_access_allowed": true, "is_compliance_access_allowed": true ]] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://api.letsdeel.com/rest/eor/workers/contracts/37nex2x/additional-information")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "POST" request.allHTTPHeaderFields = headers request.httpBody = postData as Data let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```