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

πŸ›« Trips

Personalized travel restrictions for every journey.

The Trips endpoint lets developers retrieve personalized travel restrictions and documents based on trip context like origin, destination, date of travel.

See API Specification

πŸ“˜

Note

Trips endpoint is a convenient way to retrieve contextualized Restrictions and Procedures enforced by Countries or Regions.

Describing a Trip

A TripTrip - A trip describes the traveller's journey. A trip is comprised of one or more Segments. can be described using one or multiple SegmentSegment - A part of a trip between two successive stops. A return trip consists of two segments..

Property

Type

Description

category

string

ONE_WAY_TRIP, ROUND_TRIP, MULTI_CITY_TRIP

segments

Array of Segments

Segments describing the trip

Describing a Segment

A SegmentSegment - A part of a trip between two successive stops. A return trip consists of two segments. is used to describe the specific part of the trip like a flight or bus ride from one city to the next.

Property

Type

Description

segmentType

string

RETURN or OUTBOUND

origin.countryCode

string

ISO3 Country CodeISO3 Country Code - A country code in an ISO3 Format. For example, `USA`, `CAN`, `DEU`.

destination.countryCode

string

ISO3 Country CodeISO3 Country Code - A country code in an ISO3 Format. For example, `USA`, `CAN`, `DEU`.

departureDate

string

A departure date YYYY-MM-DD

departureTime

string

HH:MM

arrivalDate

string

Arrival date YYYY-MM-DD

arrivalTime

string

HH:MM

