Unmark for Erasure Model
  • 07 Oct 2024
  • 1 Minute to read
  • Dark
    Light
  • PDF

Unmark for Erasure Model

  • Dark
    Light
  • PDF

Article summary

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. transactions: [

  4.  {

  5.    transaction_id: "xxxx-xxxxxx-xxxxxxx-xxxxxx",

  6.    unmarking_event: "Transaction Recovery - Accepted" # TBC Transaction Recovery - Unmarked

  7.    message: "Success unmarked for erasure and won't be deleted until the data retention policy has been reached." # In 1 Use Case

  8.  },

  9.  {

  10.    transaction_id: "xxxx-xxxxxx-xxxxxxx-xxxxxx",

  11.    unmarking_event: "Transaction Recovery - ID field error"

  12.    message: ""

  13.  },

  14.  {

  15.    transaction_id: "xxxx-xxxxxx-xxxxxxx-xxxxxx",

  16.    unmarking_event: "Transaction Recovery - Transaction Not Found"

  17.    message: "This transaction doesn't exist, therefore cannot be marked for erasure."

  18.  },

  19.  {

  20.    transaction_id: "xxxx-xxxxxx-xxxxxxx-xxxxxx",

  21.    unmarking_event: "Transaction Recovery - Fail"

  22.    message: "Failed to unmark for erasure, the transaction was not marked for erasure."

  23.  }

  24. ]

  25. }


Was this article helpful?

Changing your password will log you out immediately. Use the new password to log back in.
First name must have atleast 2 characters. Numbers and special characters are not allowed.
Last name must have atleast 1 characters. Numbers and special characters are not allowed.
Enter a valid email
Enter a valid password
Your profile has been successfully updated.
ESC

Ozzy, our interactive help assistant