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

Deep Linking

Travel Restrictions

Direct the customer to a page listing travel restrictions for their journey.

Travel Restrictions Page

URL https://apply.joinsherpa.com/travel-restrictions/

Destination Page

The traveller will be required to enter their origin when visiting this page.

Format https://apply.joinsherpa.com/travel-restrictions/<<COUNTY_CODE_ISO3>>
Example: https://apply.joinsherpa.com/travel-restrictions/IND

Query Parameters

Query Parameters

Required

Type

Description

affiliateId

Required

String

Your {{affiliateId}}

language

Optional

String

Localize the web app for your users. See supported languages.

originCountry

Required

String

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

nationality

Optional

String

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

tripType

Required

String
roundTrip, oneWay

Whether the trip is one way or round trip.

departureDate

Required

String
YYYY-MM-DD

Default date of the departure

returnDate

Required
if tripType is roundTrip

String
YYYY-MM-DD

Default return date

fullyVaccinated

Optional

Boolean

Default value of vaccination filter

Examples

India Landing Page
https://apply.joinsherpa.com/travel-restrictions/IND?affiliateId=sherpa

One Way Trip from Canada to Turkey
https://apply.joinsherpa.com/travel-restrictions/TUR?affiliateId=sherpa&originCountry=CAN&affiliateId=sherpa

One Way Trip from Canada to Turkey with Canadian Passport
https://apply.joinsherpa.com/travel-restrictions/TUR?affiliateId=sherpa&originCountry=CAN&nationality=CAN&affiliateId=sherpa

Round Trip from Canada to Turkey
https://apply.joinsherpa.com/travel-restrictions/TUR?originCountry=CAN&departureDate=2021-04-30&tripType=roundTrip&language=en-US&returnDate=2021-04-30&affiliateId=sherpa

Round Trip from Spain to India in Spanish
https://apply.joinsherpa.com/travel-restrictions/TUR?originCountry=CAN&departureDate=2021-04-30&tripType=roundTrip&language=es-XL&returnDate=2021-04-30&affiliateId=sherpa

Updated 23 days ago


Deep Linking


Suggested Edits are limited on API Reference Pages

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