Skip to main content
POST
fraud.data.erase

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string
required

Required: this capability has an external effect.

Maximum string length: 255
Pramaan-Account
string

Optional. One of your account ids (GET /v1/accounts): run on that account, whatever your routing rules say. The response header X-Pramaan-Account names the account that ran.

Pramaan-End-User
string

Optional. Your own tag for your end user: a sticky: end_user rule keeps them on the account that first served them.

Maximum string length: 256
Pramaan-End-User-Group
string

Optional. Your end user's group, matched by rules with endUserGroup.

Maximum string length: 64

Body

application/json
confirm
boolean
required

Required: explicitly confirm permanent erasure.

domains
enum<string>[]
required

Data domains to erase.

Required array length: 1 - 3 elements
Available options:
events,
screenings,
cases
subjectKeys
string[]

Your subject keys in the connected account.

Maximum array length: 100

Your subject key.

Required string length: 1 - 256
eventKeys
string[]

Your event keys in the connected account.

Maximum array length: 100

Your event key.

Required string length: 1 - 255
emails
string[]

Exact mailbox targets in your connected account.

Maximum array length: 100
Required string length: 1 - 320
start
string

Calendar date, YYYY-MM-DD.

Pattern: ^\d{4}-\d{2}-\d{2}$
end
string

Calendar date, YYYY-MM-DD.

Pattern: ^\d{4}-\d{2}-\d{2}$

Response

The result

status
enum<string>
required

Erasure was accepted, not yet proven complete.

Available options:
accepted,
pending
ref
string

Reference to what this call created. Pass it as ref to Follow-up calls for fraud-erasure..