v52

latestOpenAPI 3.0.1raw.githubusercontent.com2026-08-01353775.9 KB
Customer

post/v1/customer/erasure

Request body

confirmboolean required

Must be true to acknowledge that erasure is irreversible. Required in the request body so the signed payload is specific to an erasure request and cannot be a replayed non-erasure request.

remoteIdstring

The id of the customer in the ticketing system. Provide exactly one of remoteId, email, or phoneNumber.

emailstring email

The email of the customer. Matches case-insensitively; may resolve to more than one customer.

phoneNumberstring

The phone number of the customer (in international / E.164 format). May resolve to more than one customer.

Example request

{
  "confirm": true,
  "remoteId": "1234567890",
  "email": "lori@keet.com",
  "phoneNumber": "+14155552671"
}

Response

Erasure accepted and started asynchronously. Poll each returned requestId for status. Redaction is irreversible.

Example response

{
  "requests": [
    {
      "requestId": "e63d04d0-cfd4-46ad-9186-20ee31a8563b",
      "customerId": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
      "status": "EXECUTION_PENDING"
    }
  ]
}