API reference / Documents

delete/v1/documents/{id}

Remove a document before submission

Operation
deleteDocument
Authentication
API key

Marked deleted and the object removed, rather than a hard row delete — an application that was submitted and then had a document swapped still needs to be auditable.

Request

Parameters

idpathrequiredstring

Responses

204Removed.
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 DELETE https://api.haavisa.com/v1/documents/<id> \
  -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.