Mark for Erasure Model
- 07 Oct 2024
- 1 Minute to read
- DarkLight
- PDF
Mark for Erasure Model
- Updated on 07 Oct 2024
- 1 Minute to read
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
The JSON model of the mark-for-erasure API endpoint contains the data structure that is required to mark one or more transactions for deletion.
Request properties (mark for erasure) lists the request properties in OneSpan Identity Verification.
Path: .../properties/transaction/properties/mark_for_erasure_request
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 | List of transaction UUIDs.
Items:
|
Response properties (mark for erasure) lists the response properties in OneSpan Identity Verification.
Path: .../properties/transaction/properties/transaction_mark_for_erasure_response
Property | Type | Description |
|---|---|---|
message | String | The message for the mark-for-erasure response. |
transactions | Array | The information for all transactions that are part of the mark-for-erasure response. Reference to the schema: "transaction.schema.3.0.markforerasure.response.details.json" For the list of transactions properties, see transactions properties. |
Property | Type | Description |
|---|---|---|
marking_event | String | The event that is related to the transaction that was marked for erasure. |
message | String | The message for the transaction that was marked for erasure. |
transaction_id | String | The transaction identifier. |
Example mark-for-erasure request
{
"grace_period": 25,
"transaction_ids": [
"6cca2f64-2781-49fc-85de-f80361581968",
"6cca2f64-2781-49fc-85de-f80361581969",
"6cca2f64-2781-49fc-85de-f80361581970"
]
}
Example mark-for-erasure response
{
message: "Some of the transactions could be marked for erasure other couldn't."
transactions: [
{
transaction_id: "xxxx-xxxxxx-xxxxxxx-xxxxxx",
marking_event: "Transaction Erase Request - Accepted"
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)."
},
{
transaction_id: "xxxx-xxxxxx-xxxxxxx-xxxxxx",
marking_event: "Transaction Erase Request - ID field error"
message: "This transaction doesn't exist, therefore cannot be marked for erasure."
},
{
transaction_id: "xxxx-xxxxxx-xxxxxxx-xxxxxx",
marking_event: "Transaction Erase Request - Transaction Not Found"
message: "This transaction doesn't exist, therefore cannot be marked for erasure."
},
{
transaction_id: "xxxx-xxxxxx-xxxxxxx-xxxxxx",
marking_event: "Transaction Erase Request - Transaction currently active"
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."
},
{
transaction_id: "xxxx-xxxxxx-xxxxxxx-xxxxxx",
marking_event: "Transaction Erase Request - Fail" # Note that if this generic use case doesn't exist, don't create it.
message: "Failed to mark for erasure. {descriptive_error_message}"
message: "Failed to mark for erasure, the transaction was locked, please try again later."
}
]
}
Was this article helpful?