API reference / Admin

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

Accept, reject or cancel a requested replacement

Operation
adminReviewRequestedDocument
Authentication
API key

Request

Parameters

idpathrequiredstring
requestIdpathrequiredstring

Body

statusstringrequired

one of: acceptedrejectedcancelled

Responses

200Updated document request.
idstringrequired
typestringrequired
reasonstringrequired
statusstringrequired

one of: pendinguploadedacceptedrejectedcancelled

document_idstringnullrequired
replaces_document_idstringnullrequired
requested_bystringrequired
reviewed_bystringnullrequired
created_atstringrequired
updated_atstringrequired
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/<requestId>/review \
  -H "Authorization: Bearer $HAAVISA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "status": "accepted"
  }'

More in Admin

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