Developer Guide
Responses
Results are returned in a JSON structure in the following form:
| destination | An echo of the requested destination country for ease of use. |
| purpose | An echo of the requested trip purpose for ease of use. |
| iselectronic | This indicates if the destination has an electronic visa option. |
| visarequired | “true”: a visa is required to the destination for the given purpose.
“false”: a visa is not required. “vmbr”: a visa is generally required however may not be under certain conditions. Visit the Entriva website for more information. An example trip that would show this result (as of February 2024) would be a USA national going to Belarus (BLR) for Business. |
| landingurl | An Entriva partner URL which can be clicked through to purchase a travel visa or view further information. The landingurl will contain the necessary query strings and geo routing to ensure proper handling. |
| visachanges | An object containing an array of header/content pairs. When null, there is no upcoming change in visa requirement for the destination. |
| destination | An echo of the requested destination country for ease of use. |
| Nationality | An echo of the requested nationality for ease of use. |
| purposename | The descriptive name of the trip purpose returned in the response for ease of use. |
| visarequiredchangeto | This will be the new requirement rule effective as of the changestartdate:
“true”: a visa will be required to the destination for the given purpose. “false”: a visa will not be required. |
| changestartdate | The date on which the new requirement rule will be effective. |
| content | A string of content or note regarding the upcoming visa requirement change. |
| maxstay | An object containing an array of header/content pairs. When null, the destination country does not have max stay limitation rules. |
| validityname | This is a string to identify the visa validity, also known as the length of time a visa will be accepted as valid for use to enter a country. Some max stay limitation rules are only applicable to specific visas based on their validity. When the response is a “*”, this means the max stay limitation applies to all visas irrespective of their validity. |
| entryname | This is a string to identify the number of entries a visa allows. Some max stay limitation rules are only applicable to specific visas based on their number of entries. When the response is a “*”, this means the max stay limitation applies to all visas irrespective of the number of entries allowed. |
| maxstaylimit | An integer or null if there is no max stay limit for that destination country. |
| maxstaylimitunit | Unit of time for the Max Stay Limit; D = Days, M = Months, Y = Years. Null if there is no max stay limit for that destination country. |
| maxstayresetlimit | An integer or null if there is no associated reset period for the max stay limit rule. Some max stay rules include a reset period which is the minimum length of time travelers must be outside of the country before being allowed reentry irrespective of visas the traveler may have. |
| maxstayresetlimitunit | Unit of time for the Max Stay Reset Limit; D = Days, M = Months, Y = Years. Null if there is no reset period for the max stay limit rule. Some max stay rules include a reset period which is the minimum length of time travelers must be outside of the country before being allowed reentry irrespective of visas the traveler may have. |
| healthentry | An object containing an array of header/content pairs that provide the health and entry requirements for the destination country. |
| header | A descriptive header value. |
| content | The informative content pertaining to the header. |
| icon | String containing logo description (optional). |
| Purposename | The descriptive name of the purpose returned in the response. |
| VisacheckComments | This is a one-to-two lines note indicating any extra information related to the visa requirement.
e.g., “No visa is required for a stay of up to 90 days” |
| embassyDirect | As the environment has evolved, this response can be ignored until further notice. Additional details are included for informational purposes only.
The response is true for several reasons including that a personal appearance is required, special processing is required (e.g., a US national visiting Cuba for Tourism), or the Embassy has other special conditions and CIBT/Entriva can still help the traveler get a visa. In other cases, CIBT/Entriva cannot obtain the visa on behalf of the traveler due to Embassy rules. Travelers should follow the URL returned by the API for details and information on next steps. When the response is false, Entriva/CIBT can obtain the visa on behalf of the traveler. Travelers should follow the URL returned by the API for details and to get their visa. |