API reference / Reference

get/v1/countries

Countries, with the adjective for each nationality

Operation
listCountries
Authentication
API key

The grid the eligibility engine speaks: ISO alpha-2 and alpha-3, the country name and the demonym. The demonym is the point — a page or a message that says "Japanese citizens" needs the adjective, and deriving it from "Japan" is a guess.

Request

Parameters

qquerystring

Responses

200Matching countries, or all 196 when no query is given.
countriesReferenceCountry[]required
next_cursorstringnullrequired
400The request body or query failed validation.
errorobjectrequired
401No key, an unknown key, a revoked key, or a key whose tenant is not active. All four return an identical body on purpose: distinguishing them would let a caller discover which partners we have.
errorobjectrequired
403The key is valid but does not hold the scope this route requires.
errorobjectrequired
404Not found, or not yours. A resource belonging to another tenant answers 404 rather than 403, because 403 would confirm the record exists.
errorobjectrequired

Example

curl
curl -X GET https://api.haavisa.com/v1/countries \
  -H "Authorization: Bearer $HAAVISA_API_KEY"

More in Reference

Something unclear? The eligibility guide explains the model behind the answers; the errors guide covers the envelope.