API reference / Documents

get/v1/documents/{id}/url

A short-lived link to a stored document

Operation
getDocumentUrl
Authentication
API key

Expires in five minutes. A passport scan behind a permanent URL is a passport scan on the internet.

Request

Parameters

idpathrequiredstring

Responses

200The link.
urlstringrequired
expires_in_secondsintegerrequired

Short by design — this is a link to a passport scan.

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/<id>/url \
  -H "Authorization: Bearer $HAAVISA_API_KEY"

More in Documents

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