Usage Info

This method permanently deletes a Business entity from the system. Use with caution as this operation cannot be undone and may have implications for any associated entities or workflows. Typically used for removing incorrect entries or during testing phases in sandbox environments.

Note that a Business entity cannot be deleted if it has associated Bank Accounts or Owners. You must first remove all associated entities using the appropriate removal methods before deletion can be completed.

Request

Authentication: KSig1-HMAC-SHA256

Parameters

Parameter	Type	Required	Description
business_id	string	Yes	The ID of the Business.

Example

{
  "business_id": "b_7eobHllxknr7mfqbjnX2Pp"
}

Response

Data

An empty data object is returned when the delete is successful.

Example

{
  "meta": {
    "status": "SUCCESS",
    "trace_id": "trc_5x2TKMKKgqVwJc4fCmWnVW",
    "version": "2025-03-24"
  },
  "data": {}
}

Errors

Error Code	HTTP Code	Possible Cause
BAD_REQUEST	400	Required parameters not provided. Invalid values provided.
ENTITY_LINKED	400	The Business cannot be deleted because it is has one or more other entities linked to it. You must first remove the association(s) before the Business can be deleted. The following methods can be used: - Bank Accounts: business.removeBankAccount - Owners: business.removeOwner
ENTITY_NOT_FOUND	400	The `business_id` provided does not exist.