curl --location --request POST 'https://requirements-api.joinsherpa.com/v2/trips?affiliateId=sherpa&key=<<API_KEY>>&language=en&include=restriction,procedure' \
--header 'Content-Type: application/json' \
--data-raw '{ "data": {
    "type": "TRip",
    "attributes": {
        "category": "ROUND_TRIP",
        "segments": [
            {
                "segmentType": "OUTbOUND",
                "origin": {
                    "countryCode": "CaN"
                },
                "destination": {
                    "countryCode": "Gbr"
                },
                "departureDate": "2021-02-22",
                "departureTime": "12:59",
                "arrivalDate": "2021-02-22",
                "arrivalTime": "12:59"
            },
            {
                "segmentType": "Return",
                "origin": {
                    "countryCode": "gbr"
                },
                "destination": {
                    "countryCode": "Can"
                },
                "departureDate": "2021-02-27",
                "departureTime": "12:59",
                "arrivalDate": "2021-02-27",
                "arrivalTime": "12:59"
            }
        ]
    }
}}'
{
    "meta": {
        "copyright": "Sherpa",
        "version": "2.6.0"
    },
    "data": {
        "id": "e08bc0a0-72be-11eb-befc-638c7120027c",
        "type": "TRIP",
        "attributes": {
            "category": "MULTI_CITY_TRIP",
            "segments": [
                {
                    "segmentType": "OUTBOUND",
                    "origin": {
                        "countryCode": "USA",
                        "countryName": "United States"
                    },
                    "destination": {
                        "countryCode": "COL",
                        "countryName": "Colombia"
                    },
                    "departureDate": "2021-02-21T00:00:00.000Z",
                    "departureTime": "16:00",
                    "arrivalDate": "2021-02-21T00:00:00.000Z",
                    "arrivalTime": "21:00",
                    "borderCrossing": "INTERNATIONAL",
                    "entryRestrictions": [
                        {
                            "id": "eaba2cd4-52d2-4167-b7b4-b61cee53c597"
                        }
                    ],
                    "travelRestrictions": [
                        {
                            "id": "401379e8-4fd5-4112-9d8f-5c0f6aae3f93"
                        },
                        {
                            "id": "4a6b020a-e04b-4bb0-8352-a295f72d1d06"
                        }
                    ],
                    "documents": [
                        {
                            "id": "551eb1b1-2d37-4aaa-b9f7-cb8e56628a5d"
                        },
                        {
                            "id": "ac193706-7f4b-4184-98d6-a866ebf73fc3"
                        }
                    ],
                    "exitRestrictions": [],
                    "summary": {
                        "headline": "Most travellers from United States can visit Colombia, but there are restrictions.",
                        "travelOpenness": "HARDER"
                    }
                },
                {
                    "segmentType": "RETURN",
                    "origin": {
                        "countryCode": "COL",
                        "countryName": "Colombia"
                    },
                    "destination": {
                        "countryCode": "USA",
                        "countryName": "United States"
                    },
                    "departureDate": "2021-02-27T00:00:00.000Z",
                    "departureTime": "16:00",
                    "arrivalDate": "2021-02-27T00:00:00.000Z",
                    "arrivalTime": "21:00",
                    "borderCrossing": "INTERNATIONAL",
                    "entryRestrictions": [
                        {
                            "id": "31b2db7f-4b79-4e30-9cef-5151a317b284"
                        }
                    ],
                    "travelRestrictions": [
                        {
                            "id": "14ff8cb4-5373-472d-b3d6-05616dfada9e"
                        },
                        {
                            "id": "79be28d5-85d5-4266-badb-0589c80f083c"
                        }
                    ],
                    "documents": [
                        {
                            "id": "62b6b8c4-0e10-475f-b705-1dd1ba117577"
                        },
                        {
                            "id": "e62b1f47-156d-4bc0-8dda-f8558674a523"
                        }
                    ],
                    "exitRestrictions": [],
                    "summary": {
                        "headline": "Most travellers can return to United States from Colombia, but there are restrictions.",
                        "travelOpenness": "HARDER"
                    }
                }
            ]
        },
        "relationships": {
            "restrictions": {
                "meta": {
                    "count": 2
                },
                "data": [
                    {
                        "id": "eaba2cd4-52d2-4167-b7b4-b61cee53c597",
                        "type": "RESTRICTION"
                    },
                    {
                        "id": "31b2db7f-4b79-4e30-9cef-5151a317b284",
                        "type": "RESTRICTION"
                    }
                ]
            },
            "procedures": {
                "meta": {
                    "count": 8
                },
                "data": [
                    {
                        "id": "401379e8-4fd5-4112-9d8f-5c0f6aae3f93",
                        "type": "PROCEDURE"
                    },
                    {
                        "id": "4a6b020a-e04b-4bb0-8352-a295f72d1d06",
                        "type": "PROCEDURE"
                    },
                    {
                        "id": "551eb1b1-2d37-4aaa-b9f7-cb8e56628a5d",
                        "type": "PROCEDURE"
                    },
                    {
                        "id": "ac193706-7f4b-4184-98d6-a866ebf73fc3",
                        "type": "PROCEDURE"
                    },
                    {
                        "id": "14ff8cb4-5373-472d-b3d6-05616dfada9e",
                        "type": "PROCEDURE"
                    },
                    {
                        "id": "62b6b8c4-0e10-475f-b705-1dd1ba117577",
                        "type": "PROCEDURE"
                    },
                    {
                        "id": "79be28d5-85d5-4266-badb-0589c80f083c",
                        "type": "PROCEDURE"
                    },
                    {
                        "id": "e62b1f47-156d-4bc0-8dda-f8558674a523",
                        "type": "PROCEDURE"
                    }
                ]
            }
        }
    },
    "included": [
        {
            "id": "401379e8-4fd5-4112-9d8f-5c0f6aae3f93",
            "type": "PROCEDURE",
            "attributes": {
                "country": "COL",
                "title": "Quarantine may be required",
                "description": "Travelers that had a documented reason to not be able to get tested prior to boarding and that are allowed to travel without a COVID-19 test result will get tested on arrival and they need to self-isolate for 14 days. \n\nTravelers arriving with a valid COVID-19 test will not be required to quarantine upon arrival in Colombia.",
                "directionality": "LESS",
                "defaultDurationInDays": 14,
                "enforcement": "MAY_BE_REQUIRED",
                "durationInDays": [
                    14
                ],
                "enforcementConditions": [
                    "NO_TEST_RESULT"
                ],
                "severity": 0,
                "documentLinks": [
                    {
                        "url": "https://www.minsalud.gov.co/Normatividad_Nuevo/Resoluci%C3%B3n%20No.%202532de%202020.pdf",
                        "type": "LINK"
                    }
                ],
                "more": [],
                "tags": [
                    "international",
                    "air",
                    "land",
                    "sea"
                ],
                "source": {
                    "sourceType": "GOVERNMENT",
                    "title": "US Embassy for Colombia",
                    "url": "https://co.usembassy.gov/covid-19-information/"
                },
                "lastCheckedAt": "2021-02-18T00:00:00Z",
                "lastUpdatedAt": "2021-02-18T11:00:00Z",
                "stillCurrentAt": "2021-02-18T00:00:00Z",
                "createdAt": "2020-09-21T20:38:00Z",
                "startDate": "2020-11-04T00:00:00Z",
                "endDate": null,
                "included": [
                    {
                        "isoAlpha3": "AFG",
                        "countryName": "Afghanistan",
                        "type": "COUNTRY",
                        "locationType": "ORIGIN"
                    }
                ],
                "category": "QUARANTINE",
                "subCategory": "ON_ARRIVAL"
            }
        },
        {
            "id": "4a6b020a-e04b-4bb0-8352-a295f72d1d06",
            "type": "PROCEDURE",
            "attributes": {
                "country": "COL",
                "title": "Masks are mandatory in public",
                "description": "Travelers are required to wear masks in some public places such as on public transportation, in-flight, and in areas with a lot of people. In some cities, travelers are required to wear masks at all times while outside.",
                "directionality": "NO_CHANGE",
                "enforcement": "MANDATORY",
                "more": [],
                "tags": [
                    "international",
                    "domestic",
                    "air",
                    "land",
                    "sea"
                ],
                "source": {
                    "sourceType": "GOVERNMENT",
                    "title": "UK Government for Colombia",
                    "url": "https://www.gov.uk/foreign-travel-advice/colombia/entry-requirements"
                },
                "lastCheckedAt": "2021-02-18T00:00:00Z",
                "lastUpdatedAt": "2021-02-18T11:00:00Z",
                "stillCurrentAt": "2021-02-18T00:00:00Z",
                "createdAt": "2020-06-18T14:15:00Z",
                "startDate": "2020-04-04T00:00:00Z",
                "endDate": null,
                "category": "PPE",
                "subCategory": "DOMESTIC"
            }
        },
        {
            "id": "551eb1b1-2d37-4aaa-b9f7-cb8e56628a5d",
            "type": "PROCEDURE",
            "attributes": {
                "country": "COL",
                "title": "Proof of negative COVID-19 test results",
                "description": "Travelers are required to have a negative COVID-19 PCR test result from a test taken within 96 hours before departure. However, airlines must allow the boarding of travelers who do not have this test, when they verbally state that they had difficulties taking it or obtaining the result in the term required prior to the flight. The verbal manifestation of the passenger will be understood to be made under oath and they will be required to take the test upon arrival at their own cost and self-isolate until a negative test result is received. If they deny testing on arrival they must quarantine for 14 days in a hotel or at home. ",
                "directionality": "MORE",
                "enforcement": "MANDATORY",
                "medicalRequirementType": [
                    "PCR_TEST"
                ],
                "testWindow": [
                    {
                        "value": 96,
                        "condition": "BEFORE_DEPARTURE",
                        "type": "HOURS",
                        "text": "96 hours"
                    }
                ],
                "documentType": [
                    "COVID_TEST_RESULT"
                ],
                "severity": 3,
                "documentLinks": [
                    {
                        "url": "https://www.eltiempo.com/uploads/files/2021/01/07/nuevas_disposiciones_para_la_llegada_de_viajeros_enero_2021_1.pdf",
                        "type": "LINK"
                    }
                ],
                "more": [],
                "tags": [
                    "international",
                    "air",
                    "land",
                    "sea"
                ],
                "source": {
                    "sourceType": "GOVERNMENT",
                    "title": "US Embassy for Colombia",
                    "url": "https://co.usembassy.gov/covid-19-information/"
                },
                "lastCheckedAt": "2021-02-18T00:00:00Z",
                "lastUpdatedAt": "2021-02-18T10:59:00Z",
                "stillCurrentAt": "2021-02-18T00:00:00Z",
                "createdAt": "2021-01-04T20:06:00Z",
                "startDate": "2021-01-07T00:00:00Z",
                "endDate": null,
                "category": "DOC_REQUIRED",
                "subCategory": "BEFORE_ARRIVAL"
            }
        },
        {
            "id": "ac193706-7f4b-4184-98d6-a866ebf73fc3",
            "type": "PROCEDURE",
            "attributes": {
                "country": "COL",
                "title": "Mandatory pre-registration form",
                "description": "All travelers are required to fill out a pre-registration form prior to their arrival in Colombia and before their departure from Colombia. It must be filled between 48 hours and 1 hour before departure.",
                "directionality": "NO_CHANGE",
                "enforcement": "MANDATORY",
                "documentType": [
                    "TRAVEL_AUTHORIZATION"
                ],
                "documentLinks": [
                    {
                        "url": "https://apps.migracioncolombia.gov.co/pre-registro/public/preregistro.jsf",
                        "title": "Complete online",
                        "type": "LINK"
                    }
                ],
                "more": [
                    "Travelers will be required to show confirmation of registration before boarding."
                ],
                "tags": [
                    "international",
                    "air",
                    "land",
                    "sea"
                ],
                "source": {
                    "sourceType": "GOVERNMENT",
                    "title": "US Embassy for Colombia",
                    "url": "https://co.usembassy.gov/covid-19-information/"
                },
                "lastCheckedAt": "2021-02-18T00:00:00Z",
                "lastUpdatedAt": "2021-02-18T10:57:00Z",
                "stillCurrentAt": "2021-02-18T00:00:00Z",
                "createdAt": "2020-05-29T13:32:00Z",
                "startDate": "2020-03-15T00:00:00Z",
                "endDate": null,
                "category": "DOC_REQUIRED",
                "subCategory": "BEFORE_ARRIVAL"
            }
        },
        {
            "id": "14ff8cb4-5373-472d-b3d6-05616dfada9e",
            "type": "PROCEDURE",
            "attributes": {
                "country": "USA",
                "title": "Recommended quarantine",
                "description": "Travelers are recommended to quarantine between 7-10 days after arrival in the USA in all states. Travelers are recommended to take a COVID-19 test 3-5 days after arriving in the USA. If the test is negative it is recommended that travelers quarantine for 7 days, if they test positive they should self-isolate until they recover.\n\nTravelers should check quarantine requirements for the specific state they are traveling to, as some states such as Connecticut, Massachusetts, New York, Alaska, and Hawaii have implemented a mandatory quarantine for international travel. ",
                "directionality": "LESS",
                "defaultDurationInDays": 7,
                "enforcement": "RECOMMENDED",
                "durationInDays": [
                    7,
                    10
                ],
                "durationExtensionMeasures": [
                    "NO_TEST"
                ],
                "severity": 0,
                "more": [],
                "tags": [
                    "international",
                    "air",
                    "land",
                    "sea"
                ],
                "source": {
                    "sourceType": "GOVERNMENT",
                    "title": "Centers for Disease Control and Prevention - US",
                    "url": "https://www.cdc.gov/coronavirus/2019-ncov/travelers/testing-air-travel.html"
                },
                "lastCheckedAt": "2021-02-15T00:00:00Z",
                "lastUpdatedAt": "2021-02-15T16:54:00Z",
                "stillCurrentAt": "2021-02-15T00:00:00Z",
                "createdAt": "2020-07-14T16:39:10Z",
                "startDate": "2021-01-30T00:00:00Z",
                "endDate": null,
                "category": "QUARANTINE",
                "subCategory": "ON_ARRIVAL"
            }
        },
        {
            "id": "62b6b8c4-0e10-475f-b705-1dd1ba117577",
            "type": "PROCEDURE",
            "attributes": {
                "country": "USA",
                "title": "Proof of negative COVID-19 test results",
                "description": "All international travelers aged 2 years and older, including US citizens and residents, arriving in or connecting through the US by air are required to have a negative test result of a viral test taken within 3 days before their flight. The negative test should be from an antigen test or a NAAT test such as RT-PCR, RT-LAMP, TMA. The result must be presented to the airline before boarding in paper or electronic copy.\n \nInstead of the negative COVID-19 test results, travelers also have the option of providing documentation of having had recovered from COVID-19 by showing proof of a recent positive viral test (in the 90 days preceding travel) and a letter from their healthcare provider or a public health official stating that they were cleared to travel.\n\nWaiver to the testing requirement may be granted by the CDC on an extremely limited basis when extraordinary emergency travel.",
                "directionality": "MORE",
                "enforcement": "MANDATORY",
                "medicalRequirementType": [
                    "ANTIGEN_TEST",
                    "NUCLEIC_ACID_TEST",
                    "RT_PCR_TEST",
                    "RT_LAMP_TEST",
                    "TMA_TEST"
                ],
                "testWindow": [
                    {
                        "type": "DAYS",
                        "value": 3,
                        "condition": "BEFORE_DEPARTURE",
                        "text": "3 days"
                    }
                ],
                "documentType": [
                    "COVID_TEST_RESULT"
                ],
                "severity": 3,
                "documentLinks": [
                    {
                        "url": "https://www.cdc.gov/coronavirus/2019-ncov/travelers/testing-international-air-travelers.html",
                        "type": "LINK"
                    }
                ],
                "more": [
                    "For those who recently recovered from COVID-19, the letter from the healthcare provider or a public health official that clears travelers to end isolation, e.g., to return to work or school, can be used to show they are cleared to travel, even if travel isn’t specifically mentioned in the letter."
                ],
                "tags": [
                    "international",
                    "air"
                ],
                "source": {
                    "sourceType": "GOVERNMENT",
                    "title": "CDC - FAQs",
                    "url": "https://www.cdc.gov/coronavirus/2019-ncov/travelers/testing-international-air-travelers.html"
                },
                "lastCheckedAt": "2021-02-15T00:00:00Z",
                "lastUpdatedAt": "2021-02-15T16:56:00Z",
                "stillCurrentAt": "2021-02-15T00:00:00Z",
                "createdAt": "2021-01-13T01:05:00Z",
                "startDate": "2021-01-26T00:00:00Z",
                "endDate": null,
                "included": [
                    {
                        "isoAlpha3": "AFG",
                        "countryName": "Afghanistan",
                        "type": "COUNTRY",
                        "locationType": "ORIGIN"
                    },
                    {
                        "isoAlpha3": "ALA",
                        "countryName": "Γ…land Islands",
                        "type": "COUNTRY",
                        "locationType": "ORIGIN"
                    }
                ],
                "category": "DOC_REQUIRED",
                "subCategory": "BEFORE_ARRIVAL"
            }
        },
        {
            "id": "79be28d5-85d5-4266-badb-0589c80f083c",
            "type": "PROCEDURE",
            "attributes": {
                "country": "USA",
                "title": "Masks are mandatory on public transportation",
                "description": "Travelers are required to wear masks on public transportation.\n\nTravellers are required to wear masks in public places in some states.",
                "directionality": "MORE",
                "enforcement": "MANDATORY",
                "more": [],
                "tags": [
                    "international",
                    "domestic",
                    "air",
                    "land",
                    "sea"
                ],
                "source": {
                    "sourceType": "GOVERNMENT",
                    "title": "The White House - US Government",
                    "url": "https://www.whitehouse.gov/briefing-room/presidential-actions/2021/01/25/proclamation-on-the-suspension-of-entry-as-immigrants-and-non-immigrants-of-certain-additional-persons-who-pose-a-risk-of-transmitting-coronavirus-disease/"
                },
                "lastCheckedAt": "2021-02-15T00:00:00Z",
                "lastUpdatedAt": "2021-02-15T16:55:00Z",
                "stillCurrentAt": "2021-02-15T00:00:00Z",
                "createdAt": "2020-06-19T14:28:00Z",
                "startDate": "2021-01-21T00:00:00Z",
                "endDate": null,
                "category": "PPE",
                "subCategory": "DOMESTIC"
            }
        },
        {
            "id": "e62b1f47-156d-4bc0-8dda-f8558674a523",
            "type": "PROCEDURE",
            "attributes": {
                "country": "USA",
                "title": "Mandatory travel declaration form",
                "description": "Travelers are required to complete a travel attestation form before departing to the USA. This form will be provided by the airline at check-in.",
                "directionality": "MORE",
                "enforcement": "MANDATORY",
                "documentType": [
                    "TRAVEL_DECLARATION"
                ],
                "documentLinks": [
                    {
                        "url": "https://www.cdc.gov/quarantine/pdf/attachment-a-global-passenger-disclosure-and-attestation-2021-01-12-p.pdf",
                        "type": "DOWNLOAD",
                        "title": "Download PDF"
                    }
                ],
                "more": [],
                "tags": [
                    "international",
                    "air"
                ],
                "source": {
                    "sourceType": "GOVERNMENT",
                    "title": "CDC - FAQs",
                    "url": "https://www.cdc.gov/coronavirus/2019-ncov/travelers/testing-international-air-travelers.html"
                },
                "lastCheckedAt": "2021-02-15T00:00:00Z",
                "lastUpdatedAt": "2021-02-16T01:38:00Z",
                "stillCurrentAt": "2021-02-15T00:00:00Z",
                "createdAt": "2021-01-24T21:40:00Z",
                "startDate": "2021-01-26T00:00:00Z",
                "endDate": null,
                "included": [
                    {
                        "isoAlpha3": "AFG",
                        "countryName": "Afghanistan",
                        "type": "COUNTRY",
                        "locationType": "ORIGIN"
                    },
                    {
                        "isoAlpha3": "ALA",
                        "countryName": "Γ…land Islands",
                        "type": "COUNTRY",
                        "locationType": "ORIGIN"
                    }
                ],
                "category": "DOC_REQUIRED",
                "subCategory": "BEFORE_ARRIVAL"
            }
        }
    ]
}

Updated 2 months ago


πŸ›« Trips


Personalized travel restrictions for every journey.

Suggested Edits are limited on API Reference Pages

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