---
title: "Unmark for Erasure Model"
slug: "unmark-for-erasure-model"
updated: 2025-06-27T20:15:44Z
published: 2025-06-27T20:15:44Z
canonical: "docs.onespan.com/unmark-for-erasure-model"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://docs.onespan.com/llms.txt
> Use this file to discover all available pages before exploring further.

# 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)](/docs/unmark-for-erasure-model#Tab_unmark-for-erasure_properties) lists the request properties in OneSpan Identity Verification.

- Path: .../properties/transaction/properties/mark_for_erasure_request

<editor360-custom-block data-preprocessing="true" data-sanitizationtags="a"><div data-type="table-content"> <table width="951" class=" fr-alternate-rows editor360-table" borderstyle="Solid" style="max-width:951px;width:951px;"> <colgroup> <col style="width:272px;"> <col style="width:208px;"> <col style="width:471px;"> </colgroup> <tbody> <tr> <td colspan="3" rowspan="1" colwidth="272,208,471" style="vertical-align:middle;text-align:left;"> <p data-block-id="f2da6914-2925-48fe-811e-1ae921351b19"><a name="Tab_unmark-for-erasure_properties" display="false"></a><strong>Request properties (unmark for erasure)</strong></p> </td> </tr> <tr> <th colspan="1" rowspan="1" colwidth="272" class="TableStyle-Global-HeadE-Column-MainHeader" style="vertical-align:middle;text-align:left;"> <p data-block-id="89c76ab9-e3aa-4630-9afa-b809b7464318">Property</p> </th> <th colspan="1" rowspan="1" colwidth="208" class="TableStyle-Global-HeadE-Column-MainHeader" style="vertical-align:middle;text-align:left;"> <p data-block-id="32e6efe0-4056-4ffd-a1e9-b8c2c7cb322c">Type</p> </th> <th colspan="1" rowspan="1" colwidth="471" class="TableStyle-Global-HeadD-Column-MainHeader" style="vertical-align:middle;text-align:left;"> <p data-block-id="7608ecc3-ab6e-406d-836f-addb1273b642">Description</p> </th> </tr> <tr> <td colspan="1" rowspan="1" colwidth="272" style="vertical-align:middle;text-align:left;"> <p data-block-id="e11be18b-34bd-4464-86f1-8ce141367735"><span class="vdsCodeBasic" type="spanMark">transaction_ids</span></p> </td> <td colspan="1" rowspan="1" colwidth="208" style="vertical-align:middle;text-align:left;"> <p data-block-id="1917622a-d80d-4ef8-9737-05de18b0037e">Array</p> </td> <td colspan="1" rowspan="1" colwidth="471" style="vertical-align:middle;text-align:left;"> <p data-block-id="e516e688-abf2-4b8b-87e2-c718c310c430">List of transaction UUIDs.</p> <ul data-block-id="68fb15f5-3536-424a-8bb1-149c5a3c1b72"> <li data-block-id="bf0d4da6-767d-4849-b344-6cdc29203a10"> <p data-block-id="ac9d30fa-c27b-4b99-a02f-cee543099cd7">Maximum number of items: 500</p> </li> <li data-block-id="39089f11-54e2-4382-84de-a24a5c48acc1"> <p data-block-id="697fdf0d-5de7-4143-a3eb-9136b2d1fcdf">Minimum number of items: 1</p> </li> </ul> <p data-block-id="01926c80-2472-414a-8973-47d95bc7e40f">Items:</p> <ul data-block-id="90379b92-989d-492f-a0b3-c54db9c3b96c"> <li data-block-id="30c1685e-947a-4731-9472-6cf38ff7efad"> <p data-block-id="513e9bb4-0dcc-4287-8309-79882d4c4aa3">Type: string</p> </li> </ul> </td> </tr> </tbody> </table></div></editor360-custom-block>

