Restrictions

Notify travellers about travel restrictions.

Introduction

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

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>>'

Directionality (preview)

📘

Preview attributes may change

This attribute is a preview and can be utilized to indicate the direction of a restriction, compared to the previous statement of that particular restriction.
Preview attributes may change or might be marked as deprecated in future updates before being removed.

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


Did this page help you?