Unmark for Erasure Model
- 07 Oct 2024
- 1 Minute à lire
- SombreLumière
- PDF
Unmark for Erasure Model
- Mis à jour le 07 Oct 2024
- 1 Minute à lire
- SombreLumière
- PDF
The content is currently unavailable in French. You are viewing the default English version.
Résumé de l’article
Avez-vous trouvé ce résumé utile ?
Merci pour vos commentaires
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
Property | Type | Description |
|---|---|---|
transaction_ids | Array | List of transaction UUIDs.
Items:
|
Response properties (unmark for erasure) lists the response properties in OneSpan Identity Verification.
Path: .../properties/transaction/properties/transaction_unmark_for_erasure_response
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. |
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
{
"transaction_ids": [
"6cca2f64-2781-49fc-85de-f80361581968",
"6cca2f64-2781-49fc-85de-f80361581969",
"6cca2f64-2781-49fc-85de-f80361581970"
]
}'
Example unmark-for-erasure response
{
message: "Some of the transactions could be unmarked for erasure other couldn't."
transactions: [
{
transaction_id: "xxxx-xxxxxx-xxxxxxx-xxxxxx",
unmarking_event: "Transaction Recovery - Accepted" # TBC Transaction Recovery - Unmarked
message: "Success unmarked for erasure and won't be deleted until the data retention policy has been reached." # In 1 Use Case
},
{
transaction_id: "xxxx-xxxxxx-xxxxxxx-xxxxxx",
unmarking_event: "Transaction Recovery - ID field error"
message: ""
},
{
transaction_id: "xxxx-xxxxxx-xxxxxxx-xxxxxx",
unmarking_event: "Transaction Recovery - Transaction Not Found"
message: "This transaction doesn't exist, therefore cannot be marked for erasure."
},
{
transaction_id: "xxxx-xxxxxx-xxxxxxx-xxxxxx",
unmarking_event: "Transaction Recovery - Fail"
message: "Failed to unmark for erasure, the transaction was not marked for erasure."
}
]
}
Cet article vous a-t-il été utile ?