Skip to navigation

Create an immigration case for a worker

Beta

Opens an eligibility check or a right to work check for a worker of your organization, so Deel starts the immigration assessment without anyone using the Deel app. Use it once the contract is no longer a draft. A business visa can also be checked for someone not on Deel yet, whom Deel invites unless your organization already has a worker with that email. Sending the same idempotency-key header again within 24 hours returns the first response instead of opening a second case.

Token scopes: immigration:write

Beta: this version requires the X-Beta: true request header and its contract may change before it is promoted to stable. It is scheduled to become stable on 2027-02-04.

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.

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

Learn more about authentication

OR
AuthorizationBearer

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

Headers

X-BetaenumRequiredDefaults to true

Opts in to the beta version of this endpoint. Must be true.

Allowed values:

Request

This endpoint expects an object.
dataobjectRequired

The case to open, chosen by work_type.

Response

The case was opened.
dataobject

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
500
Internal Server Error