Retrieve additional information fields for GP workers by country

GET

/forms/gp/worker-additional-fields/:country_code

GET

/rest/v2/forms/gp/worker-additional-fields/:country_code

$ curl https://api.letsdeel.com/rest/v2/forms/gp/worker-additional-fields/ES \
>      -H "Authorization: Bearer <token>"

1 {
2   "data": [
3     {
4       "key": "additional_name",
5       "type": "string",
6       "ui_guide": {
7         "label": "Preferred Name / Additional Name",
8         "order": 1,
9         "field_type": "text",
10         "description": "Preferred name / Additional name",
11         "helper_text": "",
12         "local_label": "Imie preferowane"
13       },
14       "validation": [
15         {
16           "type": "REGEX",
17           "error_message": "Review the value entered",
18           "value": "^.*$"
19         }
20       ],
21       "is_required": false,
22       "dependencies": [],
23       "required_by": "before_payroll"
24     },
25     {
26       "key": "dob",
27       "type": "string",
28       "ui_guide": {
29         "label": "Date of Birth",
30         "order": 2,
31         "field_type": "date",
32         "description": "Date of Birth",
33         "helper_text": "",
34         "local_label": "Data urodzenia"
35       },
36       "validation": [
37         {
38           "type": "REGEX",
39           "error_message": "Review the value entered",
40           "value": "^.*$"
41         }
42       ],
43       "is_required": true,
44       "dependencies": [
45         {
46           "key": "country",
47           "value": "UK"
48         }
49       ],
50       "required_by": "before_payroll"
51     },
52     {
53       "key": "marital_status",
54       "type": "string",
55       "ui_guide": {
56         "label": "Marital Status",
57         "order": 3,
58         "field_type": "select",
59         "description": "Marital status of the worker",
60         "helper_text": "Select the worker's current marital status",
61         "local_label": "Stan cywilny"
62       },
63       "validation": [],
64       "is_required": true,
65       "dependencies": [],
66       "required_by": "contract_signing",
67       "values_allowed": [
68         "Single",
69         "Married",
70         "Divorced",
71         "Widowed"
72       ]
73     }
74   ]
75 }

Retrieves the country-specific additional information fields required for GP workers to run payroll in compliance with local regulations. Token scopes: forms:read

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.

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

Learn more about authentication

## 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)

AuthorizationBearer

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

Path parameters

country_codestringRequired

ISO 3166-1 alpha-2 country code for which to retrieve GP worker additional fields.

Response

Use this response to render dynamic form fields for GP worker onboarding. Contains field configuration, validation rules, display metadata, and dependency logic needed to build country-specific additional information forms.

datalist of objects

Use this array to build the form UI. Each item defines one field with its type, validation, and display configuration. Items are pre-sorted by EDM display order. An empty array means no additional fields are configured for the requested country.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

429

Too Many Requests Error

500

Internal Server Error

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