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' \
--header 'Authorization: Bearer {{PUBLIC_API_TOKEN}}'

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.