Skip to content
Neattrim

Rights request: access, export, delete, correct, restrict, object, withdraw consent, appeal

View as Markdown · Open in Claude Desktop

Endpoint
POST /v1/privacy/requests
Who can call it
An API key, or an OAuth token for an app.

Parameters

Parameters
NameInTypeRequiredDescription
Idempotency-KeyheaderstringnoRequired on POSTs that create a job, upload, checkout, plan change or top-up; stored 24 h per ledger subject; same key with a different body returns 409 IDEMPOTENCY_MISMATCH

Request body

Request body
NameTypeRequiredDescription
typeanyyes (one of "access", "export", "delete", "correct", "restrict", "object", "withdraw_consent", "appeal", "child_data", "other")
messagestringno
emailstringno

Examples

Set NEATTRIM_API_KEY to your key, then copy an example. A tool that draws from your allowance reads an uploaded file: upload a sample file as in the quickstart and set VIDEO_FILE_ID (or AUDIO_FILE_ID, IMAGE_FILE_ID, SUBTITLES_FILE_ID) to its file_id. Any other id in an example, such as JOB_ID, is read from a variable of the same name.

curl -X POST "https://api.neattrim.com/v1/privacy/requests" \
  -H "Authorization: Bearer $NEATTRIM_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"type":"access"}'

Response

202
Received; the response is the same whether or not the address exists
Response 202
NameTypeRequiredDescription
statusanyno (one of "received", "verify_email_sent")

Errors

400
BAD_REQUEST
429
RATE_LIMITED

Every error code and its fix