Unmark for erasure model

The JSON model of the unmark-for-erasure API endpoint contains the data structure that is required to recover transactions that were previously marked for erasure.

Request properties (unmark for erasure) lists the request properties in OneSpan Identity Verification.

  • Path: .../properties/transaction/properties/mark_for_erasure_request
Request properties (unmark for erasure)
Property Type Description
transaction_ids Array

List of transaction UUIDs.

  • Maximum number of items: 500
  • Minimum number of items: 1

Items:

  • Type: string

Response properties (unmark for erasure) lists the response properties in OneSpan Identity Verification.

  • Path: .../properties/transaction/properties/transaction_unmark_for_erasure_response
Response properties (unmark for erasure)
Property Type Description
message String

The message that is related to the unmark-for-erasure response.
transactions Array

The information for all transactions that are part of the unmark-for- erasure response.

Reference to the schema: "transaction.schema.3.0.unmarkforerasure.response.details.json"For the list of transactions properties, see transactions properties.
transactions properties
Property Type Description
message String The message for the transaction that was unmarked for erasure.
transaction_id String

The transaction identifier.
unmarking_event String

The event that is related to the transaction that was unmarked for erasure.

Example unmark-for-erasure request

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

Example unmark-for-erasure response

  1. {
  2. message: "Some of the transactions could be unmarked for erasure other couldn't."
  3.  
  4. transactions: [
  5.  
  6.   {
  7.     transaction_id: "xxxx-xxxxxx-xxxxxxx-xxxxxx",
  8.     unmarking_event: "Transaction Recovery - Accepted" # TBC Transaction Recovery - Unmarked
  9.     message: "Success unmarked for erasure and won't be deleted until the data retention policy has been reached." # In 1 Use Case
  10.   },
  11.  
  12.   {
  13.     transaction_id: "xxxx-xxxxxx-xxxxxxx-xxxxxx",
  14.     unmarking_event: "Transaction Recovery - ID field error"
  15.     message: ""
  16.   },
  17.  
  18.   {
  19.     transaction_id: "xxxx-xxxxxx-xxxxxxx-xxxxxx",
  20.     unmarking_event: "Transaction Recovery - 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.     unmarking_event: "Transaction Recovery - Fail"
  27.     message: "Failed to unmark for erasure, the transaction was not marked for erasure."
  28.   }
  29.  
  30. ]
  31. }