Skip to content
VEC Digital API

Create bulk vault certificates

POST
/business/certificate-vault/bulk

Create multiple vault certificates at once. This is a two-step process:

  1. Upload certificate files using the /upload-file endpoint and collect file_id values
  2. Submit a bulk request with entries referencing the file_id values

The bulk upload is processed asynchronously. The response returns a batch_id that can be used to track processing status through the list endpoint.

Authorizations

Request Body required

object
entries
required

Array of certificate entries to create

Array<object>
>= 1 items
object
certificate_title
required

Title of the certificate

string
<= 255 characters 
Certificate of Achievement
full_name
required

Full name of the certificate recipient

string
<= 255 characters 
John Smith
applicant_email
required

Email address of the certificate recipient

string format: email
<= 255 characters 
john@example.com
file_id
required

UUID returned by the /upload-file endpoint

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

Issue date of the certificate

string format: date 
2025-06-01
details

Additional details about the certificate

string
<= 1000 characters 
Awarded for outstanding performance

Responses

202

Bulk upload queued for processing

object
message
string
Bulk vault upload queued for processing
data
object
batch_id

Unique identifier for tracking the bulk upload

string format: uuid 
8f7d6e5c-4b3a-2910-z987-y654x321w000
total

Total number of entries submitted

integer
5
status

Processing status

string
processing

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 (e.g., duplicate entries, invalid file_ids)

object
message
string
Some file_ids could not be resolved
errors
Array<string>
[
  "Entry 0: file_id 9e3b101f-c264-4f97-945f-20dfa7163768 not found"
]

500

Server error

object
message

Error message

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

Error code

string
SERVER_ERROR