Get right to work case required documents | Deel

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

{
  "data": {
    "id": "5f5b3b3b-4b3b-4b3b-4b3b-4b3b3b3b3b3b",
    "name": "Proof of employment",
    "status": "PENDING",
    "document": {
      "id": "5f5b3b3b-4b3b-4b3b-4b3b-4b3b3b3b3b3b",
      "name": "Compliance Document",
      "status": "IN_REVIEW",
      "expiry_date": "2023-10-31T13:45:30Z"
    },
    "description": "Please provide proof of your eligibility to work in Canada.",
    "previous_document_request": {
      "id": "5f5b3b3b-4b3b-4b3b-4b3b-4b3b3b3b3b3b",
      "status": "REJECTED",
      "rejection_note": "The document contains incorrect or inconsistent information, which does not match the records of requirements",
      "rejection_reason": "Inaccurate data"
    }
  }
}

Returns the required documents to be uploaded for a right to work case. 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

case_idstringOptional

The unique identifier of the right to work case for which the required documents are being requested.

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