Consent Attachments

Download Consent Attachment

Use this API to download a specific file reference attached to a given data subject. The file will be downloaded in .zip format.

🗒 Things to Know

  • The attachmentId parameter value corresponds to the RefId parameter value returned after uploading a file using the Upload Consent Attachment API.
get/rest/api/preferences/v1/attachments/{attachmentId}

Request

  • Base URL
    https://hostname
  • URL
    https://hostname/rest/api/preferences/v1/attachments/{attachmentId}
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://{hostname}/api/access/v1/oauth/token scopes: CONSENT, CONSENT_READ

Path parameters

attachmentIdstring uuid required

Unique refId UUID of the file to be downloaded.

Headers

identifierstring required

The identifier of the data subject.

Response

ZIP file containing the requested attachment.

Changes

No recorded changes to this operation across all 1 revision of this API.