Sign in

v1

latestOpenAPI 3.1.0Apache 2.02026-07-245981,1853.0 MB
Consent Attachments

Upload Consent Attachment

Use this API to upload and store files which contain written consent of data subjects' transactions.

🗒 Things to Know

  • The size of uploaded files must be less than 4MB.

  • The following file formats are allowed: .pdf, .jpeg, .jpg, and .png.

  • The RefID parameter returned within the response body can be used to attach file references to incoming data subject consents using the Create Consent Receipts API.

  • File references can be attached to a given data subject or data subject purpose by using the attachments or PurposeAttachments parameters in the Create Consent Receipts API respectively.

post/rest/api/preferences/v1/attachments

Response

File uploaded successfully.

refIdstring uuid

Reference ID for the uploaded file.

filenamestring

Original name of the uploaded file.

fileSizeinteger

Size of the uploaded file in bytes.

contentTypestring

MIME type of the uploaded file.

qualifiedNamestring

Fully qualified name/path of the uploaded file in storage.

Example response

{
  "refId": "550e8400-e29b-41d4-a716-446655440000",
  "filename": "consent_form.pdf",
  "fileSize": 1024,
  "contentType": "application/pdf",
  "qualifiedName": "tenant123/attachments/consent_form.pdf"
}