Procedures
Notify travellers about health, medical, visa and safety requirements.
Introduction
Procedures are used to describe visa requirements, medical, health, safety or other entry requirements that are imposed by a government, an airline or an airport.
Retrieving Procedures
Check procedures for a RegionRegion - An administrative divisions, including state, provinces, territories. (E.g. Canada (CAN)).
{
"meta": {
"copyright": "Sherpa",
"version": "2.8.3"
},
"data": [
{
"id": "02efa579-ab8e-4ac0-bd4a-a1013480e00c",
"type": "PROCEDURE",
"attributes": {
"country": "CAN",
"title": "Electronic Authorization or Visa",
"description": "Business or Tourism visitors arriving by air who held a Canadian visitor visa in the past 10 years or currently hold a valid US nonimmigrant visa are eligible for an electronic travel authorization.\n\nOtherwise, a paper or embassy visa is the only type of visa available for visitors. Typically the visa is a stamp or sticker added to your passport. You must submit your application through the consulate or local visa center.\n\nVisit the government website for details.",
"more": [],
"enforcement": "MANDATORY",
"documentType": [
"ETA"
],
"documentLinks": [],
"tags": [
"international",
"land",
"air",
"sea",
"tourism",
"business"
],
"source": {
"sourceType": "GOVERNMENT",
"title": "Government of Canada",
"url": "https://www.canada.ca/en/immigration-refugees-citizenship/services/visit-canada/entry-requirements-country.html"
},
"lastUpdatedAt": "2021-10-12T14:42:00.000Z",
"createdAt": "2021-07-21T17:10:00.000Z",
"startDate": null,
"endDate": null,
"travelPurpose": [
"TOURISM",
"BUSINESS"
],
"included": [
{
"code": "BRA",
"text": "Brazil",
"type": "NATIONALITY"
},
{
"code": "BGR",
"text": "Bulgaria",
"type": "NATIONALITY"
},
{
"code": "ROU",
"text": "Romania",
"type": "NATIONALITY"
}
],
"category": "DOC_REQUIRED",
"subCategory": "BEFORE_ARRIVAL"
},
"relationships": {
"country": {
"data": {
"id": "CAN",
"type": "COUNTRY"
}
}
}
},
{
"id": "113de2c3-7fad-41be-b17e-0b8d0932bbdf",
"type": "PROCEDURE",
"attributes": {
"country": "CAN",
"title": "Travelers departing from Canadian airports require proof of vaccination",
"description": "Travelers departing from Canadian airports, rail, and passengers vessels on voyages of 24 hours or more need to be fully vaccinated in order to board. This requirement applies to international and domestic departures.\n\nFully vaccinated travelers must have received a full course of vaccination with an accepted vaccine. The accepted 2 dose vaccines are:\n-AstraZeneca/COVISHIELD (ChAdOx1-S, Vaxzevria, AZD1222)\n-Bharat Biotech (Covaxin, BBV152 A, B, C)\n-Moderna (mRNA-1273)\n-Pfizer-BioNTech (Comirnaty, tozinameran, BNT162b2)\n-Sinopharm BIBP (BBIBP-CorV)\n-Sinovac (CoronaVac, PiCoVacc)\n\nThe accepted 1 dose vaccine is:\n-Janssen/Johnson & Johnson\n\nTravelers that have received a combination of 2 accepted vaccines are considered fully vaccinated. Travelers must have received their last dose at least 15 days before arrival.\n\nTravelers who fail to comply, refuse, or provide untruthful information on this measure, may be subject to a penalty or a fine.",
"more": [
"This requirement does not apply to:\n-Travelers under the age of 12 years plus 4 months;\n-Travelers crossing the Canada-US land border. \n\nFor exemptions for travelers in the process of being vaccinated, travelers from remote communities, and more, please check the source."
],
"enforcement": "MANDATORY",
"documentType": [
"COVID_19_VACCINATION"
],
"documentLinks": [],
"tags": [
"international",
"domestic",
"fully_vaccinated",
"air",
"land",
"sea"
],
"source": {
"sourceType": "GOVERNMENT",
"title": "Government of Canada",
"url": "https://www.canada.ca/en/transport-canada/news/2021/10/mandatory-covid-19-vaccination-requirements-for-federally-regulated-transportation-employees-and-travellers.html"
},
"lastUpdatedAt": "2022-02-10T01:34:00.000Z",
"createdAt": "2021-11-21T21:39:00.000Z",
"startDate": "2021-11-30T00:00:00.000Z",
"endDate": null,
"category": "DOC_REQUIRED",
"subCategory": "BEFORE_DEPARTURE"
},
"relationships": {
"country": {
"data": {
"id": "CAN",
"type": "COUNTRY"
}
}
}
},
curl --location -g--request
GET 'https://requirements-api.sandbox.joinsherpa.com/v2/procedures?key=<API_KEY>&filter[country]=CAN'
Getting Visa specific information from /Procedures endpoint
The visa requirements as part of the v2/procedures resource endpoint presents a traveller with visa-specific information for a destination as it relates to different nationalities.
Retrieving Procedures
Check Visa procedures for a country (E.g. Canada (CAN)).
curl --request GET \
--url 'https://requirements-api.sandbox.joinsherpa.com/v2/procedures?key={{apiKey}}&filter[country]=CAN&filter[nationalities]=USA&filter[documentType]=VISA,E_VISA,ETA,EMBASSY_VISA&filter[category]=DOC_REQUIRED
{
"meta": {
"copyright": "Sherpa",
"version": "2.8.4"
},
"data": [
{
"id": "dbd5b096-9997-4d3f-a8b3-9ff07e65757b",
"type": "PROCEDURE",
"attributes": {
"country": "CAN",
"title": "No visa required",
"description": "Visitors traveling for Business or Tourism do not require a visa.\nTo check permitted length of stay and other entry requirements, visit the government site.",
"more": [],
"enforcement": "NOT_REQUIRED",
"documentType": [
"VISA"
],
"documentLinks": [],
"tags": [
"international",
"land",
"air",
"sea",
"tourism",
"business",
"transit"
],
"source": {
"sourceType": "GOVERNMENT",
"title": "Government of Canada",
"url": "https://www.canada.ca/en/immigration-refugees-citizenship/services/visit-canada/entry-requirements-country.html"
},
"lastUpdatedAt": "2021-09-08T15:12:00.000Z",
"createdAt": "2021-04-27T03:44:00.000Z",
"startDate": null,
"endDate": null,
"lengthOfStay": [
{
"type": "DAYS",
"value": 180,
"text": "180 days"
}
],
"travelPurpose": [
"TOURISM",
"BUSINESS",
"TRANSIT"
],
"included": [
{
"code": "USA",
"text": "United States",
"type": "NATIONALITY"
},
{
"code": "GUM",
"text": "Guam",
"type": "NATIONALITY"
},
{
"code": "PRI",
"text": "Puerto Rico",
"type": "NATIONALITY"
},
{
"code": "ASM",
"text": "American Samoa",
"type": "NATIONALITY"
},
{
"code": "VIR",
"text": "U.S. Virgin Islands",
"type": "NATIONALITY"
}
],
"category": "DOC_REQUIRED",
"subCategory": "BEFORE_ARRIVAL"
},
"relationships": {
"country": {
"data": {
"id": "CAN",
"type": "COUNTRY"
}
}
}
}
]
}
Visa Procedure Model
Attribute | Type | Description |
|---|---|---|
id | string | A unique identifier for the Visa procedure. |
type | string | Indicates the type of data being presented (will show PROCEDURE) |
country | string | A 3-word ISO code for the issuing authority / country. |
title | string | A title for document type (can be Visitor Visa, Tourist Visa, Business Visa etc) |
enforcement | string | The level of enforcement (can be MANDATORY or NOT_REQUIRED) |
documentType | object | The type of visa required for the specific trip (can be VISA or eVISA, ETA, EMBASSY_VISA) |
tags | array | Indicates the ports of entry on which the specific visa applies (can be international, land, air, sea, tourism, business or transit ) |
source | string | This points to the source, url and link of the information (usually a government site, airline or tourism board) |
lastUpdatedAt | string | Last date sherpa updated its database with information on this requirement. |
createdAt | string | Date when the requirement was created in Sherpa's repository. |
startDate | string | Date when the requirement became active. This is usually empty since most visa requirements have been in place. |
endDate | string | Date when the requirement is expected to end. This is also always empty since visa requirements unlike covid restrictions are not expected to end soon. |
lengthOfStay | string | The number of days a traveller is allowed to stay in the destination country with a visa or without, if it is not enforced or required. |
travelPurpose | string | The purpose for which the visa requirement is issued. This can be Tourism, Business or Transit . |
included | array | A list of countries affected by the specific visa requirement. |
Available Filters
Filter Name | Data Filtered |
|---|---|
Filter[country] | Visa procedures can be filtered based on country. This wIll take ISO-3 value of a country (eg: GHA, CAN) as parameter. |
Filter[nationalities] | Visa procedures can be filtered based on nationality, indicating the nationality of the traveller. This will take ISO-3 value of a country (eg: GHA, CAN) as parameter. |
Filter[documentType] | Visa procedures can be filtered based on document type. Any or all of the following can be passed as parameters: VISA, E_VISA, ETA, EMBASSY_VISA |
Filter[category] | Visa procedures can be filtered based on category. This will take some or all of the following QUARANTINE, HEALTH_MEASURES, PPE, DOC_REQUIRED, COVID_19_TEST, NO_QUARANTINE, NO_COVID_19_TEST, HEALTH_ASSESSMENT, SANITIZATION, RE_ENTRY_PERMIT, DEPOSIT_REQUIRED, HEALTH_INSURANCE, TRAVEL_INSURANCE values as parameters. |
Examples
Below is a sample search for a Canadian Visa Requirement for a United States national
{
"meta": {
"copyright": "Sherpa",
"version": "2.8.4"
},
"data": [
{
"id": "dbd5b096-9997-4d3f-a8b3-9ff07e65757b",
"type": "PROCEDURE",
"attributes": {
"country": "CAN",
"title": "No visa required",
"description": "Visitors traveling for Business or Tourism do not require a visa.\nTo check permitted length of stay and other entry requirements, visit the government site.",
"more": [],
"enforcement": "NOT_REQUIRED",
"documentType": [
"VISA"
],
"documentLinks": [],
"tags": [
"international",
"land",
"air",
"sea",
"tourism",
"business",
"transit"
],
"source": {
"sourceType": "GOVERNMENT",
"title": "Government of Canada",
"url": "https://www.canada.ca/en/immigration-refugees-citizenship/services/visit-canada/entry-requirements-country.html"
},
"lastUpdatedAt": "2021-09-08T15:12:00.000Z",
"createdAt": "2021-04-27T03:44:00.000Z",
"startDate": null,
"endDate": null,
"lengthOfStay": [
{
"type": "DAYS",
"value": 180,
"text": "180 days"
}
],
"travelPurpose": [
"TOURISM",
"BUSINESS",
"TRANSIT"
],
"included": [
{
"code": "USA",
"text": "United States",
"type": "NATIONALITY"
},
{
"code": "GUM",
"text": "Guam",
"type": "NATIONALITY"
},
{
"code": "PRI",
"text": "Puerto Rico",
"type": "NATIONALITY"
},
{
"code": "ASM",
"text": "American Samoa",
"type": "NATIONALITY"
},
{
"code": "VIR",
"text": "U.S. Virgin Islands",
"type": "NATIONALITY"
}
],
"category": "DOC_REQUIRED",
"subCategory": "BEFORE_ARRIVAL"
},
"relationships": {
"country": {
"data": {
"id": "CAN",
"type": "COUNTRY"
}
}
}
}
]
}
Updated 23 days ago