Developer Guide
Request Parameters
| Field | Description |
|---|---|
| destination – Required | Three letter or two letter destination ISO country code. (Please refer to: https://en.wikipedia.org/wiki/ISO_3166-2 , https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3 ) |
| nationality – Required | Three letter or two letter nationality ISO country code. (Please refer to: https://en.wikipedia.org/wiki/ISO_3166-2 , https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3 ) |
| purpose – Required | Code representing the purpose of the visit. See the purpose code list. |
| residency – Required | Three letter or two letter ISO country code indicating the country where the client/customer/traveler is originating/residing from. (Please refer to: https://en.wikipedia.org/wiki/ISO_3166-2 , https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3 ) |
| stateofresidence – Optional | Optional value for countries that are jurisdictional such as USA, Canada, Germany and Australia, and that may give more specific results relevant to a traveler’s locality. However it is not necessary to send a value if it is not known. See the state of residence reference for details. |
| entrydate – Mandatory for partners | Date value in the format of YYYY-MM-DDThh:mm:ss (e.g., 2023-09-20T10:00:00). This date is critical to convey arrival into the destination country for accurate visa requirement results. |
| exitdate – Mandatory for partners | Date value in the format of YYYY-MM-DDThh:mm:ss (e.g., 2023-10-20T15:00:00). This date is critical to convey departure from the destination country for accurate visa requirement results. |
| accountcode – Mandatory for partners | Account code must be provided by Entriva partners for attribution. When an accountcode is provided, it will be attached to the returned landingurl.
(If you need to confirm your account code, please contact your Account Manager.) |
| brand – Mandatory for partners | For Entriva partners, the brand must be sent as “entriva” in order to pass back the correct returned landingurl. The landingurl will be provided by us.
For CIBTvisas partners, the brand must be sent as “CIBT” in order to pass back the correct returned landingurl. |
| localcode – Optional | Two letter language code. Please see the list of local codes for the supported languages (e.g., NL-Dutch, DE-German). English is the default if no language is supplied or when localization is not available. |