API Reference
Start typing to search…

Upgrade Reference

This document presents a structured overview of the V1 data format and its relationship to the updated V2 schema. It is not intended as a full tutorial for V2, but rather as a reference for those already familiar with or working with V1. The focus is on mapping key data elements from V1 to their new locations or equivalents in V2, helping teams understand how existing data translates across versions. This includes renamed, restructured, deprecated, and newly introduced fields, as well as examples showing how certain values or groupings have evolved.

Main keys

is_travel_possible
reasons
overall_trip_assessment
specific_traveller_assessment
possible_travel_disruptions
documents_required
meta
trip_risk_level
facts
entry_borders
possible_disruptions
travel_documentation
vaccinations
health_documentation
female_travellers
lgbtq_travellers
meta

📘

Some keys have been deprecated in V2 but their underlying data is still present, often under different names and in a more structured format.


Data relations

is_travel_possible

Deprecated in the new version.

reason

Deprecated in the new version.

overall_trip_assessment

Data that was part of the overall_trip_assessment section has been reorganized and can now be found under trip_risk_level.

overall_trip_assessment      ->      trip_risk_level
  answer                               description
"overall_trip_assessment": {
  "id": "2",
  "name": "Moderate",
  "info": "Take normal safety precautions",
  "answer": ""
}
"trip_risk_level": {
  "id": "2",
  "name": "Moderate",
  "info": "Take normal safety precautions",
  "description": ""
}

specific_traveller_assessment

Data that was part of the specific_traveller_assessment section has been reorganized and can now be found under female_travellers and lgbtq_travellers.

"specific_traveller_assessment": [
  {
    "type": "female",
    "name": "Female",
    "level": 2,
    "level_computed": "2/3",
    "description": "Female travellers might face difficulties. Conservative social, cultural and religious customs may vary widely. Dress code might be observed, especially when visiting cultural and religious places or conservative areas."
  },
  {
    "type": "lgbtq",
    "name": "LGBTQ",
    "level": 1,
    "level_computed": "1/3",
    "description": "LGBTQ travellers are unlikely to face difficulties. Local attitudes towards the LGBTQ community are overall open and progressive."
  }
]
"female_travellers": {
  "name": "Female Travellers",
  "assessment": {
    "level": 2,
    "level_computed": "2/3",
    "level_name": "Elevated Concern",
    "description": "Female travellers might face difficulties. Conservative social, cultural and religious customs may vary widely. Dress code might be observed, especially when visiting cultural and religious places or conservative areas."
  },
  "law_and_customs": {
    "name": "Laws and Customs",
    "elements": [
      {
        "key": "local_customs_laws",
        "label": "Are there any local customs or laws?",
        "text": "<p>There are no local customs or laws that a female traveller should take into consideration in the United States. </p>",
        "weight": 0
      }
    ]
  },
  "safety": {
    "name": "Safety",
    "elements": [
      {
        "key": "safety_concerns",
        "label": "What are the safety concerns for female travellers?",
        "text": "<p>There are minimal safety concerns female travellers should take into consideration in the United States... </p>",
        "weight": 0
      }
    ]
  },
  "health_and_wellness": {
    "name": "Health and Wellness",
    "elements": [
      {
        "key": "access_specialised_health_services",
        "label": "Can females access specialised and reproductive health services and medicines?",
        "text": "<p>Availability of specialised gynaecological and reproductive health services, medicines and products vary widely in the United States... </p>",
        "weight": 0
      }
    ]
  }
}
"lgbtq_travellers": {
  "name": "LGBTQ Travellers",
  "assessment": {
    "level": 1,
    "level_computed": "1/3",
    "level_name": "Normal Concern",
    "description": "LGBTQ travellers are unlikely to face difficulties. Local attitudes towards the LGBTQ community are overall open and progressive."
  },
  "elements": [
    {
      "key": "homosexuality",
      "label": "Is homosexuality legal?",
      "text": "<p>Homosexuality is legal in United States of America.</p>",
      "weight": 0
    },
    {
      "key": "transgender_people",
      "label": "Is legal gender recognition permitted?",
      "text": "<p>Change of legal gender is allowed by the law. However, proof of having undergone gender-affirming surgery and care might be required in order to change gender on identification documents.</p>",
      "weight": 1
    },
    {
      "key": "ssm_and_cu",
      "label": "Are gay marriages and/or civil unions legal?",
      "text": "<p>Authorities legalised gay marriages, but not civil unions.</p>",
      "weight": 2
    }
  ]
}

