> This page is for API, version 2026-01-01 (Stable) (default).
> For other versions, use one of these documentation indexes:
> - 2026-01-01 (Stable) (default): https://developer.deel.com/api/stable/llms.txt

> 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.

# Update GP worker additional information

PATCH https://api.letsdeel.com/rest/gp/workers/contracts/{contract_id}/additional-information
Content-Type: application/json

Use this endpoint to correct or change country-specific additional information already held on a Global Payroll worker contract, for example after the worker reports a new marital status or a tax identifier changes. Only the fields sent under `data` are modified; everything else is left untouched. Field keys must belong to the additional-information fields defined for the contract country (see `GET /rest/forms/gp/worker-additional-fields/{country_code}`). For fields the organization has configured as effective-dated, a date must be supplied in `effective_dates` (`YYYY-MM-DD`) whenever the value changes: today or a past date applies the change immediately, a future date schedules it and the current value stays in effect until then. Unchanged values and clears need no date. Changes are recorded in the contract history and may update the worker onboarding checklist. By default returns 204. Pass `?include_completion_status=true` to receive a 200 response with `is_additional_data_done` (true when all required fields for EDM onboarding are provided) and `missing_keys` (required fields still absent). Requires the `people:write` scope.

**Token scopes**: `people:write`

Reference: https://developer.deel.com/api/endpoints/worker-information/get-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) — The unique public identifier of the contract.

### Query parameters

- `include_completion_status` (boolean, optional) — Pass `true` to receive a 200 response with `is_additional_data_done` and `missing_keys` instead of the default 204 No Content.

### Body (application/json)

This endpoint expects an object.

- `data` (map from string to GpWorkersContractsContractIdAdditionalInformationPatchRequestBodyContentApplicationJsonSchemaData, required)
- `effective_dates` (map from string to string, optional) — Per-field effective date (YYYY-MM-DD), keyed like `data`. Only allowed for effective-dated fields, and required whenever such a field is set to a new value (unchanged values and clears need no date). Past dates apply immediately as corrections, future dates are scheduled.

## Response

### 200

Returned only when `?include_completion_status=true` is passed. Contains completion status.

- `data` (GpWorkersContractsContractIdAdditionalInformationPatchResponsesContentApplicationJsonSchemaData, required)

## Errors

### 400 Bad Request Error

Operation failed.

- `errors` (list of GpWorkersContractsContractIdAdditionalInformationPatchResponsesContentApplicationJsonSchemaErrorsItems, optional)

### 401 Unauthorized Error

Unauthorized — missing or invalid authentication token.

- `errors` (list of GpWorkersContractsContractIdAdditionalInformationPatchResponsesContentApplicationJsonSchemaErrorsItems, optional)

### 403 Forbidden Error

Forbidden — caller lacks the people:write permission or cannot access this contract.

- `errors` (list of GpWorkersContractsContractIdAdditionalInformationPatchResponsesContentApplicationJsonSchemaErrorsItems, optional)

### 404 Not Found Error

Not found — the contract does not exist or is not accessible.

- `errors` (list of GpWorkersContractsContractIdAdditionalInformationPatchResponsesContentApplicationJsonSchemaErrorsItems, optional)

### 500 Internal Server Error

Operation failed.

- `errors` (list of GpWorkersContractsContractIdAdditionalInformationPatchResponsesContentApplicationJsonSchemaErrorsItems, optional)

## Types

### GpWorkersContractsContractIdAdditionalInformationPatchRequestBodyContentApplicationJsonSchemaData

### GpWorkersContractsContractIdAdditionalInformationPatchResponsesContentApplicationJsonSchemaData

- `is_updated` (boolean, required) — Indicates if the contract was updated.
- `missing_keys` (list of string, required) — Public API keys of required fields still missing. Empty when is_additional_data_done is true.
- `is_additional_data_done` (boolean, required) — True when all required additional information fields for EDM onboarding have been provided.

### GpWorkersContractsContractIdAdditionalInformationPatchResponsesContentApplicationJsonSchemaErrorsItems

- `code` (string, optional) — Machine-readable error code
- `message` (string, optional) — Human-readable explanation of the error

## Examples

**Request**

```json
{}
```

**Response**

```json
{
  "data": {
    "is_updated": true,
    "missing_keys": [
      "tax_residence",
      "bank_account_number"
    ],
    "is_additional_data_done": false
  }
}
```

**SDK Code**

```python
import requests

url = "https://api.letsdeel.com/rest/gp/workers/contracts/mnrw11a/additional-information"

querystring = {"include_completion_status":"true"}

payload = {}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers, params=querystring)

print(response.json())
```

```javascript
const url = 'https://api.letsdeel.com/rest/gp/workers/contracts/mnrw11a/additional-information?include_completion_status=true';
const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{}'
};

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/gp/workers/contracts/mnrw11a/additional-information?include_completion_status=true"

	payload := strings.NewReader("{}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	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/gp/workers/contracts/mnrw11a/additional-information?include_completion_status=true")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.patch("https://api.letsdeel.com/rest/gp/workers/contracts/mnrw11a/additional-information?include_completion_status=true")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('PATCH', 'https://api.letsdeel.com/rest/gp/workers/contracts/mnrw11a/additional-information?include_completion_status=true', [
  'body' => '{}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.letsdeel.com/rest/gp/workers/contracts/mnrw11a/additional-information?include_completion_status=true");
var request = new RestRequest(Method.PATCH);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.letsdeel.com/rest/gp/workers/contracts/mnrw11a/additional-information?include_completion_status=true")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "PATCH"
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()
```