Skip to content

Upload a file for bulk vault processing

POST
/business/certificate-vault/upload-file

Upload a certificate file (PDF or image) to temporary storage and receive a file_id. Use this endpoint to upload files before submitting bulk vault entries via the /bulk endpoint. Each file_id is used to reference the uploaded file when creating bulk entries.

Authorizations

Request Body required

object
file
required

The certificate file (PDF, JPG, JPEG, or PNG, max 20MB)

string format: binary

Responses

201

File uploaded successfully

object
message
string
File uploaded successfully
data
object
file_id

Unique identifier for the uploaded file, used when creating bulk entries

string format: uuid
9e3b101f-c264-4f97-945f-20dfa7163768
file_name

Original filename of the uploaded file

string
certificate.pdf
mime_type

MIME type of the uploaded file

string
application/pdf
size

File size in bytes

integer
245760

401

Authentication failed

object
message

Error message

string
Unauthorized - Invalid API token

403

Permission denied

object
message

Error message

string
Forbidden - Insufficient permissions
required_permission

Required permission to access this resource

string
batches:view

422

Validation error

object
message
string
errors
object
key
additional properties
Array<string>

500

Server error

object
message

Error message

string
An unexpected error occurred. Our team has been notified.
error_code

Error code

string
SERVER_ERROR