Skip to main content
POST
TypeScript

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

auditId
string
required
requestId
string
required

Body

application/json
email
string
required

Email of the auditor to credit as the uploader. They must be an active user in your audit firm with access to the audit, including when you finalize.

filename
string
required

Filename to display on the attachment. Must be 1–255 characters after trimming surrounding whitespace.

contentType
string
required

The file's declared MIME type. Accepted values:

  • application/json
  • application/pdf
  • application/postscript
  • application/vnd.openxmlformats-officedocument.wordprocessingml.document
  • application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
  • application/x-zip-compressed
  • application/zip
  • image/jpeg
  • image/png
  • image/webp
  • text/csv
  • text/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

uploadId
string
required

Opaque identifier for this upload. Pass it unchanged to finalize; it is not the attached file's ID.

url
string
required

Temporary URL for the file-transfer request. POST every returned fields entry and the file to this URL, without a Vanta Authorization header. This is not a download link.

fields
object
required

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.

maxSizeBytes
number<double>
required

Maximum file size in bytes, inclusive. The limit is 50MB.

transferExpiresAt
string<date-time>
required

UTC expiration timestamp for url and fields. Start the file-transfer POST well before this time.

finalizationExpiresAt
string<date-time>
required

UTC deadline to complete finalization and attach the file, even if the file transfer has already succeeded.