Skip to content
VEC Digital API

List all certificates

GET
/business/certificates

Returns a paginated list of certificates for the authenticated institution.

Authorizations

Parameters

Query Parameters

per_page
integer
default: 15 >= 1 <= 100

Number of items per page (default 15, max 100)

page
integer
default: 1 >= 1

Page number (starts from 1)

search
string

Search term to filter certificates by name, email, or reference ID

sort_field
string
Allowed values: name email status issue_date generated_at created_at updated_at

Field to sort by

sort_order
string
Allowed values: asc desc

Sort direction

batch_id
string format: uuid

Filter certificates by batch ID

customer_id
integer

Filter certificates by customer ID

status
string
Allowed values: pending processing generated failed revoked

Filter certificates by status

issue_date_from
string format: date

Filter certificates by issue date (start date)

issue_date_to
string format: date

Filter certificates by issue date (end date)

generated_at_from
string format: date

Filter certificates by generation date (start date)

generated_at_to
string format: date

Filter certificates by generation date (end date)

Responses

200

Successful operation

object
data
Array<object>
object
id

Unique identifier for the certificate

string format: uuid 
9e7860f0-05d1-4fd0-b3e0-e98e19f1cf15
reference_id

External reference ID for the certificate

string
VEC-IC-202567DAE48425BAD
batch_id

ID of the batch this certificate belongs to

string format: uuid 
9e7860e3-7c0a-401f-98f6-b98e316934f4
customer_id

ID of the customer this certificate is for

integer
nullable
name

Name of the certificate recipient

string
Faizan
email

Email of the certificate recipient

string format: email 
faizan@example.com
pdf_path

URL to the certificate PDF

string format: uri 
https://api.vec.digital/storage/certificates/9e7860f0-05d1-4fd0-b3e0-e98e19f1cf15/certificate_1742398957.pdf
image_path

URL to the certificate image

string format: uri 
https://api.vec.digital/storage/certificates/9e7860f0-05d1-4fd0-b3e0-e98e19f1cf15/certificate_1742398953.png
qrcode_path

URL to the certificate QR code

string format: uri 
https://api.vec.digital/storage/certificates/9e7860f0-05d1-4fd0-b3e0-e98e19f1cf15/qr_code_1742398952.svg
barcode_path

URL to the certificate barcode

string format: uri 
https://api.vec.digital/storage/certificates/9e7860f0-05d1-4fd0-b3e0-e98e19f1cf15/barcode_1742398952.svg
status

Current status of the certificate

string
Allowed values: pending processing generated failed revoked 
generated
issue_date

Date when the certificate was issued

string format: date-time 
2025-03-29T00:00:00.000000Z
generated_at

When the certificate was generated

string format: date-time
nullable 
2025-03-19T15:42:38.000000Z
created_at

Creation timestamp

string format: date-time 
2025-03-19T15:42:38.000000Z
updated_at

Last update timestamp

string format: date-time 
2025-03-19T15:42:38.000000Z
batch
object
id

Unique identifier for the batch

string format: uuid 
9e7860e3-7c0a-401f-98f6-b98e316934f4
name

Name of the batch

string
Class 10th, 2024
status

Current status of the batch

string
Allowed values: pending processing completed partially_completed failed waiting_for_approval 
completed
template_id

ID of the certificate template used

string format: uuid 
9d76a768-d016-4364-b18b-32c647adad0c
total_certificates

Total number of certificates in the batch

integer
1
processed_certificates

Number of successfully processed certificates

integer
1
failed_certificates

Number of failed certificates

integer
0
progress

Progress percentage (0-100)

number format: float 
100
completion_date

When the batch was completed

string format: date-time
nullable 
2025-03-14T13:04:03.000000Z
created_at

Creation timestamp

string format: date-time 
2025-03-14T13:02:19.000000Z
updated_at

Last update timestamp

string format: date-time 
2025-03-14T13:04:03.000000Z
total_signatures

Total number of signatures required

integer
2
approved_signatures

Number of approved signatures

integer
1
links
object
first

URL to the first page

string
https://api.vec.digital/business/certificate-templates?page=1
last

URL to the last page

string
https://api.vec.digital/business/certificate-templates?page=2
prev

URL to the previous page (null if on first page)

string
nullable
next

URL to the next page (null if on last page)

string
nullable 
https://api.vec.digital/business/certificate-templates?page=2
meta
object
current_page

Current page number

integer
1
from

Index of the first item on the current page

integer
1
last_page

Total number of pages

integer
2
links

Pagination links

Array<object>
object
url
string
nullable 
https://api.vec.digital/business/certificate-templates?page=2
label
string
2
active
boolean
path

Base URL path for pagination

string
https://api.vec.digital/business/certificate-templates
per_page

Items per page

integer
15
to

Index of the last item on the current page

integer
15
total

Total number of items

integer
25

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

500

Server error

object
message

Error message

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

Error code

string
SERVER_ERROR