Skip to content

Deel: Retrieve the legacy onboarding right-to-work case for a worker

Deel immigration.getWorkerOnboardingCase: arguments, response, policy and SDK examples.

← Immigration operations · Get started

Operation deel.immigration_getworkeronboardingcase

Provider route: GET /immigration/workers/{worker_id}/onboarding-case. Alter supplies the connection’s credentials and routing.

Install @alter-ai/sdk @alter-ai/deel with npm, or alter-sdk-deel with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { DeelIntegration } from "@alter-ai/deel";
async function execute(input: Parameters<DeelIntegration["immigration"]["getWorkerOnboardingCase"]>[0]) {
const app = new App({ apiKey: process.env.ALTER_API_KEY! });
try {
const provider = new DeelIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
const call = await provider.immigration.getWorkerOnboardingCase(input);
const result = await call.wait();
return result.bodyJson();
} finally {
await app.close();
}
}
import os
from alter_sdk import App
from alter_sdk_deel import DeelIntegration
async def execute(arguments):
async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
provider = DeelIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
call = await provider.immigration.get_worker_onboarding_case(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.worker_idstringRequired within parent
queryobjectOptionalAdditional keys: not allowed
query.contract_idstringOptional

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand Retrieve the legacy onboarding right-to-work case for a worker — 200 response body

Referenced models: Retrieve the legacy onboarding right-to-work case for a worker — 200 response body

Retrieve the legacy onboarding right-to-work case for a worker — 200 response body
FieldTypePresenceDescription and constraints
$objectRoot
dataModelOptionalExpand Retrieve the legacy onboarding right-to-work case for a worker — 200 response body — data

Referenced models: Retrieve the legacy onboarding right-to-work case for a worker — 200 response body — data

Retrieve the legacy onboarding right-to-work case for a worker — 200 response body — data
FieldTypePresenceDescription and constraints
$objectRoot
applicantJSONOptionalThe employee for which this Right to Work case has been created for
applicant (anyOf 1)ModelAlternativeExpand Get specific immigration case details — 200 response body — data applicant external id, id
applicant (anyOf 2)nullAlternative
case_typestringOptionalType of the case. It will always be IMMIGRATION_DOCUMENT_REVIEW for this endpoint.
Known values: IMMIGRATION_DOCUMENT_REVIEW
contractModelOptionalExpand Get specific immigration case details — 200 response body — data contract
The contract associated with the returned immigration case
country_codestringOptionalThe country of the immigration case.
created_atstringOptionalCreation date of the immigration case.
Format: date-time
documentsarrayOptionalA list of documents associated to the immigration case
documents[]ModelEach itemExpand Retrieve the legacy onboarding right-to-work case for a worker — 200 response body — data documents item
estimated_completion_dateJSONOptional
estimated_completion_date (anyOf 1)stringAlternativeEstimated completion date of the immigration case.
Format: date-time
estimated_completion_date (anyOf 2)nullAlternativeEstimated completion date of the immigration case.
Format: date-time
idstringOptionalUnique identifier of immigration case.
processModelOptionalExpand Retrieve the legacy onboarding right-to-work case for a worker — 200 response body — data process
The current active process
statusstringOptionalStatus of the immigration case.
Known values: OPEN, CLOSED, ON_HOLD
updated_atstringOptionalLast activity on the immigration case.
Format: date-time
visa_typeJSONOptional
visa_type (anyOf 1)stringAlternativeThe type of the visa.
visa_type (anyOf 2)nullAlternativeThe type of the visa.

Referenced models: Get specific immigration case details — 200 response body — data applicant external id, id, Get specific immigration case details — 200 response body — data contract, Retrieve the legacy onboarding right-to-work case for a worker — 200 response body — data documents item, Retrieve the legacy onboarding right-to-work case for a worker — 200 response body — data process

Get specific immigration case details — 200 response body — data applicant external id, id
FieldTypePresenceDescription and constraints
$objectRootThe employee for which this Right to Work case has been created for
external_idJSONOptional
external_id (anyOf 1)stringAlternativeExternal identifier of the applicant (from partner system or third party).
external_id (anyOf 2)nullAlternativeExternal identifier of the applicant (from partner system or third party).
idstringOptionalUnique identifier of the applicant profile id.
Get specific immigration case details — 200 response body — data contract
FieldTypePresenceDescription and constraints
$objectRootThe contract associated with the returned immigration case
idJSONOptional
id (anyOf 1)stringAlternativeId of the contract associated with the immigration case
id (anyOf 2)nullAlternativeId of the contract associated with the immigration case
Retrieve the legacy onboarding right-to-work case for a worker — 200 response body — data documents item
FieldTypePresenceDescription and constraints
$objectRoot
document_typeJSONOptional
document_type (anyOf 1)stringAlternativeThe type of the document. Represents the visa type for right to work cases.
document_type (anyOf 2)nullAlternativeThe type of the document. Represents the visa type for right to work cases.
expiration_dateJSONOptional
expiration_date (anyOf 1)stringAlternativeExpiry date of the document. If document does not expire, it will be null
Format: date-time
expiration_date (anyOf 2)nullAlternativeExpiry date of the document. If document does not expire, it will be null
Format: date-time
idstringOptionalUnique identifier of the document.
statusstringOptionalStatus of the document.
Known values: IN_REVIEW, ACTIVE, EXPIRED, EXPIRING
Retrieve the legacy onboarding right-to-work case for a worker — 200 response body — data process
FieldTypePresenceDescription and constraints
$objectRootThe current active process
idstringOptionalUnique identifier of the current active process.
namestringOptionalName of the current active process.
Known values: WORK_AUTHORIZATION_VERIFICATION
rejection_notestringOptionalA detailed description of why the case was rejected. Only available if the case status is REJECTED.
rejection_reasonstringOptionalThe reason why the case was rejected. Only available if the case status is REJECTED.
statusstringOptionalStatus of the current active process.
Known values: CANCELLED, AWAITING_DOCUMENTS, IN_REVIEW, APPROVED, REJECTED

SDK function policy ID: deel.immigration_getworkeronboardingcase. Catalog operation: immigration_getworkeronboardingcase. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["worker:read"]

Pinned headers: {"X-Version": "2026-01-01"}

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.