possible_travel_disruptions

Both types of travel warnings advisories and secondary_advisories have been merged into a single unified list.

possible_travel_disruptions      ->      possible_disruptions
  secondary_advisories                     advisories
  annual_events                            events
"possible_travel_disruptions": {
  "text": null,
  "alerts": [
    {
      "id": "371682",
      "title": "Unionised SNCF workers to strike nationwide on 9-11 May",
      "text": "The SUD-Rail union called on SNCF ticket inspectors to strike nationwide from 9 to 11 May, to demand better anticipated schedules and pay.",
      "notice": true,
      "start_date": "2025-05-09",
      "end_date": "2025-05-12",
      "risk_level": {
        "id": "2",
        "name": "Moderate"
      },
      "category": {
        "id": "7",
        "name": "Travel Safety and Disruptions"
      }
    }
  ],
  "advisories": [
    {
      "id": "35200",
      "title": "Seasonal Influenza in the Northern Hemisphere",
      "risk_level": {
        "id": "2",
        "name": "Moderate"
      }
    }
  ],
  "secondary_advisories": [
    {
      "id": "35412",
      "title": "Schengen Internal Border Controls",
      "risk_level": {
        "id": "2",
        "name": "Moderate"
      }
    }
  ],
  "annual_events": [
    {
      "date": "14 July",
      "name": "Bastille Day (Lyon)",
      "description": "On French National Day, most events in <strong>Lyon</strong> take place along the banks of the river Rhone or Saon. Visitors should anticipate large crowds throughout central <strong>Lyon</strong> and be vigilant, as pickpockets and thieves often target mass gatherings."
    }
  ]
}
"possible_disruptions": {
  "alerts": [
    {
      "id": "374895",
      "title": "Officials remove Romania from Visa Waiver Program - Update",
      "start_date": "2025-05-02",
      "end_date": "2025-05-03",
      "risk_level": {
        "id": "1",
        "name": "Low"
      },
      "category": {
        "id": "7",
        "name": "Travel Safety and Disruptions"
      }
    }
  ],
  "advisories": [
    {
      "id": "35200",
      "title": "Seasonal Influenza in the Northern Hemisphere",
      "text": "<p>Seasonal influenza occurs in the <strong>Northern Hemisphere</strong> from October through May, peaking between December and February. Unvaccinated elderly adults, young children and people with chronic health conditions are at a higher risk. Travellers should ensure they have an up-to-date flu vaccine before departure.</p>",
      "risk_level": {
        "id": "2",
        "name": "Moderate"
      }
    }
  ],
  "events": [
    {
      "iso_dates": [
        "2025-05-17"
      ],
      "date": "17 May",
      "name": "Preakness Stakes (Sporting event)"
    }
  ]
}

documents_required

documents_required.entry      ->       travel_docummentation.visa_checker
  is_visa_required                       is_visa_required
  visa_rules                             text
                                         disclaimer
