Skip to main content

Delete Customer


Overview

You can delete a customer at any point, given it has not been associated with any other entities in the system, by using the DELETE method as described below.


Resource Access

Production (api.ahrvo.network)

DELETE https://api.ahrvo.network/banking/us2/v1/customer/id/{id}

Staging (gateway.ahrvo.network)

DELETE https://gateway.ahrvo.network/banking/us2/v1/customer/id/{id}

Authentication

HeaderDescription
AuthorizationBearer {JWT token}
x-api-keyYour API key
Content-Typeapplication/json

Path Parameters

ParameterTypeDescription
idintegerInternal customer ID

Example Request

DELETE /banking/us2/v1/customer/id/4015210 HTTP/1.1
Host: api.ahrvo.network
Authorization: Bearer {placeholder("JWT token")}
x-api-key: {placeholder("your-api-key")}
Content-Type: application/json

Example Response

HTTP Status: 200 OK

Important Notes

Entity Association

A customer can only be deleted if it has not been associated with any other entities in the system (e.g., accounts, external accounts, transactions, cards). If the customer is associated with other entities, the request will return a 400 Bad Request error.

Irreversible Action

Deleting a customer is an irreversible operation. Ensure you have confirmed the deletion before making the request.

Check Before Deleting

Use the Retrieve Customer by ID endpoint to verify the customer's associations before attempting deletion.


Interactive API Explorer