Sign in

v1

latestOpenAPI 3.1.02026-07-2466150275.0 KB
Certificates

Create a Certificate

Create a new certificate.

post/v1/certificate/

Request body

typestring required

The name of the certificate

userIdinteger required

The identifier of the user this certificate belongs to

expiryDatestring date-time nullable

The certificate's expiry date

trainingCompanyIdinteger nullable

The identifier of the company that provided the training for the certificate

approvedboolean nullable

Determines if the certificate has been approved

approvedByUserIdinteger nullable

The identifier of the user who approved the certificate.

offlineboolean nullable

Determines if offline mode is enabled

providerIdinteger nullable

The identifier of the provider of the certification, this field is company specific.

companyCertificationTypeIdinteger required

The identifier of the type of certificate, this field is company specific.

Example request

{
  "type": "First Aid",
  "userId": 1,
  "expiryDate": "2027-07-17T21:40:53.248392",
  "trainingCompanyId": 13,
  "approved": true,
  "approvedByUserId": 13,
  "offline": true,
  "providerId": 15,
  "companyCertificationTypeId": 12
}

Response

Successful Response

errorboolean

A boolean error indicator.

messagestring nullable

Optional message.

Example response

{
  "data": {
    "type": "First Aid",
    "userId": 1,
    "expiryDate": "2027-07-17T21:40:53.248392",
    "trainingCompanyId": 13,
    "approved": true,
    "approvedByUserId": 13,
    "offline": true,
    "providerId": 15,
    "id": 1,
    "url": "/upload/example-certificate.jpg",
    "urlBack": "/upload/example-certificate-back.jpg"
  }
}