Get right to work case required documents

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

Deel API uses API tokens to authenticate requests. A bearer token is required to authenticate all API requests. All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. curl -X GET 'api.letsdeel.com/rest/v2/contracts' \ -H 'Authorization: Bearer YOUR-TOKEN-HERE'

## Authentication Deel API uses API tokens to authenticate requests. A bearer token is required to authenticate all API requests. All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. ``` curl -X GET 'api.letsdeel.com/rest/v2/contracts' \ -H 'Authorization: Bearer YOUR-TOKEN-HERE' ``` ### Generating Access Tokens 1. Navigate to **Apps & Perks > Developer Center**. 2. Click on the “Generate New Token” button. 3. In the popup, click “Generate Token” button to generate a new token. Your newly generated token is visible on the screen. 4. Make sure to copy and save your token once is generated. You won't be able to see it again!

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.

Authentication

Authentication

Path parameters

Query parameters

Response

Errors

Authentication