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

Procedures

Notify travellers about health, medical and safety procedures.

Procedures are used to describe medical, health, safety or other procedure that is imposed by a government, an airline or an airport.

πŸ“˜

View the API Reference

Procedure Categories

Procedures vary by country, airline and airport. Sherpa is monitoring the following procedures:

🚧

Category Changes Coming!

Currently, there are 13 Procedure Categories. The proposed change will reduce it to 4.

See more details:
https://docs.joinsherpa.io/changelog/procedure-category-changes

Category

Description

Example

QUARANTINE

Quarantine Policy

All passengers who traveled to the a specified country during the last 14 days are prohibited to be accepted to all flights to Turkey. Otherwise, all passengers on the flights will be quarantined for 14 days.

NO_QUARANTINE

Quarantine Policy

DOC_REQUIRED

Health DeclarationHealth Declaration - A mandatory form for travellers entering a country or region. Often contains health, passport & contact information questions. In many cases, the form can be submitted electronically. Requirement

All travellers entering Chile, and when Chile is their final destination, must give a declaration which must be completed in the airplane, ship or land border.

PPE

Personal Protective Equipment

When travelling by air, travellers will be asked to cover their mouth and nose.

HEALTH_ASSESSMENT

Health Assessment

All Passengers Will Be Required to Download and Respond to Daily Questions via a Self-Diagnosis Mobile App for 14 Days.

COVID_19_TEST

COVID-19 Test

Every individual entering Laos is required to provide samples for COVID-19 testing.

NO_COVID_19_TEST

COVD-19 Test

Deprecating
COVID-19 test is not required

HEALTH_MEASURES

Health measures

Mandatory accommodation booking for quarantine

SANITIZATION

Sanitization

Additional sanitization wipes are provided during flight

RE_ENTRY_PERMIT

Additional permit required to re-enter country

Travellers that are not allowed to enter New Zealand can apply for entry if they fall into a selected category.

DEPOSIT_REQUIRED

Deposit of funds required

Travellers that are not citizens of Cambodia will be required to make a 3000 USD deposit at the airport to cover the costs of testing, quarantine accommodation, and other medical costs. After costs have been paid for, the remainder will be returned to the traveller.

HEALTH_INSURANCE

Health insurance policy

TRAVEL_INSURANCE

Travel insurance policy

Procedure Sub Categories

Sub Category

Description

Example

ON_ARRIVAL

Procedure is in effect upon arrival in destination.

Mandatory health risk assessment or mandatory isolation or quarantine to all foreigns entering Cambodia.

IN_FLIGHT

Procedure applies to the duration of the flight.

When travelling by air, travellers will be asked to cover their mouth and nose.

BEFORE_DEPARTURE

Procedure is in effect prior to departure.

Travellers who have a compassionate or compelling reason to travel to Australia can apply for an exemption.

BEFORE_ARRIVAL

Procedure is in effect prior to arrival from a country.

Travellers must pay for and take a PCR COVID-19 test through the portal within 72 hours of their departure from Sierra Leone. Certificates confirming the test result will be emailed and copies to collect in person at the airport. Travellers need to provide this certificate confirming the test result at check-in.

DOMESTIC

This procedure applies to domestic travel.

Travellers from one of the following states must quarantine upon arrival in New York.

IN_AIRPORT

This procedure applies at the origin or destination airport.

Travellers must wear a mask while waiting in line to board the aircraft.

Directionality

Value

Description

LESS

The procedures have become more stringent.

MORE

The procedures have become more stringent.

NO_CHANGE

The procedures have not become more or less stringent.

Link to additional required documentation

Value

Description

documentLinks

List of URLs leading to a document or form that relates to this procedure.

Accuracy

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

Retrieving Procedures

Check procedures for a RegionRegion - An administrative divisions, including state, provinces, territories. (E.g. Canada (CAN)).

