Retrieve employee additional info template | Deel

{
  "data": [
    {
      "id": "b7045ecb-c5ca-43fa-99f-61bcb700ee89",
      "name": "idType",
      "alias": "deel_additional-data_es_id-type",
      "label": "ID Type",
      "options": [
        "Passport",
        "National ID"
      ],
      "footnote": null,
      "input_type": "select",
      "local_name": "Tipo de identificacion",
      "description": "Select your identification type",
      "is_optional": false,
      "required_by": "sign_up",
      "display_order": "1",
      "how_to_obtain": null,
      "can_be_skipped": false,
      "link_to_obtain": null,
      "validation_rule": "^(Passport|National ID)$",
      "input_configuration": null,
      "link_to_obtain_label": null,
      "validation_error_message": "Must be one of the following values: Passport, National ID"
    },
    {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "name": "idNumber",
      "alias": "deel_additional-data_es_id-number",
      "label": "ID Number",
      "footnote": null,
      "input_type": "text",
      "local_name": "Numero de identificacion",
      "description": "Enter your identification number",
      "is_optional": false,
      "required_by": "sign_up",
      "dependencies": [
        {
          "id": "b7045ecb-c5ca-43fa-99f-61bcb700ee89",
          "value": "National ID"
        }
      ],
      "display_order": "2",
      "how_to_obtain": null,
      "can_be_skipped": false,
      "link_to_obtain": null,
      "validation_rule": "^[A-Z0-9]+$",
      "input_configuration": null,
      "link_to_obtain_label": null,
      "validation_error_message": "Must contain only uppercase letters and numbers",
      "dependency_condition_match_mode": "ALL"
    }
  ]
}

Retrieves the template describing which additional information fields must be collected for a worker on a given contract type in a given country. Use this endpoint when building or validating an onboarding form so the correct country- and contract-type-specific fields are requested before submitting employee information.

Token scopes: contracts: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.

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

Learn more about authentication

AuthorizationBearer

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

Path parameters

typeenumRequired

The contract type. Must be ‘eor’ (Employer of Record) or ‘gp’ (Global Payroll).

Allowed values:

countrystringRequired

ISO 3166-1 alpha-2 country code.

Response

Successful operation.

datalist of objectsOptional

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

429

Too Many Requests Error

500

Internal Server Error