Delete API

The following document highlights the details of the Delete API.

API Description

Objective

The Delete API permanently deletes a specified transaction and all associated API call records from the system, including database entries and linked files.

Input	Output
The unique identifier of the transaction to be deleted	The deletion confirmation, a status message, and the list of deleted API call request IDs. The complete list of output fields is available in the Success Response Details section.

Irreversible Operation

Deleted data is permanently removed from all systems. This cannot be undone.

Data Retention Policy

HyperVerge offers a configurable retention policy (for example, a seven day window) after which transaction data is automatically purged. The Delete API lets you delete data on demand, before the configured retention period elapses or independent of any retention policy.

API URL

https://review-api.idv.hyperverge.co/api/v2/transaction/id

API Endpoint

v2/transaction/id

Overview

The Delete API is RESTful and uses standard HTTP verbs and status codes. Responses are in JSON format; send all request data as a JSON body in a DELETE request.

Method - DELETE

Authentication

You need a valid appid and appkey from HyperVerge to authenticate requests to the Delete API.

IP Whitelisting Required

Your request must originate from a whitelisted IP address. Non-whitelisted IPs return a 403 Forbidden error. Contact HyperVerge to whitelist your IP before using this endpoint.

Headers

Parameter	Mandatory / Optional	Description	Input Format
content-type	Mandatory	This parameter defines the media type for the request payload	application/json
appid	Mandatory	The application identifier shared by HyperVerge. You can find the details in the dashboard's credentials tab.	Unique value
appkey	Mandatory	The application key shared by HyperVerge. You can find the details in the dashboard's credentials tab.	Unique value

Inputs

The following table provides the details of the parameter required for the API:

The request body takes a single parameter:

Parameter	Mandatory / Optional	Type	Description	Input Format	Default Value
transactionId	Mandatory	string	The unique identifier of the transaction to be permanently deleted	Not Applicable	Not Applicable

Request

The following sample code shows the standard curl request for the API:

curl --location --request DELETE 'https://review-api.idv.hyperverge.co/api/v2/transaction/id' \
--header 'appid: <Enter_the_App_ID>' \
--header 'appkey: <Enter_the_App_Key>' \
--header 'Content-Type: application/json' \
--data '{
    "transactionId": "<Enter_the_Transaction_ID>"
}'

Success Response

The following is a sample response for a successful deletion:

{
    "status": "success",
    "statusCode": "200",
    "message": "Data successfully deleted for <App_ID>'s transaction: <Transaction_ID>",
    "deletedAudits": [
        "<Request_ID_1_Transaction_ID_X>",
        "<Request_ID_2_Transaction_ID_X>",
        "<Request_ID_3_Transaction_ID_X>"
    ]
}

Success Response Details

Parameter	Type	Description
status	string	The status of the request
statusCode	string	The HTTP status code returned by the Delete API
message	string	A confirmation message describing the deleted transaction and the associated application
deletedAudits	array	API call request IDs associated with the deleted transaction

Error Responses

The following are sample error responses and their respective error codes:

Invalid Credentials

{
  "status": "failure",
  "statusCode": "401",
  "error": "Missing/Invalid credentials"
}

IP Not Whitelisted

{
  "status": "forbidden",
  "statusCode": "403",
  "message": "No whitelisted IPs match found"
}

Invalid Input

{
  "status": "failure",
  "statusCode": "422",
  "error": "\"transactionId\" is required"
}

Internal Server Error

{
  "status": "failure",
  "statusCode": "500",
  "error": "Internal Server Error"
}

Error Response Details

Status Code	Error Message	Error Description	Error Resolution
401	Missing/Invalid credentials	The request is missing the mandatory appid and appkey combination or has invalid values	Verify and provide valid credentials from the dashboard's credentials tab
403	Forbidden - IP not whitelisted	The request originates from an IP address that has not been whitelisted with HyperVerge	Contact the HyperVerge team to whitelist the IP address associated with your credentials before using this endpoint
422	Bad Request - Invalid input	The request body is missing the mandatory transactionId field or contains an invalid value	Ensure the transactionId field is present and contains a valid transaction identifier in the request body
500	Internal Server Error	An unexpected error occurred on the server	Check the request headers or contact the HyperVerge team for resolution