GuidesAPI ReferenceChangelog
Changelog

v2.1.104

Update status property for Right to Work case details

Properties for the Right to Work case are update to contain only list of possible values for which the process can be in.

Actual changes:

  • data.process.name property can contain values
[
  "WORK_AUTHORIZATION_VERIFICATION"
]
  • data.process.status property contains values 
[
  "CANCELLED",
  "AWAITING_DOCUMENTS",
  "IN_REVIEW",
  "APPROVED",
  "REJECTED"
]
  • data.case_type
[
	"IMMIGRATION_DOCUMENT_REVIEW"
]

EOR Tax documents

Get list of tax documents for an EOR employee.

Endpoint: GET /rest/v2/eor/workers/tax-documents

Token scopes: worker:read

API Reference: List of tax documents for an employee

Example:

curl --location --globoff 'https://api.letsdeel.com/rest/v2/eor/workers/tax-documents' \
--header 'Authorization: Bearer {{PUBLIC_API_TOKEN}}' \
--header 'accept: application/json' \

v2.1.102

Improvements

Time Tracking

Enhanced the GET /time_tracking/shifts endpoint to support additional filtering capabilities.
You can now filter shift records by:

  • from_date & to_date: Retrieve shifts for a specific date or range.
  • contract_id: Narrow results to a specific contract.

These improvements make it easier to query relevant shift data, enabling more precise reporting and analysis for both administrators and users.

v2.1.97

Worker Immigration

Get right to work case

Returns the right to work case for employee onboarding including the documents if any. In case no right to work case is open, the response will be empty..

Endpoint: GET /rest/v2/immigration/workers/{worker_id}/onboarding-case

Token scopes: worker:read

API Reference: Get right to work case

Example:

curl --location --globoff 'https://api.letsdeel.com/rest/v2/immigration/workers/{worker_id}/onboarding-case' \
--header 'Authorization: Bearer {{PUBLIC_API_TOKEN}}' \
--header 'accept: application/json' \

Get right to work case required documents

Returns the required documents to be uploaded for a right to work case.

Endpoint: GET /rest/v2/immigration/workers/{worker_id}/required-documents

Token scopes: worker:read

API Reference: Get right to work case required documents

Example:

curl --location --globoff 'https://api.letsdeel.com/rest/v2/immigration/workers/{worker_id}/required-documents' \
--header 'Authorization: Bearer {{PUBLIC_API_TOKEN}}' \
--header 'accept: application/json'

Upload required immigration document

Endpoint to upload the required immigration document for a case

Endpoint: POST /rest/v2/immigration/workers/documents

Token scopes: worker:write

API Reference: Upload required immigration document

Example:

curl --request POST \
     --url https://api.letsdeel.com/rest/v2/immigration/workers/documents \
     --header 'content-type: multipart/form-data' \
     --form 'file={{file_base64}}' \
     --form case_id=6be9daaf-ecaf-492b-9ee1-1d9e9694573b \
     --form worker_id=b10b08d3-332b-4f21-865a-40892a21d916 \
     --form immigration_document_requirement_id=193f0462-6129-4579-9c4d-671c08d74df2

TimeOff

Get Time Off Events for Profile

List time off events for profile

Endpoint: GET /rest/v2/time_offs/time-off-events

Token scopes: time-off:read

API Reference: Get Time Off Events for Profile

Example:

curl --request GET \
     --url 'https://api.letsdeel.com/rest/v2/time_offs/time-off-events?hris_profile_id=76cf9b3d-82b2-4641-b741-2d12c00fc1a3' \
     --header 'accept: application/json' \
     --header 'Authorization: Bearer {{PUBLIC_API_TOKEN}}'

Improvements

Time tracking

  • Removed meta property from PATCH /time_tracking/shifts

Time-Off

  • Now it is possible to request/update/validate parental leaves or any other event based leave
    • Time off request and update API returns the time off event that was created or associated to the request
    • Time off valdiate API returns the required event details fields and type. It also returns whether the policy is event based or not.
  • Add new API to return time off events for the given profile

EOR contract creation

  • Added new employment.employee_completed_past_probation property to request body:
    • Used to indicate whether the employee has previously passed the probation period.

v2.1.95

Updated: POST EOR Contract Creation

Added missing request body fields to the employment object:

  • probation_period_type_for_definite: Specifies the type of probation period (STANDARD or CUSTOM).
  • notice_period_type: Specifies the type of notice period (STANDARD or CUSTOM).
  • notice_period_during_probation: Defines the notice period (in days) during probation if notice_period_type is CUSTOM.
  • notice_period_after_probation: Defines the notice period (in days) after probation if notice_period_type is CUSTOM.

Endpoint: POST /rest/v2/eor

API Reference: Crete EOR Contract

v2.1.94

EOR Bank Guides


GET Retrieve bank account guide

Retrieve bank account form guide for an EOR employee. This data can be used to add a new bank account for an employee.

Endpoint: GET /rest/v2/eor/workers/banks-guide/country/{country}/currency/{currency}

Token scopes: worker:read

API Reference: Retrieve bank account guide

Example:

curl --location 'https://api.letsdeel.com/rest/v2/eor/workers/banks-guide/country/FR/currency/EUR' \
--header 'Authorization: Bearer {{PUBLIC_API_TOKEN}}' \

Response example: 

