Unova
Loading...
Documentation

SDK, REST API & Security

Integrate DSARs (access, rectification, erasure), consents, cookie preferences, transparency and auditing with SDK, REST and HMAC webhooks. KMS/BYOK, field-level encryption and secure request↔response correlation.

REST API SDK HMAC webhooks KMS / BYOK End-to-end encryption

Getting started

Unova offers a complete privacy and compliance platform: DSARs (access, rectification, erasure), consents, cookie preferences, transparency, auditing and reporting – with a REST API, SDK, HMAC webhooks, KMS/BYOK and end-to-end encryption.

  1. Step 1

    Create your account

    Legal, technology, cybersecurity and customer service/support team.

  2. Step 2

    Configure policies

    Map systems, purposes, legal bases and retention rules for your data.

  3. Step 3

    Integrate

    Use the SDK/REST, enable DSARs and publish/respond through the data subject portal.

Environments & endpoints

Environment:

Base URL

Status

Authentication

Bearer / JWT

Send Authorization: Bearer <TOKEN> in every request.

Correlation

Use X-Request-Id (UUID) to link request↔response and logs.

Idempotency

Safe retries with X-Idempotency-Key.

REST endpoints

POST /v1/dsars type=access
Roles: admin, dpo, legal Scopes: dsar:write

Request:

{não disponível}

Response (200):

{não disponível}

Use receipt.signature as proof for auditing purposes.

POST /v1/dsars type=rectification
Roles: admin, dpo, legal Scopes: dsar:write
{não disponível}

Optional: include changes with the fields and values to be corrected.

POST /v1/dsars type=erasure
Roles: admin, dpo, legal Scopes: dsar:write
{não disponível}

Supports scope by systems/purposes while respecting retention rules.

GET /v1/dsars/{id}
Roles: admin, dpo, legal, suporte Scopes: dsar:read
Returns updated status, history and a signed receipt.
POST /v1/consents
Roles: admin, dpo, legal Scopes: consent:write
Registers/updates consents with proof of record and preferences by purpose.
POST /v1/cookies/preferences
Roles: admin, dpo, legal, web Scopes: cookie:write

Defines preferences by category (e.g. essential, statistics, marketing) with proof of record.

{não disponível}
GET /v1/cookies/preferences/{subjectId}
Roles: admin, dpo, legal, web, suporte Scopes: cookie:read
Returns current preferences and a proof stamp.

HMAC webhooks

Validate the signature via X-Unova-Signature using the raw body of the request.

EVENTS dsar.updated, consent.changed, cookies.preference.changed, policy.updated…
{não disponível}

Encryption & KMS

In transit & at rest

TLS 1.2+ in transit and AES-256 at rest (Cloud KMS). Usage logs and key rotation.

KMS / BYOK

Bring your own keys (BYOK) and control rotation and access cycles.

Field-level encryption

Field-level encryption via SDK (WebCrypto/Libsodium). Keys never leave your domain.

SDK & Examples

Install the official SDK and get started in minutes.

Installation

{não disponível}

Create DSAR with SDK

{não disponível}

Errors & Limits

Error pattern

{
"error": { "code": "invalid_request", "message": "Missing subjectId", "requestId": "7b5f6e5d-21d0..." }
}

We always return requestId in the error.

Rate limits

  • 429 when the limit is exceeded.
  • Use Retry-After for exponential backoff.
  • Idempotency is recommended with X-Idempotency-Key.

Changelog

v1.12.0 2025-08-15
  • Webhook policy.updated
  • Support for X-Idempotency-Key in all POST requests
  • Audit improvements in the receipt
v1.11.0 2025-07-10
  • Endpoint /v1/consents with proof of record
  • Scope fields in DSARs (scope[])
v1.10.0 2025-06-03
  • HMAC SHA-256 enabled in webhooks
  • Public sandbox for testing

Quick FAQ

Which languages are supported?

SDKs in JS/TS, Python, PHP and Go. REST is available for any language.

How do I get my token?

In Settings → API on the Unova dashboard (appropriate roles are required).

Is there a sandbox environment?

Yes. Use https://api.sandbox.unova.digital for testing.

Blockchain/legal receipt?

Critical events can generate a signed receipt and an anchored hash for legal assurance.

Take control of your personal data.

Manage consents and preferences with transparency – in compliance with LGPD/GDPR.

We use cookies to improve your experience

Some are essential and others help us understand how you use the site.
You can accept all, reject non-essential ones or customise.
Read our Privacy Policy.