Skip to content

Deel: Get business visa eligibility and requirements

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

← Immigration operations · Get started

Operation deel.immigration_getbusinessvisarequirement

Provider route: GET /immigration/visa-requirement/business. 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"]["getBusinessVisaRequirement"]>[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.getBusinessVisaRequirement(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_business_visa_requirement(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
queryobjectRequired within parentAdditional keys: not allowed
query.destination_countrystringRequired within parentPattern: ^[A-Z]{2}$
query.nationalitystringRequired within parentPattern: ^[A-Z]{2}$
query.residence_countrystringRequired within parentPattern: ^[A-Z]{2}$
query.trip_start_datestringRequired within parentFormat: date
query.trip_end_datestringRequired within parentFormat: date
query.trip_reasonModelRequired within parentExpand Get business visa eligibility and requirements — request body — query trip reason
query.second_nationalitystringOptionalPattern: ^[A-Z]{2}$

Referenced models: Get business visa eligibility and requirements — request body — query trip reason

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

FieldTypePresenceDescription and constraints
$ModelRootExpand Get business visa eligibility and requirements — 200 response body

Referenced models: Get business visa eligibility and requirements — 200 response body

Get business visa eligibility and requirements — request body — query trip reason
FieldTypePresenceDescription and constraints
$stringRootOne of: INTERNAL_BUSINESS_WITH_WORK_FOR_CLIENT, INTERNAL_BUSINESS_WITHOUT_WORK_FOR_CLIENT, MEETINGS_WITH_OR_FOR_A_CLIENT, MEETINGS_WITH_POTENTIAL_CLIENTS, NEGOTIATING_CONTRACTS_OR_SIGNING_AGREEMENTS, OTHER_EXTERNAL_BUSINESS, CONFERENCE, TEAM_OFFSITE, SPEAKING_AT_CONFERENCE_UNPAID, SPEAKING_AT_CONFERENCE_PAID, ATTENDING_INTERNAL_TRAINING, ATTENDING_EXTERNAL_TRAINING, DELIVERING_TRAINING_TO_INTERNAL_PARTICIPANTS, DELIVERING_TRAINING_TO_EXTERNAL_PARTICIPANTS_UNPAID, DELIVERING_TRAINING_TO_EXTERNAL_PARTICIPANTS_PAID, PARTICIPATION_IN_RESEARCH_PROJECTS_AND_STUDIES, ASSEMBLY_MAINTENANCE_REPAIR_INSTALLATION, TECHNICAL_SUPPORT_OR_SUPERVISION, OTHER_HANDS_ON_LABOUR, MARKET_RESEARCH_AND_EXPLORING_INVESTMENT_OPPORTUNITIES, OTHER
Get business visa eligibility and requirements — 200 response body
FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Get business visa eligibility and requirements — 200 response body — data

Referenced models: Get business visa eligibility and requirements — 200 response body — data

Get business visa eligibility and requirements — 200 response body — data
FieldTypePresenceDescription and constraints
$objectRoot
descriptionstringRequired within parentDescription of the visa type
estimated_timelineJSONRequired within parentEstimated processing timeline, in weeks, months or years
estimated_timeline (anyOf 1)stringAlternativeEstimated processing timeline, in weeks, months or years
Known values: SIX_WEEKS, THREE_MONTHS, ONE_WEEK, THREE_WEEKS, ONE_YEAR, TWO_WEEKS, FIVE_WEEKS, TWO_MONTHS, FIVE_MONTHS, FOUR_MONTHS, SIX_MONTHS, FOUR_WEEKS
estimated_timeline (anyOf 2)nullAlternative
feeJSONRequired within parent
fee (anyOf 1)JSONAlternative
fee (anyOf 1) (anyOf 1)numberAlternativeFee amount
Format: double
fee (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
fee (anyOf 2)nullAlternativeFee amount
Format: double
fee_currencyJSONRequired within parent
fee_currency (anyOf 1)stringAlternativeCurrency code for the fee in ISO 4217 format
Pattern: ^[A-Z]{3}$
fee_currency (anyOf 2)nullAlternativeCurrency code for the fee in ISO 4217 format
Pattern: ^[A-Z]{3}$
nameJSONRequired within parent
name (anyOf 1)stringAlternativeName of the visa type
name (anyOf 2)nullAlternativeName of the visa type
qualificationstringRequired within parentVisa qualification status, whether it is required or not. It can be also unsupported if the country does not support business visa options.
Known values: VISA_REQUIRED, NO_VISA_REQUIRED, UNSUPPORTED
visa_type_idJSONRequired within parent
visa_type_id (anyOf 1)stringAlternativeUnique identifier of the visa type. This can be used to create a new business visa case on the create cases endpoint.
Format: uuid
visa_type_id (anyOf 2)nullAlternativeUnique identifier of the visa type. This can be used to create a new business visa case on the create cases endpoint.
Format: uuid

SDK function policy ID: deel.immigration_getbusinessvisarequirement. Catalog operation: immigration_getbusinessvisarequirement. 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: ["immigration: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.