{
    "data": [
        {
            "label": "Account Custom Name",
            "type": "text",
            "required": false,
            "key": "custom_name",
            "validations": [
                {
                    "type": "MIN_LENGTH",
                    "value": "0"
                },
                {
                    "type": "MAX_LENGTH",
                    "value": "30"
                }
            ],
            "values_allowed": []
        },
        {
            "label": "Payment type",
            "type": "select",
            "required": true,
            "key": "payment_type",
            "validations": [],
            "values_allowed": [
                {
                    "label": "Bank transfer",
                    "value": "bank_transfer"
                }
            ]
        },
        {
            "label": "Currency",
            "type": "select",
            "required": true,
            "key": "currency_code",
            "validations": [],
            "values_allowed": [
                {
                    "label": "AED - United Arab Emirates Dirham",
                    "value": "AED"
                },
                {
                    "label": "AFN - Afghani",
                    "value": "AFN"
                },
                {
                    "label": "ALL - Albanian Lek",
                    "value": "ALL"
                },
                {
                    "label": "AMD - Armenian Dram",
                    "value": "AMD"
                },
                {
                    "label": "ANG - Netherlands Antillean Guilder",
                    "value": "ANG"
                },
                {
                    "label": "AOA - Kwanza",
                    "value": "AOA"
                },
                {
                    "label": "ARS - Argentine Peso",
                    "value": "ARS"
                },
                {
                    "label": "AUD - Australian Dollar",
                    "value": "AUD"
                },
                {
                    "label": "AWG - Aruban Florin",
                    "value": "AWG"
                },
                {
                    "label": "AZN - Azerbaijani Manat",
                    "value": "AZN"
                },
                {
                    "label": "BAM - Bosnia and Herzegovina Convertible Mark",
                    "value": "BAM"
                },
                {
                    "label": "BBD - Barbadian Dollar",
                    "value": "BBD"
                },
                {
                    "label": "BDT - Bangladeshi Taka",
                    "value": "BDT"
                },
                {
                    "label": "BGN - Bulgarian Lev",
                    "value": "BGN"
                },
                {
                    "label": "BHD - Bahraini Dinar",
                    "value": "BHD"
                },
                {
                    "label": "BIF - Burundi Franc",
                    "value": "BIF"
                },
                {
                    "label": "BMD - Bermudian Dollar",
                    "value": "BMD"
                },
                {
                    "label": "BND - Brunei Dollar",
                    "value": "BND"
                },
                {
                    "label": "BOB - Bolivian Boliviano",
                    "value": "BOB"
                },
                {
                    "label": "BRL - Brazilian Real",
                    "value": "BRL"
                },
                {
                    "label": "BSD - Bahamian Dollar",
                    "value": "BSD"
                },
                {
                    "label": "BTN - Ngultrum",
                    "value": "BTN"
                },
                {
                    "label": "BWP - Pula",
                    "value": "BWP"
                },
                {
                    "label": "BYN - Belarusian Ruble",
                    "value": "BYN"
                },
                {
                    "label": "BZD - Belize Dollar",
                    "value": "BZD"
                },
                {
                    "label": "CAD - Canadian Dollar",
                    "value": "CAD"
                },
                {
                    "label": "CDF - Congolese Franc",
                    "value": "CDF"
                },
                {
                    "label": "CHF - Swiss Franc",
                    "value": "CHF"
                },
                {
                    "label": "CLP - Chilean Peso",
                    "value": "CLP"
                },
                {
                    "label": "CNY - Chinese Yuan",
                    "value": "CNY"
                },
                {
                    "label": "COP - Colombian Peso",
                    "value": "COP"
                },
                {
                    "label": "CRC - Costa Rican Colon",
                    "value": "CRC"
                },
                {
                    "label": "CUP - Cuban Peso",
                    "value": "CUP"
                },
                {
                    "label": "CVE - Cape Verdean Escudo",
                    "value": "CVE"
                },
                {
                    "label": "CZK - Czech Koruna",
                    "value": "CZK"
                },
                {
                    "label": "DJF - Djiboutian Franc",
                    "value": "DJF"
                },
                {
                    "label": "DKK - Danish Krone",
                    "value": "DKK"
                },
                {
                    "label": "DOP - Dominican Peso",
                    "value": "DOP"
                },
                {
                    "label": "DZD - Algerian Dinar",
                    "value": "DZD"
                },
                {
                    "label": "EGP - Egyptian Pound",
                    "value": "EGP"
                },
                {
                    "label": "ERN - Eritrean Nakfa",
                    "value": "ERN"
                },
                {
                    "label": "ETB - Ethiopian Birr",
                    "value": "ETB"
                },
                {
                    "label": "EUR - Euro",
                    "value": "EUR"
                },
                {
                    "label": "FJD - Fijian Dollar",
                    "value": "FJD"
                },
                {
                    "label": "FKP - Falkland Islands Pound",
                    "value": "FKP"
                },
                {
                    "label": "GBP - British Pound",
                    "value": "GBP"
                },
                {
                    "label": "GEL - Georgian Lari",
                    "value": "GEL"
                },
                {
                    "label": "GHS - Ghanaian Cedi",
                    "value": "GHS"
                },
                {
                    "label": "GIP - Gibraltar Pound",
                    "value": "GIP"
                },
                {
                    "label": "GMD - Gambian Dalasi",
                    "value": "GMD"
                },
                {
                    "label": "GNF - Guinea Franc",
                    "value": "GNF"
                },
                {
                    "label": "GTQ - Guatemalan Quetzal",
                    "value": "GTQ"
                },
                {
                    "label": "GYD - Guyanese Dollar",
                    "value": "GYD"
                },
                {
                    "label": "HKD - Hong Kong Dollar",
                    "value": "HKD"
                },
                {
                    "label": "HNL - Honduran Lempira",
                    "value": "HNL"
                },
                {
                    "label": "HRK - Croatian Kuna",
                    "value": "HRK"
                },
                {
                    "label": "HTG - Haitian Gourde",
                    "value": "HTG"
                },
                {
                    "label": "HUF - Hungarian Forint",
                    "value": "HUF"
                },
                {
                    "label": "IDR - Indonesian Rupiah",
                    "value": "IDR"
                },
                {
                    "label": "ILS - Israeli New Shekel",
                    "value": "ILS"
                },
                {
                    "label": "INR - Indian Rupee",
                    "value": "INR"
                },
                {
                    "label": "IQD - Iraqi Dinar",
                    "value": "IQD"
                },
                {
                    "label": "ISK - Icelandic Króna",
                    "value": "ISK"
                },
                {
                    "label": "JMD - Jamaican Dollar",
                    "value": "JMD"
                },
                {
                    "label": "JOD - Jordanian Dinar",
                    "value": "JOD"
                },
                {
                    "label": "JPY - Japanese Yen",
                    "value": "JPY"
                },
                {
                    "label": "KES - Kenyan Shilling",
                    "value": "KES"
                },
                {
                    "label": "KGS - Kyrgyzstani Som",
                    "value": "KGS"
                },
                {
                    "label": "KHR - Cambodian Riel",
                    "value": "KHR"
                },
                {
                    "label": "KMF - Comorian Franc",
                    "value": "KMF"
                },
                {
                    "label": "KPW - North Korean Won",
                    "value": "KPW"
                },
                {
                    "label": "KRW - South Korean Won",
                    "value": "KRW"
                },
                {
                    "label": "KWD - Kuwaiti Dinar",
                    "value": "KWD"
                },
                {
                    "label": "KYD - Cayman Islands Dollar",
                    "value": "KYD"
                },
                {
                    "label": "KZT - Kazakhstani Tenge",
                    "value": "KZT"
                },
                {
                    "label": "LAK - Kip",
                    "value": "LAK"
                },
                {
                    "label": "LBP - Lebanese Pound",
                    "value": "LBP"
                },
                {
                    "label": "LKR - Sri Lankan Rupee",
                    "value": "LKR"
                },
                {
                    "label": "LSL - Lesotho Loti",
                    "value": "LSL"
                },
                {
                    "label": "LTL - Lithuania Litas",
                    "value": "LTL"
                },
                {
                    "label": "LVL - Latvian Lats",
                    "value": "LVL"
                },
                {
                    "label": "LYD - Libyan Dinar",
                    "value": "LYD"
                },
                {
                    "label": "MAD - Moroccan Dirham",
                    "value": "MAD"
                },
                {
                    "label": "MDL - Moldovan Leu",
                    "value": "MDL"
                },
                {
                    "label": "MGA - Malagasy Ariary",
                    "value": "MGA"
                },
                {
                    "label": "MKD - Macedonian Denar",
                    "value": "MKD"
                },
                {
                    "label": "MMK - Burmese Kyat",
                    "value": "MMK"
                },
                {
                    "label": "MNT - Mongolian Tögrög",
                    "value": "MNT"
                },
                {
                    "label": "MOP - Macanese Pataca",
                    "value": "MOP"
                },
                {
                    "label": "MRO - Mauritanian Ouguiya",
                    "value": "MRO"
                },
                {
                    "label": "MRU - Mauritanian Ouguiya",
                    "value": "MRU"
                },
                {
                    "label": "MUR - Mauritian Rupee",
                    "value": "MUR"
                },
                {
                    "label": "MVR - Maldivian Rufiyaa",
                    "value": "MVR"
                },
                {
                    "label": "MWK - Malawian Kwacha",
                    "value": "MWK"
                },
                {
                    "label": "MXN - Mexican Peso",
                    "value": "MXN"
                },
                {
                    "label": "MYR - Malaysian Ringgit",
                    "value": "MYR"
                },
                {
                    "label": "MZN - Mozambican Metical",
                    "value": "MZN"
                },
                {
                    "label": "NAD - Namibia Dollar",
                    "value": "NAD"
                },
                {
                    "label": "NGN - Nigerian Naira",
                    "value": "NGN"
                },
                {
                    "label": "NIO - Nicaraguan Córdoba",
                    "value": "NIO"
                },
                {
                    "label": "NOK - Norwegian Krone",
                    "value": "NOK"
                },
                {
                    "label": "NPR - Nepalese Rupee",
                    "value": "NPR"
                },
                {
                    "label": "NZD - New Zealand Dollar",
                    "value": "NZD"
                },
                {
                    "label": "OMR - Omani Rial",
                    "value": "OMR"
                },
                {
                    "label": "PAB - Panamanian Balboa",
                    "value": "PAB"
                },
                {
                    "label": "PEN - Peruvian Sol",
                    "value": "PEN"
                },
                {
                    "label": "PGK - Kina",
                    "value": "PGK"
                },
                {
                    "label": "PHP - Philippine Peso",
                    "value": "PHP"
                },
                {
                    "label": "PKR - Pakistani Rupee",
                    "value": "PKR"
                },
                {
                    "label": "PLN - Polish Złoty",
                    "value": "PLN"
                },
                {
                    "label": "PYG - Paraguayan Guarani",
                    "value": "PYG"
                },
                {
                    "label": "QAR - Qatari Riyal",
                    "value": "QAR"
                },
                {
                    "label": "RON - Romanian Leu",
                    "value": "RON"
                },
                {
                    "label": "RSD - Serbian Dinar",
                    "value": "RSD"
                },
                {
                    "label": "RUB - Russian Ruble",
                    "value": "RUB"
                },
                {
                    "label": "RWF - Rwandan Franc",
                    "value": "RWF"
                },
                {
                    "label": "SAR - Saudi Riyal",
                    "value": "SAR"
                },
                {
                    "label": "SBD - Solomon Islands Dollar",
                    "value": "SBD"
                },
                {
                    "label": "SCR - Seychellois Rupee",
                    "value": "SCR"
                },
                {
                    "label": "SDG - Sudanese Pound",
                    "value": "SDG"
                },
                {
                    "label": "SEK - Swedish Krona",
                    "value": "SEK"
                },
                {
                    "label": "SGD - Singapore Dollar",
                    "value": "SGD"
                },
                {
                    "label": "SHP - Saint Helena Pound",
                    "value": "SHP"
                },
                {
                    "label": "SLL - Sierra Leonean Leone",
                    "value": "SLL"
                },
                {
                    "label": "SOS - Somali Shilling",
                    "value": "SOS"
                },
                {
                    "label": "SRD - Surinamese Dollar",
                    "value": "SRD"
                },
                {
                    "label": "SSP - South Sudanese Pound",
                    "value": "SSP"
                },
                {
                    "label": "STN - São Tomé and Príncipe Dobra",
                    "value": "STN"
                },
                {
                    "label": "SVC - Salvadoran Colón",
                    "value": "SVC"
                },
                {
                    "label": "SYP - Syrian Pound",
                    "value": "SYP"
                },
                {
                    "label": "SZL - Swazi Lilangeni",
                    "value": "SZL"
                },
                {
                    "label": "THB - Thai Baht",
                    "value": "THB"
                },
                {
                    "label": "TJS - Tajikistani Somoni",
                    "value": "TJS"
                },
                {
                    "label": "TMT - Turkmenistan Manat",
                    "value": "TMT"
                },
                {
                    "label": "TND - Tunisian Dinar",
                    "value": "TND"
                },
                {
                    "label": "TOP - Tongan Paʻanga",
                    "value": "TOP"
                },
                {
                    "label": "TRY - Turkish Lira",
                    "value": "TRY"
                },
                {
                    "label": "TTD - Trinidad and Tobago Dollar",
                    "value": "TTD"
                },
                {
                    "label": "TWD - New Taiwan Dollar",
                    "value": "TWD"
                },
                {
                    "label": "TZS - Tanzanian Shilling",
                    "value": "TZS"
                },
                {
                    "label": "UAH - Ukrainian Hryvnia",
                    "value": "UAH"
                },
                {
                    "label": "UGX - Ugandan Shilling",
                    "value": "UGX"
                },
                {
                    "label": "USD - US Dollar",
                    "value": "USD"
                },
                {
                    "label": "UYU - Uruguayan Peso",
                    "value": "UYU"
                },
                {
                    "label": "UZS - Uzbekistani Soum",
                    "value": "UZS"
                },
                {
                    "label": "VES - Venezuelan Bolívar Soberano",
                    "value": "VES"
                },
                {
                    "label": "VND - Vietnamese Dồng",
                    "value": "VND"
                },
                {
                    "label": "VUV - Vanuatu Vatu",
                    "value": "VUV"
                },
                {
                    "label": "WST - Samoan Tālā",
                    "value": "WST"
                },
                {
                    "label": "XAF - Central African CFA franc",
                    "value": "XAF"
                },
                {
                    "label": "XAG - Silver",
                    "value": "XAG"
                },
                {
                    "label": "XAU - Gold",
                    "value": "XAU"
                },
                {
                    "label": "XCD - East Caribbean Dollar",
                    "value": "XCD"
                },
                {
                    "label": "XOF - West African CFA Franc",
                    "value": "XOF"
                },
                {
                    "label": "XPF - CFP Franc",
                    "value": "XPF"
                },
                {
                    "label": "YER - Yemeni Rial",
                    "value": "YER"
                },
                {
                    "label": "ZAR - South African Rand",
                    "value": "ZAR"
                },
                {
                    "label": "ZMW - Zambian Kwacha",
                    "value": "ZMW"
                },
                {
                    "label": "ZWL - Zimbabwean Dollar",
                    "value": "ZWL"
                }
            ]
        },
        {
            "label": "Bank Country Code",
            "type": "select",
            "required": true,
            "key": "bank_country_code",
            "validations": [],
            "values_allowed": [
                {
                    "label": "Andorra",
                    "value": "AD"
                },
                {
                    "label": "Austria",
                    "value": "AT"
                },
                {
                    "label": "Belgium",
                    "value": "BE"
                },
                {
                    "label": "Bulgaria",
                    "value": "BG"
                },
                {
                    "label": "Switzerland",
                    "value": "CH"
                },
                {
                    "label": "Cyprus",
                    "value": "CY"
                },
                {
                    "label": "Czech Republic",
                    "value": "CZ"
                },
                {
                    "label": "Germany",
                    "value": "DE"
                },
                {
                    "label": "Denmark",
                    "value": "DK"
                },
                {
                    "label": "Estonia",
                    "value": "EE"
                },
                {
                    "label": "Spain",
                    "value": "ES"
                },
                {
                    "label": "Finland",
                    "value": "FI"
                },
                {
                    "label": "France",
                    "value": "FR"
                },
                {
                    "label": "United Kingdom",
                    "value": "GB"
                },
                {
                    "label": "Gibraltar",
                    "value": "GI"
                },
                {
                    "label": "Greece",
                    "value": "GR"
                },
                {
                    "label": "Croatia",
                    "value": "HR"
                },
                {
                    "label": "Hungary",
                    "value": "HU"
                },
                {
                    "label": "Ireland",
                    "value": "IE"
                },
                {
                    "label": "Iceland",
                    "value": "IS"
                },
                {
                    "label": "Italy",
                    "value": "IT"
                },
                {
                    "label": "Liechtenstein",
                    "value": "LI"
                },
                {
                    "label": "Lithuania",
                    "value": "LT"
                },
                {
                    "label": "Luxembourg",
                    "value": "LU"
                },
                {
                    "label": "Latvia",
                    "value": "LV"
                },
                {
                    "label": "Monaco",
                    "value": "MC"
                },
                {
                    "label": "Malta",
                    "value": "MT"
                },
                {
                    "label": "Netherlands",
                    "value": "NL"
                },
                {
                    "label": "Norway",
                    "value": "NO"
                },
                {
                    "label": "Poland",
                    "value": "PL"
                },
                {
                    "label": "Portugal",
                    "value": "PT"
                },
                {
                    "label": "Romania",
                    "value": "RO"
                },
                {
                    "label": "Sweden",
                    "value": "SE"
                },
                {
                    "label": "Slovenia",
                    "value": "SI"
                },
                {
                    "label": "Slovakia",
                    "value": "SK"
                },
                {
                    "label": "San Marino",
                    "value": "SM"
                }
            ]
        },
        {
            "label": "Full Name",
            "type": "text",
            "required": true,
            "key": "full_name",
            "validations": [
                {
                    "type": "MIN_LENGTH",
                    "value": "1"
                },
                {
                    "type": "MAX_LENGTH",
                    "value": "140"
                },
                {
                    "type": "REGEX",
                    "value": "^[a-zA-ZàáâǎäãåāÀÁÂÄÃÅĀæÆçćčÇĆČèéêëēėęÈÉÊËĒĖĘîïíīįìÎÏÍĪĮÌłŁñńÑŃöòóøôōõÖÒÓØŌÕÔœŒßẞțśșšşŚŠŞûüùúūÛÜÙÚŪÿŸžźżŽŹŻ '-.]*$"
                }
            ],
            "values_allowed": []
        },
        {
            "label": "Address Line 1",
            "type": "text",
            "required": true,
            "key": "address_line1",
            "validations": [
                {
                    "type": "MIN_LENGTH",
                    "value": "1"
                },
                {
                    "type": "MAX_LENGTH",
                    "value": "70"
                }
            ],
            "values_allowed": []
        },
        {
            "label": "Address Line 2",
            "type": "text",
            "required": false,
            "key": "address_line2",
            "validations": [
                {
                    "type": "MIN_LENGTH",
                    "value": "0"
                },
                {
                    "type": "MAX_LENGTH",
                    "value": "70"
                }
            ],
            "values_allowed": []
        },
        {
            "label": "City",
            "type": "text",
            "required": true,
            "key": "city",
            "validations": [
                {
                    "type": "MIN_LENGTH",
                    "value": "1"
                },
                {
                    "type": "MAX_LENGTH",
                    "value": "35"
                }
            ],
            "values_allowed": []
        },
        {
            "label": "Country Code",
            "type": "select",
            "required": true,
            "key": "country_code",
            "validations": [],
            "values_allowed": [
                {
                    "label": "Andorra",
                    "value": "AD"
                },
                {
                    "label": "United Arab Emirates",
                    "value": "AE"
                },
                {
                    "label": "Afghanistan",
                    "value": "AF"
                },
                {
                    "label": "Antigua and Barbuda",
                    "value": "AG"
                },
                {
                    "label": "Anguilla",
                    "value": "AI"
                },
                {
                    "label": "Albania",
                    "value": "AL"
                },
                {
                    "label": "Armenia",
                    "value": "AM"
                },
                {
                    "label": "Netherlands Antilles",
                    "value": "AN"
                },
                {
                    "label": "Angola",
                    "value": "AO"
                },
                {
                    "label": "Antarctica",
                    "value": "AQ"
                },
                {
                    "label": "Argentina",
                    "value": "AR"
                },
                {
                    "label": "American Samoa",
                    "value": "AS"
                },
                {
                    "label": "Austria",
                    "value": "AT"
                },
                {
                    "label": "Australia",
                    "value": "AU"
                },
                {
                    "label": "Aruba",
                    "value": "AW"
                },
                {
                    "label": "Åland Islands",
                    "value": "AX"
                },
                {
                    "label": "Azerbaijan",
                    "value": "AZ"
                },
                {
                    "label": "Bosnia and Herzegovina",
                    "value": "BA"
                },
                {
                    "label": "Barbados",
                    "value": "BB"
                },
                {
                    "label": "Bangladesh",
                    "value": "BD"
                },
                {
                    "label": "Belgium",
                    "value": "BE"
                },
                {
                    "label": "Burkina Faso",
                    "value": "BF"
                },
                {
                    "label": "Bulgaria",
                    "value": "BG"
                },
                {
                    "label": "Bahrain",
                    "value": "BH"
                },
                {
                    "label": "Burundi",
                    "value": "BI"
                },
                {
                    "label": "Benin",
                    "value": "BJ"
                },
                {
                    "label": "Bermuda",
                    "value": "BM"
                },
                {
                    "label": "Brunei Darussalam",
                    "value": "BN"
                },
                {
                    "label": "Bolivia",
                    "value": "BO"
                },
                {
                    "label": "Brazil",
                    "value": "BR"
                },
                {
                    "label": "Bahamas",
                    "value": "BS"
                },
                {
                    "label": "Bhutan",
                    "value": "BT"
                },
                {
                    "label": "Bouvet Island",
                    "value": "BV"
                },
                {
                    "label": "Botswana",
                    "value": "BW"
                },
                {
                    "label": "Belarus",
                    "value": "BY"
                },
                {
                    "label": "Belize",
                    "value": "BZ"
                },
                {
                    "label": "Canada",
                    "value": "CA"
                },
                {
                    "label": "Cocos (Keeling) Islands",
                    "value": "CC"
                },
                {
                    "label": "Congo, The Democratic Republic of the",
                    "value": "CD"
                },
                {
                    "label": "Switzerland",
                    "value": "CH"
                },
                {
                    "label": "Cote D'Ivoire",
                    "value": "CI"
                },
                {
                    "label": "Cook Islands",
                    "value": "CK"
                },
                {
                    "label": "Chile",
                    "value": "CL"
                },
                {
                    "label": "Cameroon",
                    "value": "CM"
                },
                {
                    "label": "China",
                    "value": "CN"
                },
                {
                    "label": "Colombia",
                    "value": "CO"
                },
                {
                    "label": "Costa Rica",
                    "value": "CR"
                },
                {
                    "label": "Cuba",
                    "value": "CU"
                },
                {
                    "label": "Cape Verde",
                    "value": "CV"
                },
                {
                    "label": "Christmas Island",
                    "value": "CX"
                },
                {
                    "label": "Cyprus",
                    "value": "CY"
                },
                {
                    "label": "Czech Republic",
                    "value": "CZ"
                },
                {
                    "label": "Germany",
                    "value": "DE"
                },
                {
                    "label": "Djibouti",
                    "value": "DJ"
                },
                {
                    "label": "Denmark",
                    "value": "DK"
                },
                {
                    "label": "Dominica",
                    "value": "DM"
                },
                {
                    "label": "Dominican Republic",
                    "value": "DO"
                },
                {
                    "label": "Algeria",
                    "value": "DZ"
                },
                {
                    "label": "Ecuador",
                    "value": "EC"
                },
                {
                    "label": "Estonia",
                    "value": "EE"
                },
                {
                    "label": "Egypt",
                    "value": "EG"
                },
                {
                    "label": "Western Sahara",
                    "value": "EH"
                },
                {
                    "label": "Eritrea",
                    "value": "ER"
                },
                {
                    "label": "Spain",
                    "value": "ES"
                },
                {
                    "label": "Ethiopia",
                    "value": "ET"
                },
                {
                    "label": "Finland",
                    "value": "FI"
                },
                {
                    "label": "Fiji",
                    "value": "FJ"
                },
                {
                    "label": "Falkland Islands (Malvinas)",
                    "value": "FK"
                },
                {
                    "label": "Micronesia, Federated States of",
                    "value": "FM"
                },
                {
                    "label": "Faroe Islands",
                    "value": "FO"
                },
                {
                    "label": "France",
                    "value": "FR"
                },
                {
                    "label": "Gabon",
                    "value": "GA"
                },
                {
                    "label": "United Kingdom",
                    "value": "GB"
                },
                {
                    "label": "Grenada",
                    "value": "GD"
                },
                {
                    "label": "Georgia",
                    "value": "GE"
                },
                {
                    "label": "French Guiana",
                    "value": "GF"
                },
                {
                    "label": "Guernsey",
                    "value": "GG"
                },
                {
                    "label": "Ghana",
                    "value": "GH"
                },
                {
                    "label": "Gibraltar",
                    "value": "GI"
                },
                {
                    "label": "Greenland",
                    "value": "GL"
                },
                {
                    "label": "Gambia",
                    "value": "GM"
                },
                {
                    "label": "Guinea",
                    "value": "GN"
                },
                {
                    "label": "Guadeloupe",
                    "value": "GP"
                },
                {
                    "label": "Greece",
                    "value": "GR"
                },
                {
                    "label": "South Georgia and the South Sandwich Islands",
                    "value": "GS"
                },
                {
                    "label": "Guatemala",
                    "value": "GT"
                },
                {
                    "label": "Guam",
                    "value": "GU"
                },
                {
                    "label": "Guinea-Bissau",
                    "value": "GW"
                },
                {
                    "label": "Guyana",
                    "value": "GY"
                },
                {
                    "label": "Hong Kong",
                    "value": "HK"
                },
                {
                    "label": "Heard Island and Mcdonald Islands",
                    "value": "HM"
                },
                {
                    "label": "Honduras",
                    "value": "HN"
                },
                {
                    "label": "Croatia",
                    "value": "HR"
                },
                {
                    "label": "Haiti",
                    "value": "HT"
                },
                {
                    "label": "Hungary",
                    "value": "HU"
                },
                {
                    "label": "Indonesia",
                    "value": "ID"
                },
                {
                    "label": "Ireland",
                    "value": "IE"
                },
                {
                    "label": "Israel",
                    "value": "IL"
                },
                {
                    "label": "Isle of Man",
                    "value": "IM"
                },
                {
                    "label": "India",
                    "value": "IN"
                },
                {
                    "label": "British Indian Ocean Territory",
                    "value": "IO"
                },
                {
                    "label": "Iraq",
                    "value": "IQ"
                },
                {
                    "label": "Iran",
                    "value": "IR"
                },
                {
                    "label": "Iceland",
                    "value": "IS"
                },
                {
                    "label": "Italy",
                    "value": "IT"
                },
                {
                    "label": "Jersey",
                    "value": "JE"
                },
                {
                    "label": "Jamaica",
                    "value": "JM"
                },
                {
                    "label": "Jordan",
                    "value": "JO"
                },
                {
                    "label": "Japan",
                    "value": "JP"
                },
                {
                    "label": "Kenya",
                    "value": "KE"
                },
                {
                    "label": "Kyrgyzstan",
                    "value": "KG"
                },
                {
                    "label": "Cambodia",
                    "value": "KH"
                },
                {
                    "label": "Kiribati",
                    "value": "KI"
                },
                {
                    "label": "Comoros",
                    "value": "KM"
                },
                {
                    "label": "Saint Kitts and Nevis",
                    "value": "KN"
                },
                {
                    "label": "South Korea",
                    "value": "KR"
                },
                {
                    "label": "Kuwait",
                    "value": "KW"
                },
                {
                    "label": "Cayman Islands",
                    "value": "KY"
                },
                {
                    "label": "Kazakhstan",
                    "value": "KZ"
                },
                {
                    "label": "Laos",
                    "value": "LA"
                },
                {
                    "label": "Lebanon",
                    "value": "LB"
                },
                {
                    "label": "Saint Lucia",
                    "value": "LC"
                },
                {
                    "label": "Liechtenstein",
                    "value": "LI"
                },
                {
                    "label": "Sri Lanka",
                    "value": "LK"
                },
                {
                    "label": "Liberia",
                    "value": "LR"
                },
                {
                    "label": "Lesotho",
                    "value": "LS"
                },
                {
                    "label": "Lithuania",
                    "value": "LT"
                },
                {
                    "label": "Luxembourg",
                    "value": "LU"
                },
                {
                    "label": "Latvia",
                    "value": "LV"
                },
                {
                    "label": "Libya",
                    "value": "LY"
                },
                {
                    "label": "Morocco",
                    "value": "MA"
                },
                {
                    "label": "Monaco",
                    "value": "MC"
                },
                {
                    "label": "Moldova, Republic of",
                    "value": "MD"
                },
                {
                    "label": "Montenegro",
                    "value": "ME"
                },
                {
                    "label": "Madagascar",
                    "value": "MG"
                },
                {
                    "label": "Marshall Islands",
                    "value": "MH"
                },
                {
                    "label": "North Macedonia",
                    "value": "MK"
                },
                {
                    "label": "Mali",
                    "value": "ML"
                },
                {
                    "label": "Myanmar",
                    "value": "MM"
                },
                {
                    "label": "Mongolia",
                    "value": "MN"
                },
                {
                    "label": "Macao",
                    "value": "MO"
                },
                {
                    "label": "Northern Mariana Islands",
                    "value": "MP"
                },
                {
                    "label": "Martinique",
                    "value": "MQ"
                },
                {
                    "label": "Mauritania",
                    "value": "MR"
                },
                {
                    "label": "Montserrat",
                    "value": "MS"
                },
                {
                    "label": "Malta",
                    "value": "MT"
                },
                {
                    "label": "Mauritius",
                    "value": "MU"
                },
                {
                    "label": "Maldives",
                    "value": "MV"
                },
                {
                    "label": "Malawi",
                    "value": "MW"
                },
                {
                    "label": "Mexico",
                    "value": "MX"
                },
                {
                    "label": "Malaysia",
                    "value": "MY"
                },
                {
                    "label": "Mozambique",
                    "value": "MZ"
                },
                {
                    "label": "Namibia",
                    "value": "NA"
                },
                {
                    "label": "New Caledonia",
                    "value": "NC"
                },
                {
                    "label": "Niger",
                    "value": "NE"
                },
                {
                    "label": "Norfolk Island",
                    "value": "NF"
                },
                {
                    "label": "Nigeria",
                    "value": "NG"
                },
                {
                    "label": "Nicaragua",
                    "value": "NI"
                },
                {
                    "label": "Netherlands",
                    "value": "NL"
                },
                {
                    "label": "Norway",
                    "value": "NO"
                },
                {
                    "label": "Nepal",
                    "value": "NP"
                },
                {
                    "label": "Nauru",
                    "value": "NR"
                },
                {
                    "label": "Niue",
                    "value": "NU"
                },
                {
                    "label": "New Zealand",
                    "value": "NZ"
                },
                {
                    "label": "Oman",
                    "value": "OM"
                },
                {
                    "label": "Panama",
                    "value": "PA"
                },
                {
                    "label": "Peru",
                    "value": "PE"
                },
                {
                    "label": "French Polynesia",
                    "value": "PF"
                },
                {
                    "label": "Philippines",
                    "value": "PH"
                },
                {
                    "label": "Pakistan",
                    "value": "PK"
                },
                {
                    "label": "Poland",
                    "value": "PL"
                },
                {
                    "label": "Saint Pierre and Miquelon",
                    "value": "PM"
                },
                {
                    "label": "Pitcairn",
                    "value": "PN"
                },
                {
                    "label": "Puerto Rico",
                    "value": "PR"
                },
                {
                    "label": "Portugal",
                    "value": "PT"
                },
                {
                    "label": "Palau",
                    "value": "PW"
                },
                {
                    "label": "Paraguay",
                    "value": "PY"
                },
                {
                    "label": "Qatar",
                    "value": "QA"
                },
                {
                    "label": "Reunion",
                    "value": "RE"
                },
                {
                    "label": "Romania",
                    "value": "RO"
                },
                {
                    "label": "Serbia",
                    "value": "RS"
                },
                {
                    "label": "Russia",
                    "value": "RU"
                },
                {
                    "label": "Rwanda",
                    "value": "RW"
                },
                {
                    "label": "Saudi Arabia",
                    "value": "SA"
                },
                {
                    "label": "Solomon Islands",
                    "value": "SB"
                },
                {
                    "label": "Seychelles",
                    "value": "SC"
                },
                {
                    "label": "Sweden",
                    "value": "SE"
                },
                {
                    "label": "Singapore",
                    "value": "SG"
                },
                {
                    "label": "Saint Helena",
                    "value": "SH"
                },
                {
                    "label": "Slovenia",
                    "value": "SI"
                },
                {
                    "label": "Svalbard and Jan Mayen",
                    "value": "SJ"
                },
                {
                    "label": "Slovakia",
                    "value": "SK"
                },
                {
                    "label": "Sierra Leone",
                    "value": "SL"
                },
                {
                    "label": "San Marino",
                    "value": "SM"
                },
                {
                    "label": "Senegal",
                    "value": "SN"
                },
                {
                    "label": "Suriname",
                    "value": "SR"
                },
                {
                    "label": "Sao Tome and Principe",
                    "value": "ST"
                },
                {
                    "label": "El Salvador",
                    "value": "SV"
                },
                {
                    "label": "Syria",
                    "value": "SY"
                },
                {
                    "label": "Swaziland",
                    "value": "SZ"
                },
                {
                    "label": "Turks and Caicos Islands",
                    "value": "TC"
                },
                {
                    "label": "Chad",
                    "value": "TD"
                },
                {
                    "label": "French Southern Territories",
                    "value": "TF"
                },
                {
                    "label": "Togo",
                    "value": "TG"
                },
                {
                    "label": "Thailand",
                    "value": "TH"
                },
                {
                    "label": "Tajikistan",
                    "value": "TJ"
                },
                {
                    "label": "Tokelau",
                    "value": "TK"
                },
                {
                    "label": "Timor-Leste",
                    "value": "TL"
                },
                {
                    "label": "Turkmenistan",
                    "value": "TM"
                },
                {
                    "label": "Tunisia",
                    "value": "TN"
                },
                {
                    "label": "Tonga",
                    "value": "TO"
                },
                {
                    "label": "Turkey",
                    "value": "TR"
                },
                {
                    "label": "Trinidad and Tobago",
                    "value": "TT"
                },
                {
                    "label": "Tuvalu",
                    "value": "TV"
                },
                {
                    "label": "Taiwan",
                    "value": "TW"
                },
                {
                    "label": "Tanzania, United Republic of",
                    "value": "TZ"
                },
                {
                    "label": "Ukraine",
                    "value": "UA"
                },
                {
                    "label": "Uganda",
                    "value": "UG"
                },
                {
                    "label": "United States",
                    "value": "US"
                },
                {
                    "label": "Uruguay",
                    "value": "UY"
                },
                {
                    "label": "Uzbekistan",
                    "value": "UZ"
                },
                {
                    "label": "Holy See (Vatican City State)",
                    "value": "VA"
                },
                {
                    "label": "Saint Vincent and the Grenadines",
                    "value": "VC"
                },
                {
                    "label": "Venezuela",
                    "value": "VE"
                },
                {
                    "label": "Virgin Islands, British",
                    "value": "VG"
                },
                {
                    "label": "Virgin Islands, U.S.",
                    "value": "VI"
                },
                {
                    "label": "Viet Nam",
                    "value": "VN"
                },
                {
                    "label": "Vanuatu",
                    "value": "VU"
                },
                {
                    "label": "Wallis and Futuna",
                    "value": "WF"
                },
                {
                    "label": "Samoa",
                    "value": "WS"
                },
                {
                    "label": "Kosovo",
                    "value": "XK"
                },
                {
                    "label": "Yemen",
                    "value": "YE"
                },
                {
                    "label": "Mayotte",
                    "value": "YT"
                },
                {
                    "label": "South Africa",
                    "value": "ZA"
                },
                {
                    "label": "Zambia",
                    "value": "ZM"
                },
                {
                    "label": "Zimbabwe",
                    "value": "ZW"
                },
                {
                    "label": "Somalia",
                    "value": "SO"
                },
                {
                    "label": "Central African Republic",
                    "value": "CF"
                },
                {
                    "label": "North Korea",
                    "value": "KP"
                },
                {
                    "label": "Papua New Guinea",
                    "value": "PG"
                },
                {
                    "label": "Republic of the Congo",
                    "value": "CG"
                },
                {
                    "label": "Sudan",
                    "value": "SD"
                },
                {
                    "label": "South Sudan",
                    "value": "SS"
                }
            ]
        },
        {
            "label": "State",
            "type": "text",
            "required": true,
            "key": "province_state",
            "validations": [
                {
                    "type": "MIN_LENGTH",
                    "value": "1"
                },
                {
                    "type": "MAX_LENGTH",
                    "value": "35"
                }
            ],
            "values_allowed": []
        },
        {
            "label": "Postal Code",
            "type": "text",
            "required": true,
            "key": "postal",
            "validations": [],
            "values_allowed": []
        },
        {
            "label": "SWIFT BIC Code",
            "type": "text",
            "required": true,
            "key": "swift_bic",
            "validations": [
                {
                    "type": "MIN_LENGTH",
                    "value": "8"
                },
                {
                    "type": "MAX_LENGTH",
                    "value": "11"
                },
                {
                    "type": "REGEX",
                    "value": "^[A-Z]{6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3})?$"
                }
            ],
            "values_allowed": []
        },
        {
            "label": "IBAN",
            "type": "text",
            "required": true,
            "key": "iban",
            "validations": [
                {
                    "type": "REGEX",
                    "value": "^[^\\s-]+$"
                }
            ],
            "values_allowed": []
        }
    ]
}

