Variables

Request Variables

Variable
Type
Description

id

number

Unique identifier for the visa application

created_at

number

Application creation timestamp (Unix milliseconds)

destination

string

ISO country code of destination country

residency

string

Country where applicant currently resides

nationality

string

Applicant's nationality/citizenship

location

string

Applicant's current location

departure_date

string

Planned departure date

return_date

string

Planned return date

number_of_entries

string

Requested entry type (e.g., "Single", "Multiple")

requested_activity

string

Purpose/nature of the visit


Response Variables

Result Object

Variable
Type
Description

visa_required

boolean

Whether a visa is mandatory for this trip

notes

string

Summary assessment of visa requirements

visa_research_status

string

Research completion status ("Ok" or "Additional research required")

categorized_visit_purposes

array

Classified/tagged reasons for travel

entry_options

array

Available visa options for this trip

Entry Options Array

Variable
Type
Description

max_stay_valid

boolean

Whether trip duration fits within visa's maximum stay limit

processing_time_valid

boolean

Whether there's sufficient time for processing before departure

entry_option_priority

string

Priority level of this visa option ("main", "alternative", etc.)

issues

array

List of identified problems or concerns with this option

entry_option_score

number

Numerical rating/suitability score for this visa option

Entry Option Details

Variable
Type
Description

id

number

Unique identifier for this specific visa type

visa_title

string

Official name of the visa category

business_activities

string

Description of permitted business activities

visa_type

string

Application method ("Paper", "Electronic", "Visa On Arrival", "ETA/ESTA")

visa_validity_code

string

Internal code representing validity period

visa_validity

string

Human-readable visa validity duration

visa_validity_days

number

Visa validity period in days

max_length_of_stay_days

number

Maximum permitted stay duration (days)

max_length_of_stay

string

Human-readable maximum stay duration

application_fee_value

number

Numerical fee amount

application_fee_currency

string

Currency code for the fee

application_fee

string

Formatted fee amount with currency

procesing_time_days

number

Expected processing time in days

processing_time

string

Human-readable processing duration

destination

string

Destination country code


Usage Notes

  • All date fields should be in ISO 8601 format

  • Country codes should follow ISO 3166-1 alpha-2 standard

  • Currency codes should follow ISO 4217 standard

  • Processing times and validity periods are estimates and may vary

  • The entry_options array is sorted by entry_option_priority and entry_option_score

Last updated