Requirements API 2.7.4
An exciting new update to introduce two new locales for our English-speaking audience while making it even easier for you to use our API!
💬 New language locales for English Canada and United Kingdom available
English, Canada en-CA as well as English, United Kingdom en-GB.
Have a look at our Language Support Guide to learn more and see a list of all supported languages and locales.
✨ New Document Type HEALTH_PASS
HEALTH_PASSAs the world is opening up for more travellers who are fully vaccinated, new forms of documentation started to emerge. We've added a new document type called HEALTH_PASS which covers various types of COVID-19 related certificates or passports.
The below example shows the newly introduced "Digital COVID Certificate" for public activity in Estonia (as of August 26th, 2021):
{
"id": "087fbdc7-8103-45dc-b92c-43b9b52d104a",
"type": "PROCEDURE",
"attributes": {
"country": "EST",
"title": "Mandatory Digital COVID Certificates for public activity",
"description": "Travelers over the age of 18 must have a valid Digital COVID Certificate ...",
"directionality": "MORE",
"enforcement": "MANDATORY",
"documentType": [
"HEALTH_PASS" // <----- New documentType HEALTH_PASS
],
"documentLinks": [],
"more": [],
"tags": [
"international",
"domestic",
"air"
],
"source": {
"sourceType": "GOVERNMENT",
"title": "Estonian Health Board",
"url": "https://www.terviseamet.ee/en/digital-covid-certificate"
},
"lastCheckedAt": "2021-08-260T00:00:00.000Z",
"lastUpdatedAt": "2021-08-26T06:13:00.000Z",
"stillCurrentAt": "2021-08-26T00:00:00.000Z",
"createdAt": "2021-08-25T17:33:56.000Z",
"startDate": "2021-08-26T00:00:00.000Z",
"endDate": null,
"included": [
],
"category": "DOC_REQUIRED",
"subCategory": "ON_ARRIVAL"
}
}
🙅♂️ Deprecating attributes in the /v2/trips response
/v2/trips responseAttributes marked as "deprecated" will be removed
We are planning to remove the listed attributes with our planned release v2.8.0 which is currently scheduled for Wednesday, October 6th, 2021.
Pending our internal timeline and tests, this date might change. Please ensure that you adjust your system to take advantage of the changes in your applications.
We have taken the various inputs from all of you and are improving the API response from the v2/trips endpoint to make it simpler and more convenient to use on the front end.
We are introducing "Summary Groupings" as a new form to aggregate various restrictions and procedures in a meaningful way.
The following attributes from the v2/trips endpoint response will be removed in a future update, to be replaced by the Summary Groupings:
Example response with highlight of deprecated attributes
| Deprecated attribute | Grouping type to use instead |
|---|---|
entryRestrictions | DESTINATION_TRAVEL_RESTRICTIONS |
exitRestrictions | ORIGIN_TRAVEL_RESTRICTIONS |
travelRestrictions | ORIGIN_TRAVEL_RESTRICTIONS +DESTINATION_TRAVEL_RESTRICTIONS |
transitRestrictions | DESTINATION_TRAVEL_RESTRICTIONS |
documents | ORIGIN_DOCUMENTS +DESTINATION_DOCUMENTS |
To provide you with a more generic and expandable alternative, we've introduced "groupings" under the summary attribute to allow you to more easily access pre-defined groupings of restrictions and procedures that are useful to travellers.
Summary Groupings is in beta
We love hearing your feedback! We are adapting our API to the constant global changes around travel rules to provide you with the most up-to-date and personalized information.
In addition, we have the following grouping types that will be *removed permanently as information will be available through other grouping types. You'll notice that we simplified the groupings overall and are providing all high-value information separated into what you need to know when leaving via ORIGIN_TRAVEL_RESTRICTIONS as well as everything you need to know when entering via DESTINATION_TRAVEL_RESTRICTIONS. Documents follow the same pattern.
| Grouping type deprecated | Grouping type to use |
|---|---|
TRAVEL_RESTRICTIONS | DESTINATION_TRAVEL_RESTRICTIONS +ORIGIN_TRAVEL_RESTRICTIONS |
ENTRY_RESTRICTIONS | DESTINATION_TRAVEL_RESTRICTIONS |
EXIT_RESTRICTIONS | ORIGIN_TRAVEL_RESTRICTIONS |
DOC_REQUIRED | ORIGIN_DOCUMENTS +DESTINATION_DOCUMENTS |
COVID_19_TEST | DESTINATION_TRAVEL_RESTRICTIONS +ORIGIN_TRAVEL_RESTRICTIONS |
QUARANTINE | DESTINATION_TRAVEL_RESTRICTIONS +ORIGIN_TRAVEL_RESTRICTIONS |
TRANSIT_RESTRICTIONS | DESTINATION_TRAVEL_RESTRICTIONS +ORIGIN_TRAVEL_RESTRICTIONS |
{
"meta": {
"copyright": "Sherpa",
"version": "2.7.4"
},
"data": {
"id": "95465790-090e-11ec-9fae-cd35dbaa4a89",
"type": "TRIP",
"attributes": {
"category": "ROUND_TRIP",
"segments": [
{
"segmentType": "OUTBOUND",
"segmentSubType": "TRANSIT",
"origin": {
"regionCode": "CA-BC",
"regionName": "British Columbia",
"countryCode": "CAN",
"countryName": "Canada",
"airportCode": "YVR",
"airportName": "Vancouver"
},
"destination": {
"regionCode": "CA-ON",
"regionName": "Ontario",
"countryCode": "CAN",
"countryName": "Canada",
"airportCode": "YYZ",
"airportName": "Toronto"
},
"departureDate": "2021-08-28T20:37:30.442Z",
"departureTime": "00:00",
"arrivalDate": "2021-08-28T20:37:30.442Z",
"arrivalTime": "00:00",
"travelMode": "AIR",
"borderCrossing": "REGIONAL",
"summary": {
"headline": "We currently have no information for this trip.",
"travelOpenness": "LEVEL_1",
"groupings": [ // <----- Summary Groupings
{
"type": "ORIGIN_TRAVEL_RESTRICTIONS",
"label": "MANDATORY_ORIGIN_TRAVEL_RESTRICTIONS",
"enforcement": "MANDATORY",
"included": []
},
{
"type": "ORIGIN_DOCUMENTS",
"label": "MANDATORY_ORIGIN_DOCUMENTS",
"enforcement": "MANDATORY",
"included": []
},
{
"type": "DESTINATION_TRAVEL_RESTRICTIONS",
"label": "NOT_REQUIRED_DESTINATION_TRAVEL_RESTRICTIONS",
"enforcement": "NOT_REQUIRED",
"included": [
{
"id": "generated-procedure-unknown-covid"
}
]
},
{
"type": "DESTINATION_DOCUMENTS",
"label": "MANDATORY_DESTINATION_DOCUMENTS",
"enforcement": "MANDATORY",
"included": []
},
{
"type": "LOCAL_RESTRICTIONS",
"label": "MANDATORY_LOCAL_RESTRICTIONS",
"enforcement": "MANDATORY",
"included": []
},
{
"type": "UPCOMING",
"label": "MANDATORY_UPCOMING",
"enforcement": "MANDATORY",
"included": []
}
]
}
},
🙅♂️ Deprecating attributes in restrictions, procedures, countries and regions
Thanks to the feedback we've received, we'll be removing several attributes from our data model for restrictions and procedures as they're no longer as helpful as we intended them to be. To avoid a lot of confusion and to keep the data returned simple and understandable, we'll be deprecating the below attributes which will be removed in a future update.
We have seen extremely low utilization and engagement with the attributes listed and hope that the reduction of complexity will make the API even more useful while allowing travellers to focus on the relevant information.
What if my solution relies on these attributes?
Please reach out to your account manager so we can understand your use case.
| Deprecated attribute | Type | Description |
|---|---|---|
lastCheckedAt | RESTRICTON, PROCEDURE, COUNTRY, REGION | The timestamp of the last time our system or operations team checked this type. |
stillCurrentAt | RESTRICTON, PROCEDURE, COUNTRY, REGION | The timestamp of the last time our system or operations team verified that this type is still applicable. |
visaStatus | COUNTRY | Indicating if a country is offering an eVisa, eTA or Embassy visa. |
entryStatus | COUNTRY | Showing the general entry status of a country. This information is highly contextual and a more personalized information can be obtained through the v2/trips endpoint or specific restrictions. |
exitStatus | COUNTRY | Showing the general exit status of a country. This information is highly contextual and a more personalized information can be obtained through the v2/trips endpoint or specific restrictions. |
directionality | RESTRICTON, PROCEDURE | Indicating if a procedure or restriction resulted in a more or less restricted change. |
defaultDurationInDays [This field will be preserved and not deprecated as originally planned based on feedback.] | PROCEDURE | Shows the duration in days that a procedure e.g. quarantine is applicable. |
durationInDays | PROCEDURE | List of applicable durations of a procedure. E.g. 7 day quarantine with a COVID-19 test or 10 days without. |
durationReductionMeasures | PROCEDURE | List of measures that can reduce a procedure e.g. days to quarantine |
durationExtensionMeasures | PROCEDURE | List of measures that can extend a procedure e.g. days to add to a quarantine |
enforcementConditions | PROCEDURE | List of conditions on how a procedure is being enforced |
alternativeMeasures | PROCEDURE | List of alternative measures that can be taken in lieu of the procedure e.g. provide a negative COVID-19 test in lieu of quarantine |
Category Changes
Categories for Procedures and Restrictions will change
We are planning to reduce the complex combinations of categories and sub-categories for restrictions and procedures. The changes are currently scheduled for Wednesday, October 6th, 2021.
Pending our internal timeline and tests, this date might change. Please ensure you adjust your system to take advantage of the changes in your clients and applications.
See a comprehensive list of our revised category changes in our dedicated changelog: https://docs.joinsherpa.io/changelog/procedure-category-changes
See it in action
Check out the Travel rules for your trip guide and learn how to use the API.