Erase API
Key functions in v2
- Time-range-based deletion: Delete data within a specified start and end date.
- Expanded deletion options: Supports filtering by user IDs, emails, and transaction IDs, and combinations of these within date ranges.
- Enhanced logging: Logs all requests and outcomes for audit and traceability.
- Deprecation of v1: The
dry_runfunctionality and synchronous operations from v1 are no longer available.
Good to know
- At least one optional parameter (
emails,user_ids,transaction_ids, orstart/endpair) must be provided in thePOST /SeonRestService/erase-api/v2request. startandendmust be provided together; otherwise, the request will be rejected.- Future dates are not valid for
startorendparameters. - The date range (
starttoend) must not exceed 7 days. - If multiple transactions share the same session (e.g. repeated account_register or login attempts from the same device), erasing one of them also deletes the underlying session record. Any other, non-erased transaction referencing that session ID will then lose its device/session data — in the transaction view, the Device widget, and exports — even though its own device fingerprinting completed successfully.
- Velocity Signals (Aggregates): Erased transactions are removed from transaction data within the timeframe above. Aggregate values that included an erased transaction (e.g. counts per user ID or email) are recalculated once the aggregation window containing that transaction closes, which can take up to 30 days. Until then, these values may still reflect the erased transaction in aggregates shown in the Admin UI.
In the worst-case scenario, when multiple deeply integrated systems are involved, the entire deletion process may take up to two days to complete. Regardless, you will receive a notification once the process is complete.
Public endpoints
Request - Create erase
Creates an erase request based on the provided parameters and returns a request_id for valid requests.
Ruleset for filtering transactions
- Transaction ID matching: Include transactions where the
transaction_idsmatches any value in the provided list. - Email matching: Include transactions where the associated
emailsmatches any value in the provided list. - User ID matching: Include transactions where the associated
user_idsmatches any value in the provided list. - Date range filtering: Include only transactions created within the specified date range (
startandend, both inclusive).- If the date range is added, it must include both a
startandendvalue - The range must not exceed 7 days.
- If the date range is added, it must include both a
Logical combination
- A transaction is included if:
- The
transaction_idsmatchesORtheemailsmatchesORtheuser_idsmatches ANDthe transaction's creation date falls within the specified date range.
- The
Parameters | Type | Required | |
|---|---|---|---|
domains | array of strings | yes | |
emails | array of strings | no | |
user_ids | array of strings | no | |
transaction_ids | array of strings | no | |
start | string (date) | no | |
end | string (date) | no | |
Logical expression of the request on the right:
All transaction will be deleted, where
ORemailsmatch “test@example.com","test2@example.com"ORtransactionIdsmatch "07a07b0034ef","03c2a7e5eb38"ORuserIdsmatch "471817c0","ced27c0b","1b6dcd5c"ANDtransaction date is within the specified time range
Definition of domains:
FRAUD: all transactions processed through the Fraud, IP, Email, and Phone APIs.AML_Name_Screening: All data processed through the AML and AML Entity APIsAML_Case_Management: All data processed in relation to alerts, cases, and reports
HTTP Endpoint
cURL
Generic
Generic
Response - Create erase
The endpoint returns JSON structured response.
JSON Attributes | Type | |
|---|---|---|
request_id | string | |
Errors
400 Bad Request: Missing required parameters, invalid parameter values, or date range issues.401 Unauthorized: Missing or invalidX-API-KEY.
Response
Request - Get erase request status
Fetches the status of an erase request by its request_id.
Parameters | Type | Required | |
|---|---|---|---|
request_id | string | yes | |
HTTP Endpoint
cURL
Generic
Generic
Response - Get erase request status
The endpoint returns JSON structured response.
Parameters | Type | |
|---|---|---|
status | string | |
Errors
400 Bad Request: Invalidrequest_idformat.404 Not Found: No request found for the providedrequest_id.401 Unauthorized: Missing or invalidX-API-KEY.