Add worker bank account request example:

curl --location 'https://api.letsdeel.com/rest/v2/eor/workers/banks' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{PUBLIC_API_TOKEN}}' \
--data '{
    "data": [
        {
            "key": "payment_type",
            "value": "bank_transfer"
        },
        {
            "key": "city",
            "value": "Paris"
        },
        {
            "key": "country_code",
            "value": "FR"
        },
        {
            "key": "bank_country_code",
            "value": "FR"
        },
        {
            "key": "currency_code",
            "value": "EUR"
        },
        {
            "key": "address_line1",
            "value": "61 Rue de Dantzig"
        },
        {
            "key": "full_name",
            "value": "John Snow"
        },
        {
            "key": "swift_bic",
            "value": "BDFEFRPPXXX"
        },
        {
            "key": "iban",
            "value": "FR1420041010050500013M02606"
        },
        {
            "key": "province_state",
            "value": "Paris"
        },
        {
            "key": "postal",
            "value": "75001"
        }
    ]
}'

Add worker bank account response example:

{
    "data": {
        "id": "4dea2827-84b5-471b-a519-c1f102882f2b",
        "status": "APPROVED",
        "created_at": "2025-05-29T15:41:13.762Z",
        "updated_at": "2025-05-29T15:41:13.762Z"
    }
}

