GuidesAPI ReferenceChangelog
Changelog

πŸš€ 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

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

πŸš€ 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.

πŸ“˜ 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.

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

πŸš€ Enhancements for retrieve Benefits by Country EOR API

Updated: Retrieve Benefits by Country API

Added new response field: providers[].is_unisure

Endpoint: GET /v2/eor/benefits

API Reference: Retrieve Benefits by Country

πŸš€ Enhancements for retrieve EOR contract creation and Contract details

Added new response field: Adapted breakdown_costs response field content to better structure the employment costs as they are expected to be presented to the user.

Endpoint: GET /v2/eor/contracts/{contract_id}/detailsand POST /v2/eor

API Reference: Retrieve EOR Contract Details and Create an EOR contract

πŸš€ Enhancements for time_offs endpoints

✨ What's New

  • POST /v2/time_offs/validate
    Changed requestBody is_paid property to don't have a default value, instead it will use the default resolution logic on time-off service
  • PATCH /v2/time_offs/:time_off_id
    Added attachments to the response
  • POST /v2/time_offs
    Added attachments to the response
    Improved the description for is_paid in the request body

πŸš€ Enhancements for POST /rest/v2/immigration/client/cases

✨ What's New

  • Updated Immigration API specification to enforce stricter validation rules based on case_type.
  • Refined request and response schemas to align with the latest OpenAPI specifications.
  • No changes to actual request or response parameters β€” only added stricter validation (e.g., optional fields, enum constraints, length limits).

πŸš€ Enhancements for POST /rest/v2/eor

✨ What's New

We've introduced two new optional fields to the request payload of the POST /rest/v2/eor endpoint to provide greater flexibility and compliance with local labor regulations:
API reference

πŸ”Ή employment.sick_leave_days (optional)

  • Description: Specifies the number of sick leave days for the employee.
  • Validation: Must comply with the legal limits and regulations of the employee's country.
  • Use Case: Helps you manage employee benefits in line with regional policies.

πŸ”Ή employment.seniority_date (optional)

  • Description: Represents the original employment start date for employees who are already working with your organization (directly or via third parties).
  • Availability: Supported in select countries only.
  • Use Case: Ensures accurate tracking of employee tenure and benefits eligibility.