EOR Worker additional fields

PATCH Update EOR worker additional fields

Updates additional information for an EOR employee agreement. Only works if the employee’s contract status is new, under_review, or waiting_for_employee_contract. Using other statuses can cause errors.

❗Note: This endpoint works with dynamic properties. To retrieve the available properties, use the following endpoint: Get worker additional fields for (EOR). There are no required properties when updating additional worker information.

Endpoint: PATCH /rest/v2/eor/workers/contracts/{contract_id}/additional-information

Token scopes: worker:write

API Reference: Retrieve bank account guide

Request Example:

curl --location --request PATCH 'https://api.letsdeel.com/rest/v2/eor/workers/contracts/{contract_id}/additional-information' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{PUBLIC_API_TOKEN}}' \
--data-raw '{
    "data": {
        "dob": "1990-07-15",
        "gender": "Male",
        "marital_status": "Married",
        "id_type": "Emirates ID",
        "id_number": "784-1990-6543210-2",
        "passport_number": "A12345678",
        "passport_validate_date": "2030-05-20",
        "visa_status": "Resident",
        "zip_code": "00000"
    }
}'

Response Example:

{
    "data": {
      "updated": true
    }
}

Update properties for EOR Banks guide

Update response properties for Retrieve bank account guide to be consistent with Get worker additional fields for (EOR)

Actual changes:

Changed requiredto is_required
Rename validationsto validation
Changes in validationobject
- Added property error_message
Added ui_guidesobject
- Moved labelfrom root object to ui_guides
- Added orderproperty
- Add helper_textto ui_guides

Response Example:

{
  "data": [
    {
      "key": "swift_bic",
      "type": "text",
      "is_required": true,
      "ui_guide": {
        "label": "SWIFT BIC Code",
        "order": 5,
        "helper_text": "Bank identifier for international wire transfers."
      },
      "validation": [
        {
          "type": "MIN_LENGTH",
          "value": "1",
          "error_message": "Value must be at least 1 characters long."
        },
        {
          "type": "MAX_LENGTH",
          "value": "140",
          "error_message": "Value must be no more than 140 characters long."
        },
        {
          "type": "REGEX",
          "value": "^[a-zA-Z0-9 ]+$",
          "error_message": "Review the value entered"
        }
      ],
      "values_allowed": []
    },
    ...
  ]
}