Note: There are no changes to the endpoint used for adding a bank account.

v2.1.93

🚀 New Endpoint: Fetch Start Date for EOR Contracts

Added: API to Fetch Start Date for EOR Contracts

Returns the earliest allowed start date for a new EOR contract quote based on employment parameters.

Endpoint: Fetch Start Date for EOR Contracts

🔐 Authorization

  • Scopes required: contracts:read
  • Allowed token types: OAUTH2:ORGANIZATION PAT:ORGANIZATION

v2.1.92

AML API for Whitelabel - Data retrieval

Added: API to Get the latest screening for an entity.

Retrieves the latests AML screening result of a given entity.

Endpoint: AML API for Whitelabel - Data retrieval

🔐 Authorization

  • Scopes required: screenings:read
  • Allowed token types: OAUTH2:ORGANIZATION PAT:ORGANIZATION

v2.1.90

🚀 New Endpoint: Download Compliance Document

We’ve added a new endpoint to make it easier for you to retrieve submitted compliance documents for EOR workers.

📘 Endpoint

GET /rest/v2/eor/workers/compliance-documents/:document_id/download
API Reference

🔐 Authorization

  • Scopes required: worker:read
  • Allowed token types: OAUTH2:PERSONAL

📄 Description

Retrieves a secure, temporary download link for an employee's submitted compliance document.

