Customers

Retrieve a Consent

Retrieve a single Consent by its consentId. A record of a customer's consent, scoped to one Product, a set of providers and data categories. The record carries its status, version and expiry.

get/v1/consents/{consentId}

Request

  • Base URL: https://hyperscale0.ai
  • URL: https://hyperscale0.ai/v1/consents/{consentId}
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Path parameters

consentIdstring required

Query parameters

productIdstring

Hyperscale product ID

Headers

X-Hyperscale-Environment'sandbox' | 'live'

Response

Success

consentIdstring required

Hyperscale customer consent ID

tenantIdstring required

Organization tenant ID

productIdstring

Hyperscale product ID

customerIdstring

Tenant-local customer ID

subjectIdstring
subjectKindstring
status'active' | 'expired' | 'revoked'
versionstring
expiresAtstring date-time
createdAtstring date-time

Changes

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