API reference / Admin

post/v1/admin/applications/{id}/documents-request

Ask the applicant for more documents

Operation
adminRequestAdditionalDocuments
Authentication
API key

Records the request, emails the saved applicant address with a secure upload link, and emits an audit entry and partner event. Government approval and refusal are recorded only from the authority status worker.

Request

Parameters

idpathrequiredstring

Body

typestring
replaces_document_idstring
reasonstringrequired

What the applicant must provide; included in the request email and audit history.

Responses

200The application status and confirmation the document request was recorded.
statusstringrequired

one of: draftawaiting_paymentpaidsubmittedunder_reviewapprovedrejectedcancelledexpired

requestedstringrequired

one of: documents

requestobjectrequired
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
403`projects:write` is required. No partner key is ever issued this scope.
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 POST https://api.haavisa.com/v1/admin/applications/<id>/documents-request \
  -H "Authorization: Bearer $HAAVISA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "reason": "<reason>"
  }'

More in Admin

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