Skip to main content
GET
Retrieve a privacy request

Authorizations

x-api-key
string
header
required

Unified API key for server-side SDK and API integrations

Path Parameters

requestId
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Response

Default Response

id
string
required
type
enum<string>
required
Available options:
access,
erasure
status
enum<string>
required

pending/running: in progress; ready: the export can be downloaded; expired: the export was deleted 7 days after it was built; completed: finished with nothing to download (an erasure, or no data was held); failed: see failureReason.

Available options:
pending,
running,
ready,
expired,
failed,
completed
source
string
required

Where the request came from, e.g. dashboard or api.

subject
object | null
required

The Profile while it exists; null once it is erased.

subjectReference
string
required

A masked identifier of the person (a prefix of their email hash).

requestedAt
string<date-time>
required
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
completedAt
string<date-time> | null
required
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
expiresAt
string<date-time> | null
required

When an export stops being downloadable; null for erasures.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
failureReason
string | null
required

Reason code of a failed request, e.g. build_failed.

resultReason
enum<string> | null
required

no_data_held when a completed access request found no data about the person; null otherwise.

Available options:
no_data_held