"is_visa_required": "Maybe, depending on the type of trip",
"visa_rules": [
  {
    "rule_type": "Visa",
    "name": "Tourist Visa (90 days)",
    "enforcement": "Mandatory",
    "electronic_application_url": null,
    "text": "<p>A tourist visa is granted to foreigners only for recreation, sightseeing, meeting family/friends...</p><p>Travellers are advised to consult with Indian consular representatives prior to travel.</p>",
    "exemptions": []
  },
  {
    "rule_type": "Business visa",
    "name": "Business Visa",
    "enforcement": "Possible",
    "electronic_application_url": null,
    "text": "<p>Foreign nationals may apply for a Business Visa to enter India...</p><p>Travellers are advised to consult via the embassy or consular services prior to departure.</p>",
    "exemptions": []
  },
  {
    "rule_type": "E-Visa",
    "name": "E-Tourist Visa and E-Business (180 days)",
    "enforcement": "Mandatory",
    "electronic_application_url": "https://indianvisaonline.gov.in/",
    "text": "<p>Foreign nationals of select countries are eligible to apply for e-Visas...</p><p>E-visas are available to enter India through multiple airports and designated seaports...</p>",
    "exemptions": []
  }
]
"visa_checker": {
  "is_visa_required": "You might need to obtain a visa from the nearest embassy/consulate or apply online before travel for an E-Visa or an Electronic Travel Authorisation (eTA). You might need to obtain a Business visa depending on the purpose of your business trip.",
  "disclaimer": "<p class=\"default-disclaimer\">Entry visa requirements vary based on nationality, purpose of travel and other factors. Individual travellers are responsible for ensuring that they comply with all visa requirements, which should be confirmed with authorities at their destination before travel.</p>",
  "text": "<p><strong>Tourist Visa (90 days):</strong> A tourist visa is granted to foreigners only for recreation, sightseeing, meeting family/friends...</p><p><strong>Business Visa:</strong> Foreign nationals may apply for a Business Visa to enter India...</p><p><strong>E-Tourist Visa and E-Business (180 days):</strong> Foreign nationals of select countries are eligible to apply for e-Visas...</p>"
}

documents_required.entry      ->       health_documentation
  vaccinations
  insurance_documents
"vaccinations": [
  {
    "type": "yellow_fever",
    "name": "Yellow Fever",
    "description": "<p>Travellers arriving by air or sea without a Yellow Fever certificate may be detained in isolation for up to 6 days if they recently visited or transited through high-risk areas...</p><p>The Government of India maintains a list of countries with Yellow Fever transmission risk, which includes parts of Africa and South America...</p><p><em>(Source: USA CDC)</em></p>"
  }
],
"insurance_documents": [
  {
    "document_type": "Health Insurance",
    "languages": [],
    "forms": {},
    "text": "<p>An insurance covering military risks is mandatory for certain groups, including journalists, media representatives and opinion leaders. A medical insurance covering military risks for the entire stay in Ukraine is also recommended, but not mandatory for entry. Visit <a href=\"https://visitukraine.today/#form_insurance\" target=\"_blank\" rel=\"noopener\">https://visitukraine.today/#form_insurance</a> for more details.</p>"
  }
]
"health_documentation": [
  {
    "id": "9773",
    "name": "Yellow Fever proof of vaccination",
    "text": "<p>Travellers arriving without a Yellow Fever certificate may be detained for up to 6 days if they recently visited or transited through high-risk areas...</p><p>India maintains a list of countries considered at risk for Yellow Fever transmission, including parts of Africa and the Americas...</p>",
    "document_form_url": "",
    "app": {
      "name": "",
      "ios_url": "",
      "android_url": "",
      "huawei_url": ""
    },
    "weight": 0,
    "kind": "yellow-fever-vaccine-entry-requirement"
  },
  {
    "id": "12926",
    "name": "Health Insurance",
    "text": "<p>Insurance covering military risks is mandatory for some groups such as journalists and media representatives. It is also recommended for all travellers to Ukraine...</p>",
    "document_form_url": "",
    "app": {
      "name": "",
      "ios_url": "",
      "android_url": "",
      "huawei_url": ""
    },
    "weight": 2,
    "kind": "health-insurance"
  }
]

documents_required.entry      ->       travel_documentation.travel_documents
  other_documents                      health_documentation
