Redact a Transaction

This endpoint uses the POST method to redact the specific information of a particular transaction. For further details, please have a look at the responses below:

Redact a Transaction - Success

Below is a successful response to the redacted transaction:

{
  "status": "success",
  "transaction_id": "01FX6X3YH457RNDE0G2WMBGLOE",
  "redacted_at": "2022-02-03T05:35:09.843Z",
  "redacted_data": [
    "records",
    "assets",
    "face",
    "data"
  ]
}

Redact a Transaction - Error

When the server is unable to understand the request due to incorrect syntax, it will respond as follows:

{
  "error_message": "Bad Request."
}

When an incorrect or expired access token is used, the following error response will appear:

{
  "error_message": "Unauthenticated."
}

When an invalid transactionId is used, it will generate the following error response:

{
  "error_message": "The token was not found."
}

The following error response will appear if the transaction is in progress and not ready for redaction yet:

{
  "error_message": "Transaction not ready for redaction."
}

When the server encounters a situation it doesn't know how to handle, it generates the following error response:

{
  "error_message": "Internal Server Error."
}

For details on each field, please refer to the table below:

Fields	Data Type	Optional/Mandatory	Description
`status`	string	Mandatory	The redaction result status. There are two possible responses, i.e., of `success` or `error`.
`transaction_id`	string	Mandatory	The transaction ID of the record that is redacted.
`redacted_at`	timestamp	Mandatory	The timestamp when the record was redacted. Its value is `null if an error occurs.
`redacted_data`	array	Mandatory	An array of redacted data, i.e.,`records`, `assets`, `face`, and `data`.
`error_message`	string	Optional	The error message, depicting what the error actually is, for example, "Transaction not ready for redaction."

💬 We Are Here to Help!

If you encounter an issue, a bug, or require assistance, please contact our support page here to find the solution. Don't forget to provide any important information on the issue.