Skip to content
VEC Digital API

Get a specific vault certificate

GET
/business/certificate-vault/{certificateApplication}

Returns detailed information about a specific vault certificate.

Authorizations

Parameters

Path Parameters

certificateApplication
required
string format: uuid

UUID of the vault certificate to retrieve

Responses

200

Successful operation

object
data
object
id

Internal ID of the certificate

integer
42
uuid

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
certificate_title

Title of the certificate

string
Certificate of Achievement
issue_date

Date when the certificate was issued

string format: date
nullable 
2025-06-01
details

Additional details about the certificate

string
nullable 
Awarded for outstanding performance
qrcode_path

URL to the certificate QR code

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

URL to the certificate barcode

string format: uri
nullable 
https://api.vec.digital/storage/verification_applications/9e7860f0-05d1-4fd0-b3e0-e98e19f1cf15/barcode.svg
full_name

Full name of the certificate recipient

string
John Smith
applicant_email

Email address of the certificate recipient

string format: email 
john@example.com
applicant_phone_number

Phone number of the certificate recipient

string
nullable
source

The source of the certificate application

object
value
string
Allowed values: customer vault 
vault
label
string
Vault
institution_name

Name of the issuing institution

string
ABC University
institution_email

Email of the issuing institution

string format: email 
admin@abcuniversity.edu
institution_phone_number

Phone number of the issuing institution

string
nullable 
+971501234567
institution_address

Address of the issuing institution

string
nullable 
123 Education Street, Dubai, UAE
institution_contact_person_name

Contact person name at the institution

string
nullable 
Dr. Ahmed Ali
institution_social_media_links

Social media links of the institution

object
facebook
string
nullable
linkedin
string
nullable
twitter
string
nullable
location

Geographic coordinates

object
latitude
number format: decimal 
25.204849
longitude
number format: decimal 
55.270783
status

Current status of the certificate

object
value
string
Allowed values: pending processing generated failed revoked 
generated
label
string
Generated
color
string
success
icon
string
heroicon-o-check-circle
description
string
Certificate has been successfully generated
verification_notes

Notes from the verification process

string
nullable
rejection_reason

Reason for rejection, if applicable

string
nullable
verified_at

When the certificate was verified

string format: date-time
nullable
assigned_at

When the certificate was assigned

string format: date-time
nullable 
2025-06-01T10:00:00.000000Z
documents

Associated documents (PDF, images)

Array<object>
object
id

Document ID

integer
101
type

Type of document

string
Allowed values: uploaded_pdf uploaded_image verified_pdf generated_image 
verified_pdf
file_path

Path or URL to the document file

string
https://api.vec.digital/storage/verification_applications/9e7860f0/verified_certificate.pdf
metadata

Additional document metadata

object
original_filename
string
certificate.pdf
mime_type
string
application/pdf
dimensions
object
width
integer
2480
height
integer
3508
customer

Customer details if the recipient has a VEC.digital account

object
id
integer
15
first_name
string
John
last_name
string
Smith
email
string format: email 
john@example.com
created_at

Creation timestamp

string format: date-time 
2025-06-01T10:00:00.000000Z
updated_at

Last update timestamp

string format: date-time 
2025-06-01T10:05:00.000000Z

400

Not a vault certificate

object
message
string
Not a vault certificate

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

404

Resource not found

object
message

Error message

string
The requested ID 9d3a6b04-c4e5-485f-b945-8f1fd66396ce was not found.
error

Error code

string
resource_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