"other_documents": [
  {
    "document_type": "Health",
    "languages": [],
    "forms": {
      "ZH": "https://mp.weixin.qq.com/s/W7fUitoaoQA81nRoFV8BFg"
    },
    "text": "<p>Those exhibiting symptoms of infectious diseases such as fever and cough are only advised to fill in the health declaration...</p><p>Travellers may fill out the form via the Mobile Customs app or the Health Declaration online portal...</p>"
  },
  {
    "document_type": "Travel (PLF)",
    "languages": [
      "EN"
    ],
    "forms": {
      "EN": "https://lecard.immigration.gov.ng/"
    },
    "text": "<p>From 1 May, international travellers must complete digital Landing or Exit cards before entering or leaving Nigeria...</p>"
  }
]
"travel_documentation": {
  ...
  "travel_documents": [
    {
      "id": "30833",
      "name": "Travel (PLF)",
      "text": "<p>Effective from 1 May, authorities require all international travellers to complete digital Landing or Exit cards before entering or departing Nigeria...</p>",
      "document_form_url": "https://lecard.immigration.gov.ng/",
      "app": {
        "name": "",
        "ios_url": "",
        "android_url": "",
        "huawei_url": ""
      },
      "weight": 1,
      "kind": "travel-plf"
    }
  ]
},
...
"health_documentation": [
  {
    "id": "8323",
    "name": "Health",
    "text": "<p>Those exhibiting symptoms of infectious diseases such as fever and cough are only advised to fill in the health declaration...</p><p>Travellers may fill out the form via the Mobile Customs app or the Health Declaration online portal...</p>",
    "document_form_url": "https://mp.weixin.qq.com/s/W7fUitoaoQA81nRoFV8BFg",
    "app": {
      "name": "",
      "ios_url": "https://apps.apple.com/id/app/%E6%8E%8C%E4%B8%8A%E6%B5%B7%E5%85%B3/id1272031506",
      "android_url": "http://agentzshg.chinaport.gov.cn/umserver/js/downLoadApp/index.html",
      "huawei_url": ""
    },
    "weight": 3,
    "kind": "health"
  }
]

New fields

facts

"facts": {
  "time_zone": "<p>UTC 0; daylight saving time: +1hr, begins last Sunday in March, ends last Sunday in October; note: applies to the United Kingdom proper, not to its crown dependencies or overseas territories</p>",
  "currency_name": "<p>British pounds</p>",
  "capital": "<p>London (pop. 9.648 million)</p>",
  "languages": "<p>English, Scots, Scottish Gaelic, Welsh, Irish, Cornish</p>"
}

entry_and_borders

"entry_borders": {
  "status": "Travel possible for all travellers.",
  "text": "<p><strong>Border closures:</strong> Border crossings with <strong>Myanmar</strong> are either closed or heavily restricted...</p><p><strong>Health-related surveillance measures:</strong> Authorities enforced mpox-related screening measures at entry points, with thermal screening possible for other diseases...</p>",
  "borders": ""
}

vaccinations

🚧

In the new version, the vaccinations section offers general vaccination recommendations, but does not list vaccinations required for entry. The previously known vaccinations information can be found under health_documentation.

"vaccinations": [
  {
    "id": "8314",
    "name": "Typhoid vaccine",
    "text": "<p>Recommended for most travellers, especially those staying with friends or relatives or visiting smaller cities or rural areas.</p>",
    "recommended_for": "most",
    "weight": 13
  },
  {
    "id": "8317",
    "name": "Rabies vaccine",
    "text": "<p>Dogs infected with rabies are commonly found in China.</p> <p>Rabies is also present in some terrestrial wildlife species.</p> <p>If rabies exposures occur while in China, rabies vaccines are typically available throughout most of the country.</p> <p>Rabies pre-exposure vaccination considerations include whether travellers 1) will be performing occupational or recreational activities that increase risk for exposure to potentially rabid animals and 2) might have difficulty getting prompt access to safe post-exposure prophylaxis.</p> <p>Please consult with a healthcare provider to determine whether you should receive pre-exposure vaccination before travel.</p>",
    "recommended_for": "some",
    "weight": 11
  }
]