Skip to content
Elara One docs
Consent

Get a consent record

GET
/v1/merchant/consent/records/{id}

One consent record: the choice, where and when it was made, the banner, privacy notice and storage register versions in force, whether it was replaced, and the banner version exactly as the shopper saw it. 404 NOT_FOUND for an unknown id or a record removed by retention.

Authorization

tenantKeybearerAuth
headerX-Tenant-Key<token>

The public store key (pk_live_…). Required on every call.

headerAuthorizationBearer <token>

A customer token from POST /v1/auth/login, or a merchant API key, on routes that need one.

Path Parameters

id*integer

Header Parameters

X-Client-IP?string

Optional. IP address of the shopper (one IPv4/IPv6, no port, no list). Honoured only together with a valid X-Tenant-Secret; ignored otherwise. Used for rate limits and recorded with form submissions.

X-Tenant-Secret?string

Optional here. Server secret of the store: server-to-server only, never from a browser. Enables X-Client-IP.

Response Body

Success.

application/json
  1. response
data*
Example Request
curl -X GET 'https://api.elaraone.app/api/v1/merchant/consent/records/0' \  -H 'X-Tenant-Key: pk_live_…' \  -H 'X-Tenant-Secret: your-server-secret'
Example Response
{  "data": {    "id": 0,    "customer_id": 0,    "categories": {      "analytics": true,      "advertising": true,      "personalisation": true    },    "consent_mode": {      "property1": "granted",      "property2": "granted"    },    "choice": "accept_all",    "source": "banner",    "versions": {      "banner": 0,      "privacy_notice": "string",      "storage_register": "string"    },    "recorded_at": "string",    "expires_at": "string",    "superseded_at": "string",    "superseded_by_id": 0,    "relied_on_at": "string",    "banner": {      "version": 0,      "privacy_notice_version": "string",      "title": "string",      "body": "string",      "labels": {        "accept_all": "string",        "reject_all": "string",        "manage": "string",        "save": "string",        "settings_link": "string"      },      "links": {        "privacy_notice": "string",        "cookie_table": "string"      },      "strictly_necessary": {        "label": "string",        "description": "string"      },      "categories": [        {          "key": "analytics",          "label": "string",          "description": "string"        }      ],      "notice_purpose_change": true,      "purposes_version": 0,      "published_by": "string",      "published_at": "string"    }  }}

Publish the consent banner PUT

Sends the whole banner. Any change to the wording, categories, links or privacy notice version publishes a new, immutable version (`201`); an identical banner publishes nothing (`200`, the current version). Shoppers are asked again only when the banner offers a new category or the new privacy notice version is marked `notice_purpose_change`.