API reference / Reference

get/v1/documents

Supporting documents an application will ask for

Operation
listDocumentRequirements
Authentication
API key

`required` is what every applicant sends; `conditional` is what a purpose of visit or a visa type adds. The condition is the portal’s own wording, passed through rather than parsed into a predicate we would have had to invent.

Request

Parameters

destination_iso3queryrequiredstring

Responses

200The required and conditional documents for the destination.
destination_iso3stringrequired

one of: ETHSOMDJIKEN

requiredDocumentRequirement[]required
conditionalDocumentRequirement[]required
alternativesobject[]required
review_notesstring[]required
file_rulesobjectrequired
requirements_versionintegerrequired
source_urlstringnullrequired
verified_onstringnullrequired
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/documents \
  -H "Authorization: Bearer $HAAVISA_API_KEY"?destination_iso3=<destination_iso3>

More in Reference

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