Mark for erasure model

The JSON model of the mark-for-erasure API endpoint contains the data structure required to mark one or more transactions for deletion.

Mark for erasure request properties lists the request properties in OneSpan Identity Verification.

  • Path: .../properties/transaction/properties/mark_for_erasure_request
Mark for erasure request properties
Property Type Description
grace_period Integer

The period of time during which users can revert the transaction erasure request. After the grace period has elapsed, the transaction is deleted.

Possible values: greater than or equal to 0.

If grace_period is 0, the transaction is not available for recovery (see Unmark Transaction for Erasure) and is deleted on the day it is marked for erasure.

transaction_ids Array of strings

List of transaction UUIDs. Must contain at least 1 UUID but cannot contain more than 500 UUIDs.

Minimum number of items: 1

Maximum number of items: 500

Mark for erasure response properties lists the response properties in OneSpan Identity Verification.

  • Path: .../properties/transaction/properties/transaction_mark_for_erasure_response
Mark for erasure response properties
Property Type Description
message String

The message related to the mark-for-erasure response.

transactions Array of objects

The information of all transactions contained in the mark-for- erasure response.

Reference to the schema: "transaction.schema.3.0.markforerasure.response.details.json"

Mark for erasure response properties (details) lists the response details in OneSpan Identity Verification.

  • Path: .../properties/transaction/properties/mark_for_erasure_response_details

Mark for erasure response properties (details)
Property Type Description
transaction_id String The transaction identifier
marking_event String The event related to the transaction erasure mark
message String The message related to the transaction erasure mark

Example mark-for-erasure request

  1. {
  2.   "grace_period": 25,
  3.   "transaction_ids": [
  4.     "6cca2f64-2781-49fc-85de-f80361581968",
  5.     "6cca2f64-2781-49fc-85de-f80361581969",
  6.     "6cca2f64-2781-49fc-85de-f80361581970"
  7.   ]
  8. }

Example mark-for-erasure response

  1. {
  2. message: "Some of the transactions could be marked for erasure other couldn't."
  3.  
  4. transactions: [
  5.  
  6.   {
  7.     transaction_id: "xxxx-xxxxxx-xxxxxxx-xxxxxx",
  8.     marking_event: "Transaction Erase Request - Accepted"
  9.     message: "The transaction has been accepted to be marked for erasure, there could be a short period where the transaction is recoverable, it depends on the data retention policy (grace period)."
  10.   },
  11.  
  12.   {
  13.     transaction_id: "xxxx-xxxxxx-xxxxxxx-xxxxxx",
  14.     marking_event: "Transaction Erase Request - ID field error"
  15.     message: "This transaction doesn't exist, therefore cannot be marked for erasure."
  16.   },
  17.  
  18.   {
  19.     transaction_id: "xxxx-xxxxxx-xxxxxxx-xxxxxx",
  20.     marking_event: "Transaction Erase Request - Transaction Not Found"
  21.     message: "This transaction doesn't exist, therefore cannot be marked for erasure."
  22.   },
  23.  
  24.   {
  25.     transaction_id: "xxxx-xxxxxx-xxxxxxx-xxxxxx",
  26.     marking_event: "Transaction Erase Request - Transaction currently active"
  27.     message: "Failed to mark for erasure, the transaction was active (New or In Post Processing), if it needs to be mark for erasure, it must first be cancelled."
  28.   },
  29.  
  30.   {
  31.     transaction_id: "xxxx-xxxxxx-xxxxxxx-xxxxxx",
  32.     marking_event: "Transaction Erase Request - Fail" # Note that if this generic use case doesn't exist, don't create it.
  33.     message: "Failed to mark for erasure. {descriptive_error_message}"
  34.     message: "Failed to mark for erasure, the transaction was locked, please try again later."
  35.   }
  36.  
  37. ]
  38. }