Retrieve a required document for a case | Deel

curl https://api.letsdeel.com/rest/v2/immigration/workers/a6fb5c89-5abd-45d1-afc1-7e98d550eb71/cases/a6fb5c89-5abd-45d1-afc1-7e98d550eb71/required-document \
     -H "Authorization: Bearer <token>"

{
  "data": {
    "id": "5f5b3b3b-4b3b-4b3b-4b3b-4b3b3b3b3b3b",
    "name": "Proof of employment",
    "document": {
      "id": "5f5b3b3b-4b3b-4b3b-4b3b-4b3b3b3b3b3b",
      "name": "Compliance Document",
      "status": "IN_REVIEW",
      "expiration_date": "2023-10-31"
    },
    "created_at": "2023-10-31T13:45:30Z",
    "updated_at": "2023-10-31T13:45:30Z",
    "description": "Please provide proof of your eligibility to work in Canada.",
    "previous_rejected_document": {
      "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"
    },
    "immigration_document_requirement_id": "5f5b3b3b-4b3b-4b3b-4b3b-4b3b3b3b3b3b"
  }
}

Use this endpoint to retrieve the details of a specific document requirement for a worker’s case. This includes the requirement’s status and information about any previously rejected documents 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.

case_idstringRequired

The unique identifier of the case for which the required document is being requested.

Response

Successful operation.

dataobject

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error

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