Unmark for erasure model

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

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

  • Path: .../properties/transaction/properties/mark_for_erasure_request
Unmark for erasure request properties
Property Type Description
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

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

  • Path: .../properties/transaction/properties/transaction_unmark_for_erasure_response
Unmark for erasure response properties
Property Type Description
message String

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

transactions Array of objects

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

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

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

  • Path: .../properties/transaction/properties/unmark_for_erasure_response_details

Unmark for erasure response properties (details)
Property Type Description
transaction_id String

The transaction identifier

unmarking_event String

The event related to the transaction unmark erasure mark

message String The message related to transaction unmark 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. }