Immigration

Retrieve onboarding right-to-work case for a worker

Returns the right-to-work onboarding case for a worker, including any associated documents; returns an empty response if no open case exists. When a worker is associated with multiple contracts, supply contract_id to target a specific contract.

Token scopes: worker:read

get/immigration/workers/{worker_id}/onboarding-case

Request

  • Base URL: https://api.letsdeel.com/rest
  • URL: https://api.letsdeel.com/rest/immigration/workers/{worker_id}/onboarding-case
  • Auth: HTTP bearer

Path parameters

worker_idstring required

The hris profile oid (public id) of the worker.

Query parameters

contract_idstring

Filters the worker's onboarding case to a specific contract. If the worker has multiple contracts and this parameter is omitted, the response may return a case from any associated contract; the response includes contract.id to indicate which contract was used. Provide this parameter for deterministic results.

Response

Successful operation.

Changes

No recorded changes to this operation across all 1 revision of this API.