Deel Subpackage Immigration API
The subpackage_immigration API from Deel — 10 operation(s) for subpackage_immigration.
Deel Subpackage Immigration API is one of 128 APIs that Deel publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.
The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and an AsyncAPI specification.
This API exposes 11 operations across 10 paths, and defines 114 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.
Requests are made against 2 base URLs: https://api.letsdeel.com/rest/v2, https://api-staging.letsdeel.com/rest/v2.
11 operations
10 paths
114 schemas
9 GET2 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
Deel Subpackage Immigration API declares
2 security schemes
for authenticating requests.
It accepts HTTP bearer tokens (deelToken).
It accepts HTTP bearer tokens (oauth2).
deelToken— Authentication The Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authenticatio…oauth2— Standard OAuth2 security scheme based on https://swagger.io/docs/specification/authentication/
Paths & Operations 11
Across 10 paths, the API surfaces 11 operations — 9 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.
subpackage_immigration 11
GET
/immigration/visa-requirement/business
Get business visa eligibility and requirements
GET
/immigration/client/cases/{id}
Get immigration case details
GET
/immigration/workers/cases/{case_id}
Get specific immigration case details
GET
/immigration/documents/{id}
Immigration document
GET
/immigration/visa-types/{country_code}
Immigration visa types
GET
/immigration/client/cases
List of immigration cases
POST
/immigration/client/cases
Create an immigration case
GET
/immigration/workers/cases
List of immigration cases for workers
GET
/immigration/workers/{worker_id}/cases/{case_id}/required-document
Retrieve a required document for a case
GET
/immigration/workers/{worker_id}/onboarding-case
Retrieve onboarding right-to-work case for a worker
POST
/immigration/workers/{worker_id}/cases/{case_id}/required-document/{document_request_id}
Upload a required immigration document
Schemas 114
The contract defines 114 schemas that model the data the API accepts and returns. The most detailed are ImmigrationWorkersWorkerIdOnboardingCaseGetResponsesContentApplicationJsonSchemaData (12 properties), ImmigrationWorkersCasesCaseIdGetResponsesContentApplicationJsonSchemaData (12 properties), ImmigrationClientCasesIdGetResponsesContentApplicationJsonSchemaData (11 properties), ImmigrationClientCasesPostRequestBodyContentApplicationJsonSchemaData5 (8 properties). Each schema is shown below with its type and property counts.
ImmigrationClientCasesPostRequestBodyContentApplicationJsonSchemaDataOneOf3CaseType
string
The type of immigration case to be created. Determines the workflow and requirements
ImmigrationClientCasesPostRequestBodyContentApplicationJsonSchemaDataOneOf5EmployeeDetails
object
Employee information. Citizenships and residence attributes are always required for business visa cases. The remaining fields are only required when no contrac…
5 properties
2 required
ImmigrationClientCasesPostRequestBodyContentApplicationJsonSchemaData
ImmigrationVisaRequirementBusinessGetResponsesContentApplicationJsonSchemaData
object
7 properties
7 required
ImmigrationClientCasesGetResponsesContentApplicationJsonSchemaDataItems
object
8 properties
8 required
ImmigrationClientCasesIdGetResponsesContentApplicationJsonSchemaDataProcess
object
3 properties
ImmigrationVisaTypesCountryCodeGetResponsesContentApplicationJsonSchemaDataItems
object
2 properties
ImmigrationClientCasesGetResponsesContentApplicationJsonSchemaDataItemsApplicant
object
Applicant associated with the immigration case.
2 properties
1 required
ImmigrationWorkersCasesGetResponsesContentApplicationJsonSchemaErrorsItems
object
2 properties
ImmigrationClientCasesIdGetResponsesContentApplicationJsonSchemaDataStatus
string
Status of the immigration case.
Immigration_createAnImmigrationCase_Response_201
object
1 property
1 required
ImmigrationClientCasesPostRequestBodyContentApplicationJsonSchemaData2
object
5 properties
4 required
ImmigrationClientCasesPostResponsesContentApplicationJsonSchemaDataProcess
object
Details about the current immigration process associated with the case
3 properties
3 required
immigration_getBusinessVisaRequirement_Response_200
object
1 property
1 required
GetSpecificImmigrationCaseDetails-v2026-04-02RequestBadRequestError
object
1 property
ImmigrationVisaRequirementBusinessGetResponsesContentApplicationJsonSchemaDataEstimatedTimeline
string
Estimated processing timeline, in weeks, months or years
ImmigrationClientCasesIdGetResponsesContentApplicationJsonSchemaData
object
11 properties
ImmigrationWorkersCasesCaseIdGetResponsesContentApplicationJsonSchemaData
object
12 properties
ImmigrationWorkersCasesCaseIdGetResponsesContentApplicationJsonSchemaDataApplicant
object
The employee for which this Right to Work case has been created for
2 properties
ImmigrationClientCasesPostRequestBodyContentApplicationJsonSchemaData4
object
5 properties
3 required
ListOfImmigrationCases-v2026-01-01RequestBadRequestError
object
1 property
immigration_getVisaTypes_Response_200
object
1 property
ImmigrationWorkersWorkerIdCasesCaseIdRequiredDocumentGetResponsesContentApplicationJsonSchemaDataPreviousRejectedDocumentStatus
string
Status of the document.
GetImmigrationCaseDetails-v2026-01-01RequestBadRequestError
object
1 property
ImmigrationDocumentsIdGetResponsesContentApplicationJsonSchemaDataItems
object
5 properties
ImmigrationWorkersCasesCaseIdGetResponsesContentApplicationJsonSchemaErrorsItems
object
2 properties
immigration_getWorkerCases_Response_200
object
4 properties
3 required
ImmigrationWorkersWorkerIdCasesCaseIdRequiredDocumentDocumentRequestIdPostResponsesContentApplicationJsonSchemaDataStatus
string
Status of the document.
ImmigrationWorkersWorkerIdOnboardingCaseGetResponsesContentApplicationJsonSchemaData
object
12 properties
ImmigrationWorkersCasesCaseIdGetResponsesContentApplicationJsonSchemaDataStatus
string
Status of the immigration case.
ImmigrationClientCasesPostRequestBodyContentApplicationJsonSchemaData5
object
8 properties
5 required
ImmigrationWorkersWorkerIdCasesCaseIdRequiredDocumentGetResponsesContentApplicationJsonSchemaDataDocument
object
4 properties
ImmigrationWorkersWorkerIdCasesCaseIdRequiredDocumentDocumentRequestIdPostResponsesContentApplicationJsonSchemaData
object
4 properties
RetrieveOnboardingRightToWorkCaseForAWorkerRequestNotFoundError
object
1 property
1 required
immigration_getWorkerCase_Response_200
object
1 property
immigration_getWorkerCaseRequiredDocument_Response_200
object
1 property
ImmigrationWorkersWorkerIdCasesCaseIdRequiredDocumentGetResponsesContentApplicationJsonSchemaDataDocumentStatus
string
Status of the document.
CreateAnImmigrationCaseRequestInternalServerError
object
1 property
ImmigrationClientCasesPostRequestBodyContentApplicationJsonSchemaDataOneOf0CaseType
string
The type of immigration case to be created. Determines the workflow and requirements
ImmigrationWorkersCasesGetResponsesContentApplicationJsonSchemaDataItemsClosure
object
Closure details of the case if the case has been closed.
2 properties
2 required
ImmigrationClientCasesPostRequestBodyContentApplicationJsonSchemaDataOneOf2CaseType
string
The type of immigration case to be created. Determines the workflow and requirements
ImmigrationWorkersCasesCaseIdGetResponsesContentApplicationJsonSchemaDataDocumentsItems
object
4 properties
ImmigrationWorkersCasesGetResponsesContentApplicationJsonSchemaDataItemsCaseType
object
Type of immigration case.
2 properties
2 required
ImmigrationClientCasesPostRequestBodyContentApplicationJsonSchemaData3
object
4 properties
3 required
ImmigrationClientCasesPostRequestBodyContentApplicationJsonSchemaDataOneOf5TravelInformation
object
Travel details for the business visa
3 properties
3 required
ImmigrationDocumentsIdGetResponsesContentApplicationJsonSchemaDataItemsStatus
string
Current status of the document.
immigration_getClientCases_Response_200
object
4 properties
3 required
ImmigrationClientCasesPostRequestBodyContentApplicationJsonSchemaDataOneOf1CaseType
string
The type of immigration case to be created. Determines the workflow and requirements
ImmigrationWorkersCasesGetResponsesContentApplicationJsonSchemaDataItemsProcess
object
Current active process associated with the case.
3 properties
3 required
ImmigrationClientCasesIdGetResponsesContentApplicationJsonSchemaDataDocumentsItemsStatus
string
Status of the document.
ImmigrationWorkersCasesCaseIdGetResponsesContentApplicationJsonSchemaDataProcessStatus
string
Status of the current active process.
ImmigrationWorkersCasesGetResponsesContentApplicationJsonSchemaDataItemsStatus
string
Current lifecycle status of the immigration case.
GetBusinessVisaEligibilityAndRequirementsRequestBadRequestError
object
1 property
ImmigrationWorkersCasesGetResponsesContentApplicationJsonSchemaDataItemsProcessStatus
object
Current status of the process.
2 properties
2 required
ImmigrationWorkersCasesCaseIdGetResponsesContentApplicationJsonSchemaDataProcessName
string
Name of the current active process.
ImmigrationClientCasesPostRequestBodyContentApplicationJsonSchemaData1
object
4 properties
3 required
ImmigrationClientCasesIdGetResponsesContentApplicationJsonSchemaErrorsItems
object
2 properties
ImmigrationClientCasesGetResponsesContentApplicationJsonSchemaDataItemsClosure
object
Closure details of the case if the case has been closed.
2 properties
2 required
immigration_getWorkerOnboardingCase_Response_200
object
1 property
ImmigrationClientCasesPostResponsesContentApplicationJsonSchemaErrorsItems
object
2 properties
ImmigrationWorkersCasesGetResponsesContentApplicationJsonSchemaDataItemsClosureReason
string
Reason why the immigration case was closed.
RetrieveOnboardingRightToWorkCaseForAWorkerRequestInternalServerError
object
1 property
ListOfImmigrationCasesForWorkers-v2026-04-02RequestBadRequestError
object
1 property
CreateAnImmigrationCaseRequestBadRequestError
object
1 property
ImmigrationWorkersWorkerIdOnboardingCaseGetResponsesContentApplicationJsonSchemaDataProcessStatus
string
Status of the current active process.
ImmigrationWorkersWorkerIdOnboardingCaseGetResponsesContentApplicationJsonSchemaDataProcess
object
The current active process
5 properties
ImmigrationClientCasesIdGetResponsesContentApplicationJsonSchemaDataApplicant
object
2 properties
ImmigrationWorkersCasesCaseIdGetResponsesContentApplicationJsonSchemaDataDocumentsItemsStatus
string
Status of the document.
ImmigrationClientCasesPostRequestBodyContentApplicationJsonSchemaDataOneOf5CaseType
string
The type of immigration case to be created. Determines the workflow and requirements
ImmigrationClientCasesPostResponsesContentApplicationJsonSchemaDataStatus
string
Current status of the case
RetrieveOnboardingRightToWorkCaseForAWorkerRequestBadRequestError
object
1 property
ImmigrationVisaRequirementBusinessGetResponsesContentApplicationJsonSchemaDataQualification
string
Visa qualification status, whether it is required or not. It can be also unsupported if the country does not support business visa options.
ImmigrationWorkersWorkerIdOnboardingCaseGetResponsesContentApplicationJsonSchemaDataContract
object
The contract associated with the returned immigration case
1 property
ImmigrationClientCasesGetResponsesContentApplicationJsonSchemaDataItemsCaseType
object
Type of immigration case.
2 properties
2 required
immigration_getClientCase_Response_200
object
1 property
ImmigrationClientCasesPostRequestBodyContentApplicationJsonSchemaDataOneOf4CaseType
string
The type of immigration case to be created. Determines the workflow and requirements
ImmigrationWorkersWorkerIdOnboardingCaseGetResponsesContentApplicationJsonSchemaErrorsItems
object
2 properties
GetSpecificImmigrationCaseDetails-v2026-04-02RequestInternalServerError
object
1 property
ImmigrationWorkersWorkerIdCasesCaseIdRequiredDocumentGetResponsesContentApplicationJsonSchemaDataPreviousRejectedDocument
object
4 properties
ApiErrorContainer
object
2 properties
ImmigrationClientCasesIdGetResponsesContentApplicationJsonSchemaDataDocumentsItems
object
4 properties
ApiErrorRequest
object
7 properties
ImmigrationClientCasesPostRequestBodyContentApplicationJsonSchemaDataOneOf5TravelInformationPurpose
string
The purpose of the business trip
ImmigrationVisaRequirementBusinessGetResponsesContentApplicationJsonSchemaErrorsItems
object
2 properties
ListOfImmigrationCases-v2026-01-01RequestInternalServerError
object
1 property
ImmigrationWorkersWorkerIdOnboardingCaseGetResponsesContentApplicationJsonSchemaDataDocumentsItems
object
4 properties
ImmigrationClientCasesGetParametersStatusesSchemaItems
string
ImmigrationWorkersCasesCaseIdGetResponsesContentApplicationJsonSchemaDataCaseType
string
Type of the case. It will always be IMMIGRATIONDOCUMENTREVIEW for this endpoint.
GetBusinessVisaEligibilityAndRequirementsRequestInternalServerError
object
1 property
ImmigrationClientCasesGetResponsesContentApplicationJsonSchemaErrorsItems
object
2 properties
ImmigrationWorkersCasesCaseIdGetResponsesContentApplicationJsonSchemaDataContract
object
The contract associated with the returned immigration case
1 property
ImmigrationClientCasesPostRequestBodyContentApplicationJsonSchemaData0
object
3 properties
3 required
ImmigrationWorkersWorkerIdOnboardingCaseGetResponsesContentApplicationJsonSchemaDataApplicant
object
The employee for which this Right to Work case has been created for
2 properties
ImmigrationWorkersCasesGetParametersStatusesSchemaItems
string
ImmigrationClientCasesPostResponsesContentApplicationJsonSchemaData
object
The immigration case data returned after successful creation
7 properties
5 required
GetImmigrationCaseDetails-v2026-01-01RequestInternalServerError
object
1 property
immigration_createWorkerCaseRequiredDocument_Response_201
object
1 property
ImmigrationWorkersWorkerIdOnboardingCaseGetResponsesContentApplicationJsonSchemaDataProcessName
string
Name of the current active process.
ImmigrationClientCasesGetResponsesContentApplicationJsonSchemaDataItemsProcessStatus
object
Current status of the process.
2 properties
2 required
ImmigrationWorkersCasesGetResponsesContentApplicationJsonSchemaDataItems
object
8 properties
8 required
ApiError
object
2 properties
ImmigrationWorkersCasesGetResponsesContentApplicationJsonSchemaDataItemsApplicant
object
Applicant associated with the immigration case.
2 properties
1 required
ImmigrationClientCasesGetResponsesContentApplicationJsonSchemaDataItemsStatus
string
Current lifecycle status of the immigration case.
ImmigrationWorkersWorkerIdCasesCaseIdRequiredDocumentGetResponsesContentApplicationJsonSchemaData
object
8 properties
ImmigrationWorkersWorkerIdCasesCaseIdRequiredDocumentDocumentRequestIdPostRequestBodyContentMultipartFormDataSchemaData
object
Details of immigration document upload
1 property
1 required
immigration_getDocument_Response_200
object
1 property
ImmigrationWorkersWorkerIdOnboardingCaseGetResponsesContentApplicationJsonSchemaDataStatus
string
Status of the immigration case.
ImmigrationWorkersWorkerIdOnboardingCaseGetResponsesContentApplicationJsonSchemaDataCaseType
string
Type of the case. It will always be IMMIGRATIONDOCUMENTREVIEW for this endpoint.
ImmigrationClientCasesGetResponsesContentApplicationJsonSchemaDataItemsClosureReason
string
Reason why the immigration case was closed.
ImmigrationClientCasesGetResponsesContentApplicationJsonSchemaDataItemsProcess
object
Current active process associated with the case.
3 properties
3 required
ImmigrationWorkersWorkerIdOnboardingCaseGetResponsesContentApplicationJsonSchemaDataDocumentsItemsStatus
string
Status of the document.
ImmigrationWorkersCasesCaseIdGetResponsesContentApplicationJsonSchemaDataProcess
object
The current active process
5 properties
ImmigrationVisaRequirementBusinessGetParametersTripReason
string
ListOfImmigrationCasesForWorkers-v2026-04-02RequestInternalServerError
object
1 property
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Deel 12
Other APIs Deel publishes across the network.
Deel Adjustments API
Deel Applications API
Deel Candidates API
Deel Contractor Amendments API
Deel Contractor Hiring API
Deel Contracts API
Deel Custom Fields API
Deel IT API
Deel EOR Amendments API
Deel EOR Benefits API
Deel EOR Cost Calculator API
Deel EOR Hiring API
Where this information came from
This is an independent, third-party profile of Deel Subpackage Immigration API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.