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_run functionality and synchronous operations from v1 are no longer available.

Good to know

  • At least one optional parameter (emails, user_ids, transaction_ids, or start/end pair) must be provided in the POST /SeonRestService/erase-api/v2 request.
  • start and end must be provided together; otherwise, the request will be rejected.
  • Future dates are not valid for start or end parameters.
  • The date range (start to end) must not exceed 7 days.

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_ids matches any value in the provided list.
  • Email matching: Include transactions where the associated emails matches any value in the provided list.
  • User ID matching: Include transactions where the associated user_ids matches any value in the provided list.
  • Date range filtering: Include only transactions created within the specified date range (start and end, both inclusive).
    • If the date range is added, it must include both a start and end value
    • The range must not exceed 7 days.

Logical combination

  • A transaction is included if:
    • The transaction_ids matches OR the emails matches OR the user_ids matches
    • AND the transaction's creation date falls within the specified date range.

Parameters

TypeRequired
domains
array of stringsyes
emails
array of stringsno
user_ids
array of stringsno
transaction_ids
array of stringsno
start
string (date)no
end
string (date)no

Logical expression of the request on the right:

All transaction will be deleted, where

  • OR emails match “test@example.com","test2@example.com"
  • OR transactionIds match "07a07b0034ef","03c2a7e5eb38"
  • OR userIds match "471817c0","ced27c0b","1b6dcd5c"
  • AND transaction date is within the specified time range

Definition of domains:

  • FRAUD: all transactions processed through the Fraud, IP, Email, and Phone APIs.
  • IDV: all data related to IDV sessions
  • AML_Name_Screening: All data processed through the AML and AML Entity APIs
  • AML_Case_Management: All data processed in relation to alerts, cases, and reports

 

HTTP Endpoint

POST

https://api.seon.io/SeonRestService/erase-api/v2
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 invalid X-API-KEY.
Response
{
  "success": true,
  "data": {
    "request_id": "0a34ddde-4723-41eb-be20-7c86602c8366",
  },
  "error": {}
}

Request - Get erase request status

Fetches the status of an erase request by its request_id.

Parameters

TypeRequired
request_id
stringyes

 

HTTP Endpoint

GET

https://api.seon.io/SeonRestService/erase-api/v2/{request_id}
cURL
Generic
Generic

Response - Get erase request status

The endpoint returns JSON structured response.

Parameters

Type
status
string

Errors

  • 400 Bad Request: Invalid request_id format.
  • 404 Not Found: No request found for the provided request_id.
  • 401 Unauthorized: Missing or invalid X-API-KEY.
Response
{
 "success": true,
 "data": {
  "request_id": "0a34ddde-4723-41eb-be20-7c86602c8366",
  "status": "IN_PROGRESS"
 },
 "error": {}
}