📥 Path Parameters

NameTypeRequiredDescription
document_idstring✅Unique identifier for a compliance document in Deel

✅ Successful Response 200 OK

Returns the download link and its expiration timestamp.

{
  "data": {
    "url": "https://api-prod.letsdeel.com/contract_requirement/12345.pdf",
    "expires_at": "2020-03-31T10:58:49.780Z"
  }
}


🚀 New Endpoint Released: GET /v2/benefits/legal-entities/:legal_entity_id/paystubs/:payroll_event_id

We’ve introduced a new endpoint to enhance your integration with external benefits vendors:

📌 Endpoint

GET /v2/benefits/legal-entities/:legal_entity_id/paystubs/:payroll_event_id

📖 Description

Retrieve a specific paystub by payroll event for a legal entity that is integrated with an external benefits vendor. This endpoint simplifies access to payroll-related benefit data, enabling smoother integrations and better data accuracy.

🔐 Required Scopes

  • benefits:read

🔑 Allowed Tokens

  • OAUTH2:ORGANIZATION
  • OAUTH2:PERSONAL
  • PAT:ORGANIZATION
  • PAT:PERSONAL

📚 API Reference

For full details and request/response examples, check out the API documentation.

🛠️ Need help? Reach out via our support channels or contact your integration manager.

📘 Endpoint Update: POST /rest/v2/time_tracking/shifts

What's New

We’ve removed meta property from request and response payload, now you don't need to pass it in your request payload.

v2.1.89

📘 Endpoint Update: /rest/v2/time_offs/validate

What's New

We’ve introduced a new field in the request body to improve validation workflows for time off requests:

require_description :boolean
Indicates whether a description is required when validating a time off request. This allows client applications to explicitly check if the description field must be included before submission.

v2.1.87

Updated: POST Create Hourly Report Preset

Added a new required property worker_statement_id to the hourly report preset creation endpoint.

Endpoint: POST /rest/v2/timesheets/presets

API Reference: Create Hourly Report Preset


Updated: GET Retrieve a single contract

Added worker_statement_id property to the Get Contract by ID endpoint for use in hourly report preset creation.

Endpoint:GET /rest/v2/contracts/{contract_id}

API Reference: Retrieve a single contract