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

eVisa & Documents

Retrieve visa, passport and vaccination requirements

Lets retrieve entry requirements for the traveller's journey based on their destination and nationality.

Using a single API call, you can retrieve visa requirements, passport requirements, transit requirements, available currency restrictions and vaccination advisory.

1. Retrieving Information

Let's check documents for a Canadian (CAN) traveller heading to Turkey (TUR). The code sample below shows the request, and a corresponding response.

{
    "visa": [
        {
            "country2": "TR",
            "allowedStay": "3 months",
            "allowed_stay": "3 months",
            "allowedStayInDays": 91,
            "requirement": "E_VISA",
            "notes": [
                "Cruise ship passengers cruising in and out of a Turkish port within a single day do not require a tourist visa."
            ],
            "type": "tourism",
            "portRestriction": true,
            "textual": {
                "class": "warning",
                "text": [
                    "You need a visa.",
                    "You may be eligible for an eVisa for your trip.",
                    "An eVisa is delivered electronically, and can be obtained online before your trip to Turkey."
                ]
            },
            "available": true,
            "availableVisas": [
                {
                    "applicationCode": "TUR_EVISA__60_90DAYS",
                    "name": "Turkish eVisa",
                    "productRedirectUrl": "https://apply.joinsherpa.com/explore/CAN/TUR"
                }
            ],
            "alerts": []
        }
    ],
    "passport": {
        "passport_validity": "SIX_MONTHS_AT_ENTRY",
        "blank_pages": "ONE_PER_ENTRY",
        "textual": {
            "passport_validity": {
                "class": "warning",
                "text": [
                    "Valid for 6 months at the time of entry.",
                    "Your passport must be valid for six months at the time you enter Turkey."
                ]
            },
            "blank_pages": {
                "class": "warning",
                "text": [
                    "One blank page per entry.",
                    "Your passport must have one blank page per entry."
                ]
            }
        }
    },
    "currency": {
        "exit": "25,000 Turkish lira or 10,000 euros (or equivalent)"
    },
    "vaccination": {
        "risk": [
            {
                "type": "TICK_BORNE_ENCEPHALITIS"
            },
            {
                "type": "MALARIA"
            }
        ],
        "recommended": [
            {
                "type": "YELLOW_FEVER"
            }
        ]
    }
}
curl -X GET \
  'https://requirements-api.joinsherpa.com/v2/entry-requirements?destination=TUR&citizenship=CAN&key=<<requirementsApiKeyProduction>>'

Congratulations! πŸ™Œ Now, you just you can display this information on your website or platform.

2. Presenting Information

Visas
visa contains visa information in an array format, and lists various visa documents that could be used for the provided itinerary. Here are some key pieces of information that you should present to your passengers.

Key

Type

Description

textual

object

Provides information about the visa.
Use class to decorate your response.

available

boolean

Is this visa available for purchase through Sherpa.

availableVisas

array

List of visas available through Sherpa. Refer your customers to Sherpa using productRedirectUrl.

An example of response presentation.

πŸ‘

Next: Applying for a visa

Direct the customer to Sherpa's online platform, or use the SDK to open the Visa Application Experience in a modal window on your site.

Updated 6 days ago



eVisa & Documents


Retrieve visa, passport and vaccination requirements

Suggested Edits are limited on API Reference Pages

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