Retrieve onboarding right-to-work case for a worker | Deel

import requests
url = "https://api.letsdeel.com/rest/v2/immigration/workers/a6fb5c89-5abd-45d1-afc1-7e98d550eb71/onboarding-case"
querystring = {"contract_id":"359pr8y"}
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers, params=querystring)
print(response.json())

{
  "data": {
    "id": "5f5b3b3b-4b3b-4b3b-4b3b-4b3b3b3b3b3b",
    "status": "OPEN",
    "process": {
      "id": "5f5b3b3b-4b3b-4b3b-4b3b-4b3b3b3b3b3b",
      "name": "WORK_AUTHORIZATION_VERIFICATION",
      "status": "IN_REVIEW",
      "rejection_note": "We couldn't accept the document because the file or photo that has been submitted cannot be read fully.",
      "rejection_reason": "Poor image quality"
    },
    "contract": {
      "id": "359pr8y"
    },
    "applicant": {
      "id": "5f5b3b3b-4b3b-4b3b-4b3b-4b3b3b3b3b3b",
      "external_id": "123456"
    },
    "case_type": "IMMIGRATION_DOCUMENT_REVIEW",
    "documents": [
      {
        "id": "5f5b3b3b-4b3b-4b3b-4b3b-4b3b3b3b3b3b",
        "status": "EXPIRING",
        "document_type": "Eu blue card",
        "expiration_date": "2023-10-31T13:45:30Z"
      }
    ],
    "visa_type": "Eu blue card",
    "created_at": "2023-10-31T13:45:30Z",
    "updated_at": "2023-10-31T13:45:30Z",
    "country_code": "DE",
    "estimated_completion_date": "2023-10-31T13:45:30Z"
  }
}

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. Token scopes: worker:read

Authentication

AuthorizationBearer

Authentication

The Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.

1 curl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \
2   -H 'Authorization: Bearer YOUR-TOKEN-HERE'

Learn more about authentication

## Authentication The Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail. ```curl curl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \ -H 'Authorization: Bearer YOUR-TOKEN-HERE' ``` [Learn more about authentication](/api/authentication)

AuthorizationBearer

Standard OAuth2 security scheme based on https://swagger.io/docs/specification/authentication/

Path parameters

worker_idstringRequired

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

Query parameters

contract_idstringOptional

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.

dataobject or null

1	curl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \
2	-H 'Authorization: Bearer YOUR-TOKEN-HERE'

Authentication

Authentication

Path parameters

Query parameters

Response

Errors

Authentication