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

Content is sometimes tagged for additional context in the sherpaยฐ system. Below is the list of currently used tags and their descriptions.

Tag Name

Tag Description

Tag Generation Details

international

Is present when a restriction/procedure applies to an international traveller (one who is crossing an international border to enter the country/region).

Both international and domestic tags can be present, indicating that the restriction/procedure applies to all travellers.

domestic

Is present when a restriction/procedure applies to an domestic traveller (one who is crossing a domestic border to enter the region e.g. across state/subdivision lines).
Both international and domestic tags can be present, indicating that the restriction/procedure applies to all travellers.

air

Tag is present when a restriction/procedure applies to travellers crossing borders by air.

Multiple travel mode tags can be present meaning that the restriction/procedure applies to all of the listed forms of travel

land

Same as travelMode air

sea

Same as travelMode air

transit

The transit tag appears on both restrictions and procedures but can appear from different sources internally.

The tag has the same meaning regardless: "This tag indicates that a restriction/procedure is applicable to travellers transiting through the country."

Procedures: when a procedure is marked as travelPurpose: TRANSIT , this tag will be generated.

Restrictions: Restrictions follow the same tag generation as procedures but includes an additional criteria: when restrictionSubType: TRANSIT is present.

business

This tag indicates that a restriction/procedure is applicable to travellers entering/exiting a country for the given purpose of travel.

All travelPurpose tags are generated based on the procedure logic above.

travelPurpose tags always exist on visa procedures.

The same is not true for other procedures. Unless explicitly defined, these tags do not appear on all procedures and in general can be interpreted as "this procedure applies for all travel purposes" when none appear.

medical

Same as travelPurpose business

tourism

Same as travelPurpose business

fully_vaccinated

Indicates whether a restriction/procedure applies to ONLY fully vaccinated (COVID-19) travellers

This tag is generated when a restriction/procedure is applicable to ONLY fully vaccinated (COVID-19) travellers.

When neither fully_vaccinated or not_vaccinated tags are present, the restriction/procedure can be interpreted as "this applies to everybody regardless of vaccination status"

not_vaccinated

Indicates whether a restriction/procedure applies to ONLY unvaccinated (COVID-19) travellers

This tag is generated when a restriction/procedure is applicable to ONLY unvaccinated (COVID-19) travellers.

When neither fully_vaccinated or not_vaccinated tags are present, the restriction/procedure can be interpreted as "this applies to everybody regardless of vaccination status"

Updated 17 days ago


Tags


Suggested Edits are limited on API Reference Pages

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