Skip to navigation
EndpointsImmigration

Get the worker onboarding case

Beta

Retrieves the newest onboarding immigration case of the worker behind the token. Use it to find the case that must be completed before the worker can start.

Token scopes: worker:read

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-10.

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:

Query parameters

contract_idstringOptional<=64 characters
Only the onboarding case of this contract.

Response

Successful response with the onboarding case, or an empty object.
dataobject
The onboarding case, or an empty object when the worker has none.

Errors

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