SAsalussafety
Certificates

Upload Certificate

Upload an image of the certificate front and/or back to an existing certificate.

Supported filetypes are: .jpeg, .jpg, .png, .pdf, .docx, .mp4, .mov and .m4v.

This endpoint supports uploading the front and back of the certificate at the same time. If certificate_back is omitted, the back will not be modified. To remove the back of the certificate, you must also set certificate_back_remove=true

If both the certificate_back and certificate_back_remove are specified, then certificate_back will take priority and certificate_back_remove will be ignored.

put/v1/certificate/{certificate_id}/upload/

Request

  • Base URL
    https://developer.beta.salussafety.io
  • URL
    https://developer.beta.salussafety.io/v1/certificate/{certificate_id}/upload/
  • Auth
    • HTTP bearer
    • or OAuth 2
      Client credentials
      Token URL: https://guardian.beta.salussafety.io/token
    • or OAuth 2
      Authorization code: https://guardian.beta.salussafety.io/authorize
      Token URL: https://guardian.beta.salussafety.io/token

Path parameters

certificate_idinteger required

Request body multipart/form-data

certificatestring binary required
certificate_backstring binary
certificate_back_removeboolean

Response

Successful Response

errorboolean

A boolean error indicator.

messagestring nullable

Optional message.

Example response

{
  "data": {
    "type": "First Aid",
    "userId": 1,
    "expiryDate": "2027-10-19T22:47:16.828976",
    "trainingCompanyId": 13,
    "approved": true,
    "approvedByUserId": 13,
    "offline": true,
    "providerId": 15,
    "id": 1,
    "url": "/upload/example-certificate.jpg",
    "urlBack": "/upload/example-certificate-back.jpg"
  }
}

Changes

No recorded changes to this operation across all 2 revisions of this API.