Upload a required immigration document | Deel

import requests
url = "https://api.letsdeel.com/rest/v2/immigration/workers/a6fb5c89-5abd-45d1-afc1-7e98d550eb71/cases/a6fb5c89-5abd-45d1-afc1-7e98d550eb71/required-document/a6fb5c89-5abd-45d1-afc1-7e98d550eb71"
payload = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data\"\r\n\r\n{\n  \"file\": \"passport.jpg\"\n}\r\n-----011000010111000001101001--\r\n"
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "multipart/form-data; boundary=---011000010111000001101001"
}
response = requests.post(url, data=payload, headers=headers)
print(response.json())

{
  "data": {
    "id": "5f5b3b3b-4b3b-4b3b-4b3b-4b3b3b3b3b3b",
    "status": "IN_REVIEW",
    "created_at": "2023-10-31T13:45:30Z",
    "updated_at": "2023-10-31T13:45:30Z"
  }
}

Upload a required immigration document for a specific case. The document will be submitted for review. Token scopes: worker:write

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.

case_idstringRequired

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

document_request_idstringRequired

The unique identifier of the document request fo which this document is being uplodaded

Request

Upload of immigration document

dataobjectRequired

Details of immigration document upload

Response

Document uploaded.

dataobject or null

Authentication

Authentication

Path parameters

Request

Response

Errors

Authentication