GuidesAPI ReferenceChangelog
Changelog

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.