API reference / JSON:API

get/v3/procedures/{id}

One procedure, by destination-nationality

Operation
v3GetProcedure
Authentication
API key

Ids are `<destination>-<nationality>`, e.g. `KEN-SOM`. An exempt nationality answers 404 with its citation in the error — there is no procedure to fetch, and the detail is more useful than an empty document that looks like a missing record.

Request

Parameters

idpathrequiredstring

Responses

200A JSON:API single-resource document.
metaobjectrequired
dataJsonApiResourcerequired
400A malformed parameter, or a filter/include/language this endpoint cannot honour. Refused rather than ignored: an ignored filter returns a full answer that looks filtered.
errorsobject[]required
401No key, an unknown key, a revoked key, or an inactive tenant.
errorsobject[]required
403The key is valid but does not hold `reference:read`.
errorsobject[]required
404No such resource.
errorsobject[]required

Example

curl
curl -X GET https://api.haavisa.com/v3/procedures/<id> \
  -H "Authorization: Bearer $HAAVISA_API_KEY"

More in JSON:API

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