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

πŸ†• Show alerts about important information

Inform users about current and future travel restrictions.

Overview

Use Sherpa’s Travel Restrictions & Safety API to help your customers navigate the new travel landscape. Keep them informed as travel reopens and ease their anxiety with contextual alerts at every stage of their journey.

During Search

Travel restrictions and health procedures like mandatory quarantine made travel planning complicated. Beyond flight price, time and airline, customers have must consider policies introduced by Governments. These policies can change daily, and affect decision to purchase a flight or hotel.

Using Sherpa's API, important relevant information can be presented at time of booking or search.

  1. Latest travel restrictions
  2. Procedures like quarantine, health declarations or health tests.

πŸ‘

Reassure Travellers

Sherpa keeps track of policies that will take effect in the future. For example, Quarantine becoming not mandatory after a certain date. You reassure travellers at the time of purchase.

Look for startDate in procedure object to see when the policy becomes active.

Implementation

When the customer searches for a flight, we will know the origin, destination countries and optionally, a travel date.

To fetch information from Sherpa, we will use the countries endpoint.

curl --location --request GET 'https://requirements-api.sandbox.joinsherpa.com/v2/countries/AUS?key=<<API_KEY>>&include=procedure,restriction&travelHisotry=CAN'
{
    "meta": {
        "copyright": "Sherpa",
        "version": "2.3.0"
    },
    "data": {
        "id": "AUS",
        "type": "country",
        "attributes": {
            "type": "COUNTRY",
            "countryName": "Australia",
            "isoAlpha2": "AU",
            "isoAlpha3": "AUS",
            "citizenship": "Australian",
            "continent": "Oceania",
            "visaStatus": "RESTRICTED",
            "entryStatus": "COMPLETELY_CLOSED",
            "exitStatus": "COMPLETELY_CLOSED",
            "lastUpdatedAt": "2020-06-11T14:04:00Z",
            "lastCheckedAt": "2020-06-10T00:00:00Z",
            "stillCurrentAt": "2020-06-10T00:00:00Z"
        },
        "relationships": {
            "restrictions": {
                "meta": {
                    "count": 2
                },
                "data": [
                    {
                        "id": "4fa8aa1b-49cb-4237-841d-3094cb8b7f30",
                        "type": "RESTRICTION"
                    },
                    {
                        "id": "96e139a8-e32c-4a6a-b2c2-a2005a921a6e",
                        "type": "RESTRICTION"
                    }
                ]
            },
            "procedures": {
                "meta": {
                    "count": 2
                },
                "data": [
                    {
                        "id": "2dbadfe5-dc9e-4b5a-8184-cc7004227e36",
                        "type": "PROCEDURE"
                    },
                    {
                        "id": "4b900473-0b38-4274-993b-454f1898421c",
                        "type": "PROCEDURE"
                    }
                ]
            }
        }
    },
    "included": [
        {
            "id": "4fa8aa1b-49cb-4237-841d-3094cb8b7f30",
            "type": "RESTRICTION",
            "attributes": {
                "country": "AUS",
                "title": "Entry restrictions for international travellers",
                "description": "Most international travellers are not allowed to enter Australia.",
                "directionality": "MORE",
                "more": [
                    "Entry into Australia is permitted to:\n-Australian citizens\n-Permanent residents\n-Immediate family members of an Australian citizen or permanent resident\n-New Zealand citizens that are usually a resident in Australia\nIf you are an immediate family member holding a temporary visa you will need to provide evidence of your relationship."
                ],
                "tags": [],
                "source": {
                    "sourceType": "GOVERNMENT",
                    "title": "Australia Home Affairs",
                    "url": "https://covid19.homeaffairs.gov.au/coming-australia"
                },
                "lastCheckedAt": "2020-06-08T00:00:00Z",
                "lastUpdatedAt": "2020-06-08T15:48:00Z",
                "stillCurrentAt": "2020-06-08T00:00:00Z",
                "startDate": "2020-03-20T00:00:00Z",
                "endDate": null,
                "category": "NO_ENTRY",
                "subCategory": "ENTRY"
            }
        },
        {
            "id": "96e139a8-e32c-4a6a-b2c2-a2005a921a6e",
            "type": "RESTRICTION",
            "attributes": {
                "country": "AUS",
                "title": "Australians are not allowed to travel abroad",
                "description": "Most Australian citizens and permanent residents can't travel internationally.",
                "directionality": "MORE",
                "travelPurpose": [
                    "BUSINESS"
                ],
                "more": [
                    "If you want to leave Australia, you may be able to apply online for an exemption to travel if you fall under one of the following categories:\n-your travel is as part of the response to the COVID-19 outbreak, including the provision of aid\n-your travel is essential for the conduct of critical industries and business (including export and import industries)\n-you are travelling to receive urgent medical treatment that is not available in Australia\n-you are travelling on urgent and unavoidable personal business\ncompassionate or humanitarian grounds\n-your travel is in the national interest"
                ],
                "tags": [],
                "source": {
                    "sourceType": "GOVERNMENT",
                    "title": "Australian Home Affairs",
                    "url": "https://covid19.homeaffairs.gov.au/leaving-australia"
                },
                "lastCheckedAt": "2020-06-08T00:00:00Z",
                "lastUpdatedAt": "2020-06-08T15:48:00Z",
                "stillCurrentAt": "2020-06-08T00:00:00Z",
                "startDate": null,
                "endDate": null,
                "category": "NO_EXIT",
                "subCategory": "EXIT"
            }
        },
        {
            "id": "2dbadfe5-dc9e-4b5a-8184-cc7004227e36",
            "type": "PROCEDURE",
            "attributes": {
                "country": "AUS",
                "title": "Travel exemption application",
                "description": "Travellers who have a compassionate or compelling reason to travel to Australia can apply for an exemption.",
                "directionality": "NO_CHANGE",
                "more": [
                    "The Commissioner of the Australian Border Force (ABF) may consider an additional exemption in relation to the travel restrictions currently in place for:\n-foreign nationals travelling at the invitation of the Australian Commonwealth Government for the purpose of assisting in the COVID-19 response or whose entry would be in the national interest\n-critical medical services, including air ambulance and delivery of supplies, that regularly arrive into Australia from international ports\n-people with critical skills (for example, medical specialists, engineers, marine pilots and crews) by exception\n-diplomats accredited to Australia and currently resident in Australia, and their immediate family\n​-case-by-case exceptions for humanitarian or compassionate reasons."
                ],
                "tags": [],
                "source": {
                    "sourceType": "GOVERNMENT",
                    "title": "Australia Home Affairs",
                    "url": "https://covid19.homeaffairs.gov.au/coming-australia"
                },
                "lastCheckedAt": "2020-06-08T00:00:00Z",
                "lastUpdatedAt": "2020-06-08T15:52:00Z",
                "stillCurrentAt": "2020-06-08T00:00:00Z",
                "startDate": null,
                "endDate": null,
                "category": "DOC_REQUIRED",
                "subCategory": "BEFORE_DEPARTURE"
            }
        },
        {
            "id": "4b900473-0b38-4274-993b-454f1898421c",
            "type": "PROCEDURE",
            "attributes": {
                "country": "AUS",
                "title": "Mandatory 14-day quarantine",
                "description": "All travellers are required to quarantine for 14 days upon their arrival at designated facilities (for example, a hotel), at their port of arrival.​",
                "directionality": "NO_CHANGE",
                "more": [],
                "tags": [],
                "source": {
                    "sourceType": "GOVERNMENT",
                    "title": "Australia Home Affairs",
                    "url": "https://covid19.homeaffairs.gov.au/coming-australia"
                },
                "lastCheckedAt": "2020-06-08T00:00:00Z",
                "lastUpdatedAt": "2020-06-08T15:49:00Z",
                "stillCurrentAt": "2020-06-08T00:00:00Z",
                "startDate": null,
                "endDate": null,
                "category": "QUARANTINE",
                "subCategory": "ON_ARRIVAL"
            }
        }
    ]
}

Updated 3 months ago



πŸ†• Show alerts about important information


Inform users about current and future 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.