{
    "meta": {
        "copyright": "Sherpa",
        "version": "1.0.0"
    },
    "data": [
        {
            "id": "7a824bc6-8403-4a72-8317-ea1593c8f3f5",
            "type": "procedure",
            "attributes": {
                "title": "Mandatory Contact Information Form",
                "description": "Travellers entering Canada by air or by land must provide basic information using the traveller contact information form.",
                "more": [
                    "This form is available through:\nthe ArriveCAN mobile app\nan accessible web-based form, or\na paper form\nEntrants must undergo screening by a border services officer or quarantine officer to assess symptoms."
                ],
                "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": "",
                "lastCheckedAt": "",
                "lastUpdatedAt": "",
                "category": "DOC_REQUIRED",
                "subCategory": "ON_ARRIVAL"
            },
            "links": {
                "self": "https://requirements-api.sandbox.joinsherpa.com/v2/procedures/7a824bc6-8403-4a72-8317-ea1593c8f3f5"
            }
        },
        {
            "id": "82c335f5-eb9e-48f6-916b-52f8a3c85a13",
            "type": "procedure",
            "attributes": {
                "title": "Mandatory Non-Medical Mask",
                "description": "When travelling by air, travellers will be asked to cover their mouth and nose",
                "more": [
                    "When travelling by air, travellers will be asked to cover their mouth and nose in the following situations:\nat Canadian airport screening checkpoints, where the screeners cannot always keep 2 metres of separation between themselves and the traveller\nwhen they cannot physically distance from others, or as directed by the airline employees\nwhen directed to do so by a public health order or public health official\nAviation passengers on all flights departing or arriving at Canadian airports will also be required to demonstrate they have the necessary non-medical mask or face covering during the boarding process otherwise they will not be allowed to continue on their journey."
                ],
                "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": "",
                "lastCheckedAt": "",
                "lastUpdatedAt": "",
                "category": "PPE",
                "subCategory": "IN_FLIGHT"
            },
            "links": {
                "self": "https://requirements-api.sandbox.joinsherpa.com/v2/procedures/82c335f5-eb9e-48f6-916b-52f8a3c85a13"
            }
        },
        {
            "id": "b1ce0468-77d2-4110-a492-fc5a94e9fee4",
            "type": "procedure",
            "attributes": {
                "title": "Mandatory 14-Day Self Isolation Period ",
                "description": "The Canadian authorities have imposed a mandatory 14-day self isolation period for all entrants.",
                "more": [
                    "You must isolate in a place where you will not have contact with vulnerable people, such as:\n-People 65 years or older, or\n-People with underlying medical conditions\n-You will need to confirm you have a suitable place to isolate where you will have access to basic necessities, such as food and medication\n-You must use private transportation (such as your own vehicle) to get to your place of isolation\n-You must wear a non-medical mask or face covering while traveling to your place of isolation"
                ],
                "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": "QUARANTINE",
                "subCategory": "ON_ARRIVAL"
            },
            "links": {
                "self": "https://requirements-api.sandbox.joinsherpa.com/v2/procedures/b1ce0468-77d2-4110-a492-fc5a94e9fee4"
            }
        }
    ],
    "links": {
        "self": "https://requirements-api.sandbox.joinsherpa.com/v2/procedures?filter[country]=CAN"
    }
}
curl --request GET \
  --url 'https://requirements-api.sandbox.joinsherpa.com/v2/procedures?filter[country]=CAN&key=<<requirementsApiKeySandbox>>'

Quarantine

Quarantine procedures significantly impact travel decisions. To address concerns, SherpaΒ° API offers helpful metadata describing quarantine procedures.

Property

Description

Values

defaultDurationInDays

Duration of quarantine.

UNTIL_TEST_RESULTS, UNTIL_TEST_NEGATIVE, NO_TIME_PERIOD, LENGTH_OF_STAY, 7, 14 or any number

enforcement

How quarantine is enforced by the Government.

MANDATORY, RECOMMENDED, MAY_BE_REQUIRED, OPTIONAL

durationInDays

Quarantine measures can vary. In some cases, travellers must quarantine until their test results come back negative.

UNTIL_TEST_RESULTS, UNTIL_TEST_NEGATIVE, NO_TIME_PERIOD, LENGTH_OF_STAY, 7, 10, 14, 28 or any number

durationReductionMeasures

How may quarantine duration be reduced.

TEST, TEST_NEGATIVE, ASYMPTOMATIC, MEDICAL_CERTIFICATE

durationExtensionMeasures

How may quarantine duration be extended.

SYMPTOMS, TEST_POSITIVE

enforcementCondition

Quarantine may be conditional, for example if a traveller is has been in a hotspot in the past 14 days or is showing symptoms.

SYMPTOMS, TEST_POSITIVE, NO_TEST, NO_CERTIFICATE, TRAVEL_HISTORY, NO_TEST_RESULT_NEGATIVE, LENGTH_OF_STAY, CONTACT_WITH_COVID_CASE, NON_ESSENTIAL_TRAVEL

alternativeMeasures

Type of document or measure that is an exception to quarantine policy.

TEST, TEST_RESULT, MEDICAL_CERTIFICATE, HEALTH_CERTIFICATE, IMMUNITY_PROOF, MEDICAL_TREATMENT, TEST_RESULT_NEGATIVE

Updated 15 days ago


Procedures


Notify travellers about health, medical and safety procedures.

Suggested Edits are limited on API Reference Pages

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