Sherpa - Visa and Travel Restrictions API

Sherpa Developer Hub

Welcome to the Sherpa developer hub. We offer a suite of solutions that guides travellers from planning to a safe return home. Take a look at the integration guides, specific use cases and an interactive API Reference. Ready? Let's go.

Guides    API Reference

Restrictions

Notify travellers about travel restrictions.

Restrictions are used to describe policies imposed by a country, region, airline or airport that prevent certain groups of people to travel.

For example There is a temporary ban of entry to all non-EU/EEA citizens

🚧

Provide restrictions based on trip origin

As travel begins to resume, restrictions are often based on a traveller's point of origin instead of their nationality. See our trips page for more information.

Retrieving Restrictions

📘

View the API Reference

{
    "meta": {
        "copyright": "Sherpa",
        "version": "1.0.0"
    },
    "data": [
        {
            "id": "249b606e-c3ce-4c35-98cf-f7dea8d4a61c",
            "type": "restriction",
            "attributes": {
                "title": "Entry Restrictions for Foreign Nationals",
                "description": "All foreign nationals who do not meet the travel exemptions are banned from entering Canada.",
                "more": [
                    "Entry into Canada is permitted to:\n-Canadian citizen\n-Permanent resident\n-Immediate family members of Canadian citizens or permanent residents"
                ],
                "source": {
                    "sourceType": "GOVERNMENT",
                    "title": "Canadian Government",
                    "description": "Coronavirus disease (COVID-19): Travel restrictions, exemptions and advice",
                    "url": "https://www.canada.ca/en/public-health/services/diseases/2019-novel-coronavirus-infection/latest-travel-health-advice.html#_Canada-U.S._border_restrictions_1"
                },
                "tags": [],
                "stillCurrentAt": "2020-05-12T04:00:00Z",
                "lastCheckedAt": "2020-05-12T04:00:00Z",
                "lastUpdatedAt": "2020-05-12T04:00:00Z",
                "category": "RESTRICTED_ENTRY",
                "subCategory": "ENTRY"
            },
            "links": {
                "self": "https://requirements-api.sandbox.joinsherpa.com/v2/restrictions/249b606e-c3ce-4c35-98cf-f7dea8d4a61c"
            }
        },
        {
            "id": "8d276e29-9f02-48da-89fc-6413b0efd08e",
            "type": "restriction",
            "attributes": {
                "title": "Travel Through the United States Border is Restricted",
                "description": "The Canadian border is temporarily restricted to essential travel across the Canadian-US land border.",
                "more": [
                    "Examples of discretionary/ optional (non-essential) travel include:\n-Tourism\n-Recreation\n-Entertainment"
                ],
                "source": {
                    "sourceType": "GOVERNMENT",
                    "title": "Canadian Government",
                    "description": "Coronavirus disease (COVID-19): Travel restrictions, exemptions and advice",
                    "url": "https://www.canada.ca/en/public-health/services/diseases/2019-novel-coronavirus-infection/latest-travel-health-advice.html#_Canada-U.S._border_restrictions_1"
                },
                "tags": [],
                "stillCurrentAt": "2020-05-12T04:00:00Z",
                "lastCheckedAt": "2020-05-12T04:00:00Z",
                "lastUpdatedAt": "2020-05-12T04:00:00Z",
                "category": "RESTRICTED_ENTRY",
                "subCategory": "ENTRY"
            },
            "links": {
                "self": "https://requirements-api.sandbox.joinsherpa.com/v2/restrictions/8d276e29-9f02-48da-89fc-6413b0efd08e"
            }
        }
    ],
    "links": {
        "self": "https://requirements-api.sandbox.joinsherpa.com/v2/restrictions?filter[country]=CAN"
    }
}
curl --request GET \
  --url 'https://requirements-api.sandbox.joinsherpa.com/v2/countries/CAN?key=<<requirementsApiKeySandbox>>'

Restriction Categories

Category

Description

NO_ENTRY

Restriction represents a ban on entry

ENTRY

Restriction affects the entry

RESTRICTED_ENTRY

Restriction is in addition to entry

NO_EXIT

Restriction represents restriction no exit

EXIT

Restriction represents allowance to exit

RESTRICTED_EXIT

Restriction is in addition to exit

BOARDING

Restriction applies to the boarding of a flight

TRANSIT

Restriction affects transit through borders

Restriction Sub Categories

Value

Description

ON_ARRIVAL

Restriction applies on arrival to destination

IN_FLIGHT

Restriction is affective during flight

ENTRY

Restriction applies on entry through border

EXIT

Restriction applies on exit through border

BOARDING

Restriction applies to boarding of a flight

TRANSIT

Restriction affects transit through borders

Directionality

Value

Description

LESS

The restriction has become less stringent.

MORE

The restriction has become more stringent

NO_CHANGE

The level of restriction has not changed.

Additional Documents

Attribute

Description

documentLinks

A list of URLs that link to a document or form that relates to this restriction.

Accuracy

Each Restriction object in the response includes details about the source of information, when it was last checked and updated.

View a sample request and response that checks restrictions for a CountryCountry - A country is a political state, nation, or controlled territory. It is usually represented by an ISO2 or ISO3 Code. (E.g. Canada (CAN)).

👍

Tip

Using the sourceType and stillCurrentAt properties, you can limit the restrictions to Government sources that are accurate as of this week.

📘

View the API Reference

Updated 15 days ago


Restrictions


Notify travellers about travel restrictions.

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.