Get a specific certificate

GET

/business/certificates/{certificateId}

• production API Server

Returns detailed information about a specific certificate.

Authorizations

• ApiKeyAuth

Parameters

Path Parameters

certificateId

required

string format: uuid

UUID of the certificate to retrieve

Responses

200

Successful operation

object

data

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

signatures

Signature details

Array<object>

object

id

Unique identifier for the signature

integer

46

institution_user_uuid

UUID of the user who signed or will sign

string format: uuid

66c9c977-f379-4692-9d5c-f989c17543ee

display_name

Display name for the signature

string

nullable

Faizan Ali

designation

Designation for the signature

string

nullable

Software Developer

signatory_index

Order index of the signature

integer

1

dimensions

Dimensions of the signature on the certificate

object

x

X coordinate

number

100

y

Y coordinate

number

200

width

Width

number

150

height

Height

number

50

signature

URL to the signature image

string format: uri

nullable

status

Status of the signature

string

Allowed values: pending approved rejected

approved

approved_at

When the signature was approved

string format: date-time

nullable

2025-03-13T14:55:38.000000Z

rejected_at

When the signature was rejected

string format: date-time

nullable

rejection_reason

Reason for rejection

string

nullable

created_at

Creation timestamp

string format: date-time

2025-03-05T10:50:40.000000Z

updated_at

Last update timestamp

string format: date-time

2025-03-13T14:55:50.000000Z

fabric_json

Canvas JSON for the certificate (only included for users with update permission)

object

additional_data

Additional certificate data (only included for users with update permission)

object

csv_data

CSV data used to create this certificate (only included for users with update permission)

object

creator

object

id

ID of the creator

integer

3

type

Type of the creator

string

InstitutionUser

name

Name of the creator

string

Faizan Ali

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