API reference / JSON:API
/v3/proceduresWhat a traveller must do to enter a destination
- Operation
v3ListProcedures- Authentication
- API key
The eligibility engine, as procedures. One destination at a time — `filter[country]` is required, because a procedure is a rule for entering *a* country and all four under one `data` member would be four different answers.
**`exempt` is the only reason a nationality is absent from `data`**, and `meta.excluded.exempt` says how many were omitted. An exempt nationality has nothing to do, so it has no procedure — and the count is what keeps an empty result from being read as "we did not look".
**`filter[activeDate]` and `filter[originCountries]` are refused, not ignored.** We hold no rule validity windows and none of these destinations keys a rule on origin; the 400 says so. Answering a question about a date with rules that are not date-aware is the failure this engine exists to avoid.
Request
Parameters
filter[country]queryrequiredstringfilter[nationalities]querystringfilter[documentType]querystringfilter[category]querystringfilter[travelPurpose]querystringincludequerystringlanguagequerystringResponses
metaobjectrequireddataJsonApiResource[]requirederrorsobject[]requirederrorsobject[]requirederrorsobject[]requirederrorsobject[]requiredExample
curl -X GET https://api.haavisa.com/v3/procedures \
-H "Authorization: Bearer $HAAVISA_API_KEY"?filter[country]=<filter[country]>More in JSON:API
Something unclear? The eligibility guide explains the model behind the answers; the errors guide covers the envelope.