[Response properties (unmark for erasure)](/docs/unmark-for-erasure-model#Tab_unmark-for-erasure_ResponseProperties) lists the response properties in OneSpan Identity Verification.

- Path: .../properties/transaction/properties/transaction_unmark_for_erasure_response

<editor360-custom-block data-preprocessing="true" data-sanitizationtags="a"><div data-type="table-content"> <table width="735" class=" fr-alternate-rows editor360-table" borderstyle="Solid" style="max-width:735px;width:735px;"> <colgroup> <col style="width:135px;"> <col style="width:129px;"> <col style="width:471px;"> </colgroup> <tbody> <tr> <td colspan="3" rowspan="1" colwidth="135,129,471" style="vertical-align:middle;text-align:left;"> <p data-block-id="56e80d64-7ef7-4d4f-a99f-2c73ee8f8d10"><a name="Tab_unmark-for-erasure_ResponseProperties" display="false"></a><strong>Response properties (unmark for erasure)</strong></p> </td> </tr> <tr> <th colspan="1" rowspan="1" colwidth="135" class="TableStyle-Global-HeadE-Column-MainHeader" style="vertical-align:middle;text-align:left;"> <p data-block-id="a38acfd9-2f01-4828-9091-a8f1c86abdec">Property</p> </th> <th colspan="1" rowspan="1" colwidth="129" class="TableStyle-Global-HeadE-Column-MainHeader" style="vertical-align:middle;text-align:left;"> <p data-block-id="15d2fe16-2447-4dee-ba18-3f30d6d07575">Type</p> </th> <th colspan="1" rowspan="1" colwidth="471" class="TableStyle-Global-HeadD-Column-MainHeader" style="vertical-align:middle;text-align:left;"> <p data-block-id="30a6ecde-5057-4075-95ee-c63a1ce17243">Description</p> </th> </tr> <tr> <td colspan="1" rowspan="1" colwidth="135" style="vertical-align:middle;text-align:left;"> <p data-block-id="3e2c7a00-1060-4294-a4c6-8eea4bae07bd"><span class="vdsCodeBasic" type="spanMark">message</span></p> </td> <td colspan="1" rowspan="1" colwidth="129" style="vertical-align:middle;text-align:left;"> <p data-block-id="58707434-1b2c-4432-bf44-d05842ea7e19">String</p> </td> <td colspan="1" rowspan="1" colwidth="471" style="vertical-align:middle;text-align:left;"> <p data-block-id="559293ee-1853-48c6-a3b0-6fa92085cbe6">The message that is related to the unmark-for-erasure response.</p> </td> </tr> <tr> <td colspan="1" rowspan="1" colwidth="135" style="vertical-align:middle;text-align:left;"> <p data-block-id="6a38a903-3871-4e95-9262-bed36ef9dee5"><span class="vdsCodeBasic" type="spanMark">transactions</span></p> </td> <td colspan="1" rowspan="1" colwidth="129" style="vertical-align:middle;text-align:left;"> <p data-block-id="a0b503b5-948b-469f-bac1-a29dc011fabf">Array</p> </td> <td colspan="1" rowspan="1" colwidth="471" style="vertical-align:middle;text-align:left;"> <p data-block-id="a45533b7-d331-4936-9161-b8f6e906f5f7">The information for all transactions that are part of the unmark-for- erasure response.</p> <p data-block-id="bfa2d12f-9c96-4adf-a6b8-23079298b7a5">Reference to the schema: <span class="vdsCodeBasic" type="spanMark">"transaction.schema.3.0.unmarkforerasure.response.details.json"</span>For the list of <span class="vdsCodeBasic" type="spanMark">transactions</span> properties, see <a href="/docs/unmark-for-erasure-model#Tab_unmark-for-erasure_ResponsePropertiesDetails" class="MCXref_0" rel="noopener">transactions properties</a>.</p> </td> </tr> </tbody> </table></div></editor360-custom-block><editor360-custom-block data-preprocessing="true" data-sanitizationtags="a"><div data-type="table-content"> <table width="940" class=" fr-alternate-rows editor360-table" borderstyle="Solid" style="max-width:940px;width:940px;"> <colgroup> <col style="width:245px;"> <col style="width:224px;"> <col style="width:471px;"> </colgroup> <tbody> <tr> <td colspan="3" rowspan="1" colwidth="245,224,471" style="vertical-align:middle;text-align:left;"> <p data-block-id="519e9f54-d0dd-403d-a34d-3eb2522c5a45"><a name="Tab_unmark-for-erasure_ResponsePropertiesDetails" display="false"></a><span class="vdsCodeBasic" type="spanMark"><strong>transactions</strong></span><strong> properties</strong></p> </td> </tr> <tr> <th colspan="1" rowspan="1" colwidth="245" class="TableStyle-Global-HeadE-Column-MainHeader" style="vertical-align:middle;text-align:left;"> <p data-block-id="77fe8b54-77e7-4c53-861c-e29b0a04c4eb">Property</p> </th> <th colspan="1" rowspan="1" colwidth="224" class="TableStyle-Global-HeadE-Column-MainHeader" style="vertical-align:middle;text-align:left;"> <p data-block-id="b0e96b7a-8a0c-4d23-b5e9-e9b0df7f2491">Type</p> </th> <th colspan="1" rowspan="1" colwidth="471" class="TableStyle-Global-HeadD-Column-MainHeader" style="vertical-align:middle;text-align:left;"> <p data-block-id="33cb6ada-39b2-4ff7-afb9-6150ebd92135">Description</p> </th> </tr> <tr> <td colspan="1" rowspan="1" colwidth="245" style="vertical-align:middle;text-align:left;"> <p data-block-id="48736936-cfa2-47a6-8757-e5688f157885"><span class="vdsCodeBasic" type="spanMark">message</span></p> </td> <td colspan="1" rowspan="1" colwidth="224" style="vertical-align:middle;text-align:left;"> <p data-block-id="a6850ab7-0b2c-48c0-bd43-9d500b17fd76">String</p> </td> <td colspan="1" rowspan="1" colwidth="471" style="vertical-align:middle;text-align:left;"> <p data-block-id="77cc1b4b-7a7c-4441-b3be-b3a9bfd2c655">The message for the transaction that was unmarked for erasure.</p> </td> </tr> <tr> <td colspan="1" rowspan="1" colwidth="245" style="vertical-align:middle;text-align:left;"> <p data-block-id="1cef8bf3-de88-4740-8f65-c3e1208ef202"><span class="vdsCodeBasic" type="spanMark">transaction_id</span></p> </td> <td colspan="1" rowspan="1" colwidth="224" style="vertical-align:middle;text-align:left;"> <p data-block-id="7edf2edf-7a1c-413b-948f-0b3aebc55b91">String</p> </td> <td colspan="1" rowspan="1" colwidth="471" style="vertical-align:middle;text-align:left;"> <p data-block-id="e205f405-fd67-44d3-8b78-efa488eea17c">The transaction identifier.</p> </td> </tr> <tr> <td colspan="1" rowspan="1" colwidth="245" style="vertical-align:middle;text-align:left;"> <p data-block-id="3443397b-9cb9-4a27-aa29-e159282db33b"><span class="vdsCodeBasic" type="spanMark">unmarking_event</span></p> </td> <td colspan="1" rowspan="1" colwidth="224" style="vertical-align:middle;text-align:left;"> <p data-block-id="3ab771ee-e7e4-419b-b827-fcb8dbe672ec">String</p> </td> <td colspan="1" rowspan="1" colwidth="471" style="vertical-align:middle;text-align:left;"> <p data-block-id="8d1191d7-135c-4096-aa84-3da505c0be1b">The event that is related to the transaction that was unmarked for erasure.</p> </td> </tr> </tbody> </table></div></editor360-custom-block>

## 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. }
