added

Requirements API v.2.8.4

Translation for COVID test type & conditions for testWindow now live

❗️

/trips endpoint only

Please note the above change is for the /trips endpoint only

📘

Translation for hours

We do not provide translation for hours. We do not offer single word translations for durations but include translations when we have number values.

A dedicated label attribute has been introduced to help translate the test window values.

Version 2.8.3 attribute

"testWindow" : [{
                        "condition": "BEFORE_DEPARTURE",
                        "type": "HOURS",
                        "value": 72,
                        "text": "72 hours",
                        "medicalRequirementType": "PCR_TEST"
                }]

New updated 2.8.4 attribute

"testWindow" : [
  {
    "condition": "BEFORE_DEPARTURE",
    "type": "HOURS",
    "value": 72,
    "text": "72 hours",
    "medicalRequirementType": "PCR_TEST"
  }
],
"labels":{
  "BEFORE_DEPARTURE":"Before departure",
  "PCR_TEST":"PCR Test"
}

Below is a sample request and response of a traveller going one way from the USA to Japan and fully_vaccinated.

https://www.requirements-api.sandbox.joinsherpa.com/v2/trips?affiliateId=sherpa&key={{apiKey}}&language=es-XL&include=restriction,procedure
{
    "meta": {
        "copyright": "Sherpa",
        "version": "2.8.3"
    },
    "data": {
        "id": "77aebd17-f0ad-4e82-a9a0-e43f488c0d68",
        "type": "TRIP",
        "attributes": {
            "category": "ONE_WAY_TRIP",
            "segments": [
                {
                    "segmentType": "OUTBOUND",
                    "origin": {
                        "countryCode": "USA",
                        "countryName": "Estados Unidos"
                    },
                    "destination": {
                        "countryCode": "JPN",
                        "countryName": "Japón"
                    },
                    "departureDate": "2021-07-27T00:00:00.000Z",
                    "departureTime": "12:59",
                    "arrivalDate": "2021-07-27T00:00:00.000Z",
                    "arrivalTime": "12:59",
                    "borderCrossing": "INTERNATIONAL",
                    "summary": {
                        "headline": "La mayoría de los pasajeros de Estados Unidos con comprobante de vacunación contra la COVID-19 completa pueden ingresar a Japón, pero existen restricciones.",
                        "travelOpenness": "LEVEL_2",
                        "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": "MANDATORY_DESTINATION_TRAVEL_RESTRICTIONS",
                                "enforcement": "MANDATORY",
                                "included": [
                                    {
                                        "id": "12ef60b1-dbbc-41ca-ab5f-3e9a9335512d"
                                    }
                                ]
                            },
                            {
                                "type": "DESTINATION_DOCUMENTS",
                                "label": "MANDATORY_DESTINATION_DOCUMENTS",
                                "enforcement": "MANDATORY",
                                "included": [
                                    {
                                        "id": "ee8fde0e-a5e1-4b80-8da6-fcb970b2a892"
                                    },
                                    {
                                        "id": "fe2580ab-04f4-44aa-b69c-09aeff09be9e"
                                    },
                                    {
                                        "id": "fa2cadc8-463d-44db-bfa0-730e0fee3633"
                                    },
                                    {
                                        "id": "560ce9c4-c3cf-4b71-b283-5c4b5ff5dadc"
                                    }
                                ]
                            },
                            {
                                "type": "LOCAL_RESTRICTIONS",
                                "label": "RECOMMENDED_LOCAL_RESTRICTIONS",
                                "enforcement": "RECOMMENDED",
                                "included": [
                                    {
                                        "id": "4f3caaca-a303-4480-8470-5261cff07786"
                                    }
                                ]
                            },
                            {
                                "type": "UPCOMING",
                                "label": "MANDATORY_UPCOMING",
                                "enforcement": "MANDATORY",
                                "included": []
                            },
                            {
                                "type": "VISAS",
                                "label": "No se requiere visa",
                                "enforcement": "NOT_REQUIRED",
                                "included": [
                                    {
                                        "id": "a3fea418-4b0f-4a9b-ab1d-e0fbddd2aa98"
                                    }
                                ]
                            }
                        ]
                    }
                }
            ],
            "summary": [
                {
                    "type": "COVID_19_TEST",
                    "headline": "Se requiere prueba de COVID-19 para uno o varios tramos de tu viaje. A continuación, se detalla más información.",
                    "enforcement": "MANDATORY"
                },
                {
                    "type": "QUARANTINE",
                    "headline": "No se requiere cuarentena",
                    "enforcement": "MAY_BE_REQUIRED"
                },
                {
                    "type": "DOC_REQUIRED",
                    "headline": "Se requieren documentos para uno o varios tramos de tu viaje. A continuación, se detalla más información.",
                    "enforcement": "MANDATORY"
                },
                {
                    "type": "VISA",
                    "headline": "No se requiere visa",
                    "enforcement": "NOT_REQUIRED"
                }
            ],
            "outbound": {
                "segmentType": "OUTBOUND",
                "origin": {
                    "countryCode": "USA",
                    "countryName": "Estados Unidos"
                },
                "destination": {
                    "countryCode": "JPN",
                    "countryName": "Japón"
                },
                "departureDate": "2021-07-27T00:00:00.000Z",
                "departureTime": "12:59",
                "arrivalDate": "2021-07-27T00:00:00.000Z",
                "arrivalTime": "12:59",
                "borderCrossing": "INTERNATIONAL",
                "summary": {
                    "headline": "La mayoría de los pasajeros de Estados Unidos con comprobante de vacunación contra la COVID-19 completa pueden ingresar a Japón, pero existen restricciones.",
                    "travelOpenness": "LEVEL_2",
                    "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": "MANDATORY_DESTINATION_TRAVEL_RESTRICTIONS",
                            "enforcement": "MANDATORY",
                            "included": [
                                {
                                    "id": "12ef60b1-dbbc-41ca-ab5f-3e9a9335512d"
                                }
                            ]
                        },
                        {
                            "type": "DESTINATION_DOCUMENTS",
                            "label": "MANDATORY_DESTINATION_DOCUMENTS",
                            "enforcement": "MANDATORY",
                            "included": [
                                {
                                    "id": "ee8fde0e-a5e1-4b80-8da6-fcb970b2a892"
                                },
                                {
                                    "id": "fe2580ab-04f4-44aa-b69c-09aeff09be9e"
                                },
                                {
                                    "id": "fa2cadc8-463d-44db-bfa0-730e0fee3633"
                                },
                                {
                                    "id": "560ce9c4-c3cf-4b71-b283-5c4b5ff5dadc"
                                }
                            ]
                        },
                        {
                            "type": "LOCAL_RESTRICTIONS",
                            "label": "RECOMMENDED_LOCAL_RESTRICTIONS",
                            "enforcement": "RECOMMENDED",
                            "included": [
                                {
                                    "id": "4f3caaca-a303-4480-8470-5261cff07786"
                                }
                            ]
                        },
                        {
                            "type": "UPCOMING",
                            "label": "MANDATORY_UPCOMING",
                            "enforcement": "MANDATORY",
                            "included": []
                        },
                        {
                            "type": "VISAS",
                            "label": "No se requiere visa",
                            "enforcement": "NOT_REQUIRED",
                            "included": [
                                {
                                    "id": "a3fea418-4b0f-4a9b-ab1d-e0fbddd2aa98"
                                }
                            ]
                        }
                    ]
                },
                "segmentSubType": "CONTEXT"
            }
        },
        "relationships": {
            "restrictions": {
                "meta": {
                    "count": 0
                },
                "data": []
            },
            "procedures": {
                "meta": {
                    "count": 7
                },
                "data": [
                    {
                        "id": "12ef60b1-dbbc-41ca-ab5f-3e9a9335512d",
                        "type": "PROCEDURE"
                    },
                    {
                        "id": "560ce9c4-c3cf-4b71-b283-5c4b5ff5dadc",
                        "type": "PROCEDURE"
                    },
                    {
                        "id": "ee8fde0e-a5e1-4b80-8da6-fcb970b2a892",
                        "type": "PROCEDURE"
                    },
                    {
                        "id": "fa2cadc8-463d-44db-bfa0-730e0fee3633",
                        "type": "PROCEDURE"
                    },
                    {
                        "id": "fe2580ab-04f4-44aa-b69c-09aeff09be9e",
                        "type": "PROCEDURE"
                    },
                    {
                        "id": "4f3caaca-a303-4480-8470-5261cff07786",
                        "type": "PROCEDURE"
                    },
                    {
                        "id": "a3fea418-4b0f-4a9b-ab1d-e0fbddd2aa98",
                        "type": "PROCEDURE"
                    }
                ]
            }
        }
    },
    "included": [
        {
            "id": "12ef60b1-dbbc-41ca-ab5f-3e9a9335512d",
            "type": "PROCEDURE",
            "attributes": {
                "country": "JPN",
                "title": "Prueba de COVID-19 obligatoria al llegar",
                "description": "Todos los pasajeros, incluidos los ciudadanos japoneses, deben realizarse una prueba PCR de COVID-19 al llegar. ",
                "more": [],
                "enforcement": "MANDATORY",
                "severity": 3,
                "documentLinks": [],
                "medicalRequirementType": [
                    "PCR_TEST"
                ],
                "tags": [
                    "international",
                    "air",
                    "land",
                    "sea"
                ],
                "source": {
                    "sourceType": "GOVERNMENT",
                    "title": "Ministerio de Relaciones Exteriores de Japón",
                    "url": "https://www.mofa.go.jp/ca/fna/page4e_001053.html"
                },
                "lastUpdatedAt": "2022-04-01T11:00:00.000Z",
                "createdAt": "2021-01-09T21:54:00.000Z",
                "startDate": "2021-01-08T00:00:00.000Z",
                "endDate": null,
                "category": "COVID_19_TEST",
                "subCategory": "ON_ARRIVAL"
            }
        },
        {
            "id": "560ce9c4-c3cf-4b71-b283-5c4b5ff5dadc",
            "type": "PROCEDURE",
            "attributes": {
                "country": "JPN",
                "title": "Cuestionario de cuarentena obligatorio",
                "description": "Los pasajeros deben completar un formulario de cuarentena, uno por persona, y presentar el código QR al llegar. Los formularios en papel también están disponibles en el aeropuerto. ",
                "more": [],
                "enforcement": "MANDATORY",
                "documentType": [
                    "QUARANTINE_FORM"
                ],
                "documentLinks": [
                    {
                        "type": "LINK",
                        "url": "https://arqs-qa.followup.mhlw.go.jp/",
                        "title": "Completar en línea"
                    }
                ],
                "tags": [
                    "international",
                    "air",
                    "land",
                    "sea"
                ],
                "source": {
                    "sourceType": "GOVERNMENT",
                    "title": "Ministerio de Relaciones Exteriores de Japón",
                    "url": "https://www.mofa.go.jp/mofaj/ca/fna/page25_001994.html"
                },
                "lastUpdatedAt": "2022-04-01T10:59:00.000Z",
                "createdAt": "2021-02-22T13:58:00.000Z",
                "startDate": null,
                "endDate": null,
                "category": "DOC_REQUIRED",
                "subCategory": "BEFORE_ARRIVAL"
            }
        },
        {
            "id": "ee8fde0e-a5e1-4b80-8da6-fcb970b2a892",
            "type": "PROCEDURE",
            "attributes": {
                "country": "JPN",
                "title": "Se requieren resultados negativos de una prueba COVID-19 realizada antes de la salida",
                "description": "Los viajeros deben tener un resultado negativo de la prueba COVID-19 (RT-PCR, LAMP, TMA, TRC, Smart Amp, NEAR, secuencia de próxima generación o CLEIA) negativo. La prueba deberá realizarse un máximo de 72 horas antes de la salida. La prueba debe realizarse mediante un hisopo nasofaríngeo, una muestra de saliva o una combinación de hisopos nasofaríngeos y orofaríngeos. \nTambién se aceptan pruebas de hisopo nasal como especímenes válidos para la prueba previa a la salida. \n\nEsto incluye a ciudadanos japoneses, Business Track y viajeros de Residence Track.\n\nSe aceptan pruebas cuantitativas de antígeno COVID-19, sin embargo, por favor revise la fuente para verificar el formato válido para el certificado de resultados negativos. ",
                "more": [
                    "Los resultados de la prueba deben tener un nombre, número de pasaporte, nacionalidad, fecha de nacimiento, sexo, método de prueba, resultado de la prueba, fecha y hora de recolección de la muestra, fecha de determinación del resultado de la prueba, fecha de emisión del certificado de prueba, nombre de la institución médica, dirección, sello de la institución médica o firma en inglés. "
                ],
                "enforcement": "MANDATORY",
                "severity": 3,
                "documentType": [
                    "COVID_TEST_RESULT"
                ],
                "documentLinks": [
                    {
                        "type": "DOWNLOAD",
                        "url": "https://www.mofa.go.jp/mofaj/files/100177968.pdf",
                        "title": "Descargar archivo"
                    }
                ],
                "medicalRequirementType": [
                    "RT_PCR_TEST",
                    "LAMP_TEST",
                    "TMA_TEST"
                ],
                "testWindow": [
                    {
                        "value": 72,
                        "condition": "BEFORE_DEPARTURE",
                        "type": "HOURS",
                        "text": "72 horas",
                        "medicalRequirementType": "RT_PCR_TEST"
                    },
                    {
                        "value": 72,
                        "condition": "BEFORE_DEPARTURE",
                        "type": "HOURS",
                        "text": "72 horas",
                        "medicalRequirementType": "LAMP_TEST"
                    },
                    {
                        "value": 72,
                        "condition": "BEFORE_DEPARTURE",
                        "type": "HOURS",
                        "text": "72 horas",
                        "medicalRequirementType": "TMA_TEST"
                    }
                ],
                "labels": {
                    "RT_PCR_TEST": "Prueba RT-PCR",
                    "BEFORE_DEPARTURE": "antes de salir",
                    "LAMP_TEST": "Prueba LAMP",
                    "TMA_TEST": "Prueba de TMA"
                },
                "tags": [
                    "international",
                    "air"
                ],
                "source": {
                    "sourceType": "GOVERNMENT",
                    "title": "Ministerio de Relaciones Exteriores de Japón",
                    "url": "https://www.mofa.go.jp/mofaj/ca/fna/page25_001994.html"
                },
                "lastUpdatedAt": "2022-04-01T10:59:00.000Z",
                "createdAt": "2021-01-09T21:51:00.000Z",
                "startDate": "2021-01-13T00:00:00.000Z",
                "endDate": null,
                "category": "DOC_REQUIRED",
                "subCategory": "BEFORE_ARRIVAL"
            }
        },
        {
            "id": "fa2cadc8-463d-44db-bfa0-730e0fee3633",
            "type": "PROCEDURE",
            "attributes": {
                "country": "JPN",
                "title": "Aplicación obligatoria de monitoreo de salud y localización",
                "description": "Todos los viajeros deben descargar la aplicación de Monitoreo de Salud y Ubicación (MySOS) y registrarse en la aplicación. Los viajeros deben confirmar la ubicación y reportar las condiciones de salud a través de la aplicación MySOS.",
                "more": [],
                "enforcement": "MANDATORY",
                "documentType": [
                    "MOBILE_APP"
                ],
                "documentLinks": [
                    {
                        "type": "LINK",
                        "url": "https://play.google.com/store/apps/details?id=net.allm.mysos&hl=en ",
                        "title": "Obtener la aplicación Android"
                    },
                    {
                        "type": "LINK",
                        "url": "https://apps.apple.com/jp/app/mysos/id971663851?l=en ",
                        "title": "Obtener la aplicación IOS"
                    }
                ],
                "tags": [
                    "international",
                    "air",
                    "land"
                ],
                "source": {
                    "sourceType": "GOVERNMENT",
                    "title": "Secretaría de Salud, Trabajo y Bienestar de Japón",
                    "url": "https://www.hco.mhlw.go.jp/manual/pdf-en/summary.pdf"
                },
                "lastUpdatedAt": "2022-04-01T11:00:00.000Z",
                "createdAt": "2022-02-24T12:35:00.000Z",
                "startDate": null,
                "endDate": null,
                "category": "DOC_REQUIRED",
                "subCategory": "ON_ARRIVAL"
            }
        },
        {
            "id": "fe2580ab-04f4-44aa-b69c-09aeff09be9e",
            "type": "PROCEDURE",
            "attributes": {
                "country": "JPN",
                "title": "Compromiso por escrito obligatorio",
                "description": "Todos los ciudadanos japoneses y extranjeros con un estado de residencia que viajen a Japón deben comprometerse a seguir medidas de salud específicas y proporcionar su información de contacto. ",
                "more": [],
                "enforcement": "MANDATORY",
                "documentType": [
                    "TRAVEL_DECLARATION"
                ],
                "documentLinks": [
                    {
                        "type": "DOWNLOAD",
                        "url": "https://www.mhlw.go.jp/content/000863646.pdf",
                        "title": "Descargar PDF"
                    }
                ],
                "tags": [
                    "international",
                    "air"
                ],
                "source": {
                    "sourceType": "GOVERNMENT",
                    "title": "Ministerio de Relaciones Exteriores de Japón",
                    "url": "https://www.mofa.go.jp/ca/cp/page22e_000925.html"
                },
                "lastUpdatedAt": "2022-04-01T10:59:00.000Z",
                "createdAt": "2021-01-14T16:48:00.000Z",
                "startDate": "2021-01-14T00:00:00.000Z",
                "endDate": null,
                "category": "DOC_REQUIRED",
                "subCategory": "ON_ARRIVAL"
            }
        },
        {
            "id": "4f3caaca-a303-4480-8470-5261cff07786",
            "type": "PROCEDURE",
            "attributes": {
                "country": "JPN",
                "title": "Se recomienda usar mascarilla en espacios públicos",
                "description": "Se recomienda a los pasajeros que usen mascarilla en lugares públicos. ",
                "more": [],
                "enforcement": "RECOMMENDED",
                "documentLinks": [],
                "tags": [
                    "international",
                    "domestic",
                    "air"
                ],
                "source": {
                    "sourceType": "GOVERNMENT",
                    "title": "Turismo de Japón",
                    "url": "https://www.japan.travel/en/coronavirus/"
                },
                "lastUpdatedAt": "2022-04-01T11:02:00.000Z",
                "createdAt": "2020-06-18T17:49:00.000Z",
                "startDate": "2020-03-01T00:00:00.000Z",
                "endDate": null,
                "category": "PPE",
                "subCategory": "DOMESTIC"
            }
        },
        {
            "id": "a3fea418-4b0f-4a9b-ab1d-e0fbddd2aa98",
            "type": "PROCEDURE",
            "attributes": {
                "country": "JPN",
                "title": "Se suspenden los viajes sin visa",
                "description": "Actualmente los viajes sin visa están suspendidos debido a la pandemia de COVID-19. \nNormalmente, no se requeriría una visa para visitar Japón para Turismo.\n\nVisita el sitio web del gobierno para obtener más detalles.",
                "more": [],
                "enforcement": "NOT_REQUIRED",
                "documentType": [
                    "VISA"
                ],
                "documentLinks": [],
                "tags": [
                    "international",
                    "land",
                    "air",
                    "sea",
                    "tourism",
                    "business"
                ],
                "source": {
                    "sourceType": "GOVERNMENT",
                    "title": "Ministerio de Relaciones Exteriores de Japón",
                    "url": "https://www.mofa.go.jp/j_info/visit/visa/short/novisa.html"
                },
                "lastUpdatedAt": "2022-03-04T21:36:00.000Z",
                "createdAt": "2022-02-03T14:44:00.000Z",
                "startDate": null,
                "endDate": null,
                "lengthOfStay": [
                    {
                        "value": 14,
                        "type": "DAYS",
                        "text": "14 days"
                    }
                ],
                "travelPurpose": [
                    "TOURISM",
                    "BUSINESS"
                ],
                "included": [
                    {
                        "code": "CAN",
                        "text": "Canadá",
                        "type": "NATIONALITY"
                    },
                    {
                        "code": "USA",
                        "text": "Estados Unidos",
                        "type": "NATIONALITY"
                    },
                    {
                        "code": "MKD",
                        "text": "macedonio",
                        "type": "NATIONALITY"
                    },
                    {
                        "code": "SRB",
                        "text": "Serbia",
                        "type": "NATIONALITY"
                    },
                    {
                        "code": "CHL",
                        "text": "Chile",
                        "type": "NATIONALITY"
                    },
                    {
                        "code": "TUR",
                        "text": "Turquía",
                        "type": "NATIONALITY"
                    },
                    {
                        "code": "MUS",
                        "text": "Mauricio",
                        "type": "NATIONALITY"
                    },
                    {
                        "code": "AUT",
                        "text": "Austria",
                        "type": "NATIONALITY"
                    },
                    {
                        "code": "D",
                        "text": "Alemania",
                        "type": "NATIONALITY"
                    },
                    {
                        "code": "IRL",
                        "text": "Irlanda",
                        "type": "NATIONALITY"
                    },
                    {
                        "code": "MEX",
                        "text": "México",
                        "type": "NATIONALITY"
                    },
                    {
                        "code": "LIE",
                        "text": "Liechtenstein",
                        "type": "NATIONALITY"
                    },
                    {
                        "code": "CHE",
                        "text": "Suiza",
                        "type": "NATIONALITY"
                    },
                    {
                        "code": "GBR",
                        "text": "Reino Unido - ciudadano británico",
                        "type": "NATIONALITY"
                    }
                ],
                "category": "DOC_REQUIRED",
                "subCategory": "BEFORE_ARRIVAL"
            }
        }
    ]
}

the below highlighted text is for the above example where the testwindow is now translated with latin-american Spanish es-XL

"testWindow": [
                    {
                        "value": 72,
                        "condition": "BEFORE_DEPARTURE",
                        "type": "HOURS",
                        "text": "72 horas",
                        "medicalRequirementType": "RT_PCR_TEST"
                    },
                    {
                        "value": 72,
                        "condition": "BEFORE_DEPARTURE",
                        "type": "HOURS",
                        "text": "72 horas",
                        "medicalRequirementType": "LAMP_TEST"
                    },
                    {
                        "value": 72,
                        "condition": "BEFORE_DEPARTURE",
                        "type": "HOURS",
                        "text": "72 horas",
                        "medicalRequirementType": "TMA_TEST"
                    }
                ],
                "labels": {
                    "RT_PCR_TEST": "Prueba RT-PCR",
                    "BEFORE_DEPARTURE": "antes de salir",
                    "LAMP_TEST": "Prueba LAMP",
                    "TMA_TEST": "Prueba de TMA"
                },