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

Offer eVisas After Booking

Present an eVisa offer after on the Confirmation or Manage My Booking Page.

πŸ‘

Benefits of this approach

  • Quickest integration option
  • Fewest resources required

Introduction

Offering eVisas on post booking pages can be as simple as adding our plug & play widget to your confirmation and manage booking pages. The widget will advise travellers of entry requirements and allow them to submit applications on the spot.

Travellers can also be presented with entry requirements based on their itinerary and personal details, and these details can be used to pre-populate their application to make the process as simple as possible.

Typical Booking Flow

Typical Booking flows consist of the following steps, illustrated by the diagram below.

1. Availability
Selection of flight or travel package
2. Traveller Information
Provide traveller name and other personal details
3. Ancillary
Offer ancillary options like insurance
4. Purchase
Enter payment information
5. Confirmation
Display booking confirmation and helpful tips relevant to the journey.

Typical Booking Flow

1. Traveller Information Step

At the travel information step of the booking journey, you should already know the itinerary for the trip. To find out basic travel requirements, you just need to collect the nationality of the traveller.

If there are multiple travellers, just query the database for each traveller separately.
For example, get travel document requirements for Canadian travelling to Turkey.
The response provide Entry Requirement Information under the "visa" section.

curl -X GET \
  '{{api-endpoint}}/v2/entry-requirements?destination=TR&citizenship=CA&key={{api-private-key}}' \
{
    "visa": [
        {
            "allowed_stay": "3 months",
            "citizenship_destination_ID_type": "CA_TR_tourist",
            "notes": [
                "Cruise ship passengers cruising in and out of a Turkish port within a single day do not require a tourist visa."
            ],
            "requirement": "E_VISA",
            "type": "tourism",
            "textual": {
                "class": "warning",
                "text": [
                    "You need a visa.",
                    "You should get an eVisa.",
                    "An eVisa is delivered electronically, and can be obtained online before travelling to Turkey."
                ]
            },
            "available": true,
            "availableVisas": [
                {
                    "applicationCode": "TR_EVISA_0001",
                    "name": "Turkish eVisa",
                    "productRedirectUrl": "https://apply.joinsherpa.com/visa/CA/TR/TR_EVISA_0001"
                }
            ]
        }
    ],
    "passport": {
        "blank_pages": "ONE_PER_ENTRY",
        "passport_validity": "SIX_MONTHS_AT_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": {
        "recommended": [
            {
                "type": "YELLOW_FEVER"
            }
        ],
        "risk": [
            {
                "type": "TICK_BORNE_ENCEPHALITIS"
            },
            {
                "type": "MALARIA"
            }
        ]
    }
}

You can display the response as an alert during the booking flow. The severity or the alert can vary, based on the requirement needed for the trip.

Alert Examples

2. Confirmation Screen

Present the traveller with options to purchase the Electronic Entry Requirement or offer them to check status of their Entry Requirement.

🚧

Check whether or not a country is currently issuing eVisas

Due to COVID-19, some countries have suspended or restricted their eVisa programs. Use the visaStatus attribute to determine a program's current status.

curl -X GET \
  '{{submission-api-url}}/v1/products?key={{apiKey}}&destinations=TUR&nationality=GBR&language=en&currency=GBP' \
[
    {
        "type": "product",
        "eerType": "E_VISA",
        "attributes": [
            "nationalities"
        ],
        "price": {
            "currency": "EUR",
            "value": 28.63
        },
        "validityStart": [
            "APPROVAL"
        ],
        "destinations": [
            "TUR"
        ],
        "travelPurpose": [
            "TOURISM",
            "BUSINESS_VISITOR"
        ],
        "pricebreakdown": [
            {
                "type": "GOVERNMENT_FEE",
                "price": {
                    "currency": "EUR",
                    "value": 18.17
                }
            },
            {
                "type": "GOVERNMENT_PROCESSING_FEE",
                "price": {
                    "value": 1.37,
                    "currency": "EUR"
                }
            },
            {
                "type": "APPLICATION_SERVICE_FEE",
                "price": {
                    "currency": "EUR",
                    "value": 9.09
                }
            }
        ],
        "validity": [
            "180 days"
        ],
        "lengthOfStay": [
            "90 days"
        ],
        "processingTime": [
            "INSTANT"
        ],
        "createdAt": "2019-09-27T19:35:20.145Z",
        "nationalities": [
            "ATG",
            "AUT",
            "BHS",
            "BRB",
            "BEL",
            "HRV",
            "DMA",
            "DOM",
            "HTI",
            "IRL",
            "JAM",
            "MDV",
            "NLD",
            "NOR",
            "POL",
            "LCA",
            "VCT",
            "ESP",
            "USA",
            "GBR"
        ],
        "programId": "TUR_EVISA",
        "productId": "TUR_EVISA__20_90DAYS",
        "numberOfEntries": [
            "MULTIPLE"
        ],
        "hasVariants": false,
        "meta": {
            "text": "You’ll need a visa to travel to the Land of the Crescent Moon, and an electronic visa is the easiest option. You can enter Turkey multiple times using this eVisa, and stay for up to 90 days each time you enter. The application process is entirely online, and there's no need to send any documentation to the embassy.",
            "name": "Turkish eVisa"
        }
    }
]

Using the "Get Electronic Requirements" call, retrieve available eVisas and eTAs for this trip. The response provides an array of options. Options can differ by purpose(business vs tourism), validity(single entry, multiple entry, etc.).

The call also provides a product redirect URL for easy referral to Sherpa's platform.

πŸ‘

Checkout Options

Sherpa offers white label websites and embeddable widgets for partners.

Updated 3 months ago


What's Next

Widget
SDK

Offer eVisas After Booking


Present an eVisa offer after on the Confirmation or Manage My Booking Page.

Suggested Edits are limited on API Reference Pages

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