Start an auditor file upload
Starts an upload of a file an auditor provides for the customer, such as instructions or a template, on an information request. This does not upload customer evidence. Use this three-step flow:
-
Call this endpoint with
email,filenameandcontentTypeto receivean
uploadId, a temporaryurland formfields. -
POST the file to
urlasmultipart/form-databeforetransferExpiresAt.Copy every returned field name and value unchanged, then append the file under
fileas the final part. Do not hard-code the field names or send your Vanta bearer token to this URL. Let your HTTP client set the multipart Content-Type header and boundary. Wait for a 2xx response; the response body may be empty. -
POST
{ "uploadId": "<returned uploadId>" }to/v1/audits/{auditId}/information-requests/{requestId}/auditor-files/uploads/finalizeand complete finalization beforefinalizationExpiresAt.
The file is attached only after finalization succeeds. Each upload accepts
one file up to 50MB, inclusive. The auditor identified
by email is credited as the uploader and must be an active user in your
firm with access to the audit. A completed audit returns 409.
Each application is limited to 10 unfinished auditor file uploads per customer, across all audits and requests. Uploads count toward this limit until they are finalized, fail, or expire. Starting another upload at this limit returns 429, even if the earlier file transfers have succeeded. Repeating this start operation creates a new upload; it does not recover an earlier upload whose response was lost.
Rate limit: 10 requests / minute.
Authorizations
Body
The file's declared MIME type. Accepted values:
application/jsonapplication/pdfapplication/postscriptapplication/vnd.openxmlformats-officedocument.wordprocessingml.documentapplication/vnd.openxmlformats-officedocument.spreadsheetml.sheetapplication/x-zip-compressedapplication/zipimage/jpegimage/pngimage/webptext/csvtext/plain
Matching ignores case and MIME parameters, so TEXT/CSV and
text/csv; charset=utf-8 are also accepted. Unsupported file types return
422 during finalization.
Response
Ok
Form fields to send with the file to url. Copy every returned name and
value unchanged into a multipart/form-data POST, then append the file under
file as the final part. These are form fields, not HTTP headers. Field
names may vary between uploads; do not hard-code the example fields.