Privacy

API version

2026-11-11 (latest)next (preview)

PreviewDownload OpenAPI (JSON)Versioning

Preview

next shows changes that are not released or not stable yet. Use the current version for production integrations.

Request erasure

POST /api/v1/gdpr/deletion-requests

File a data-subject erasure request for review. Idempotent; an existing open request is returned instead of a duplicate.

Authentication

• API key in X-API-Key
• API key or session token in Authorization: Bearer

Request body

application/json

• reason string or null

  Maximum length

  2000

Responses

• 200 The request.

  application/json

  Body (application/json)

  • success boolean
  • request object or null
    2 fields in request

    • id string
    • status string

      One of

      pending approved completed failed rejected

• 401 Missing, invalid, expired or revoked credentials.Error envelope
• 429 A per-user limit was exceeded (the Platform API, embeddings or rerank). This response does not use the error envelope. Wait for Retry-After seconds.

  application/json

  Headers

  • X-Request-ID string

    The request's correlation id (yours, or one BreachLine generated). Quote it to support.

  • Retry-After integer

    Seconds to wait before retrying.

  Body (application/json)

  • detail string Required
  • retry_after integer Required

    Always

    60

Example

cURLCopy

curl -X POST "https://api.breachline.io/api/v1/gdpr/deletion-requests" \
  -H "Authorization: Bearer $BREACHLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

Example 200 responseCopy

{
  "success": true,
  "request": {
    "id": "string",
    "status": "pending"
  }
}

Get your erasure request

GET /api/v1/gdpr/deletion-requests/me

Authentication

• API key in X-API-Key
• API key or session token in Authorization: Bearer

Responses

• 200 Your most recent request, or null.

  application/json

  Body (application/json)

  • success boolean
  • request object or null
    2 fields in request

    • id string
    • status string

      One of

      pending approved completed failed rejected

• 401 Missing, invalid, expired or revoked credentials.Error envelope
• 429 A per-user limit was exceeded (the Platform API, embeddings or rerank). This response does not use the error envelope. Wait for Retry-After seconds.

  application/json

  Headers

  • X-Request-ID string

    The request's correlation id (yours, or one BreachLine generated). Quote it to support.

  • Retry-After integer

    Seconds to wait before retrying.

  Body (application/json)

  • detail string Required
  • retry_after integer Required

    Always

    60

Example

cURLCopy

curl "https://api.breachline.io/api/v1/gdpr/deletion-requests/me" \
  -H "Authorization: Bearer $BREACHLINE_API_KEY"

Example 200 responseCopy

{
  "success": true,
  "request": {
    "id": "string",
    "status": "pending"
  }
}