Close an entity

DELETE

/entities/{id}

Closes (soft-deletes) an entity by setting its status to closed. The record itself is not physically removed — this is an irreversible lifecycle transition, not a hard delete. The identity must have can_delete_entity or wildcard * ACL access to the entity.

An entity cannot be closed if any of the following are true: it is already closed; it has one or more child entities (close all children first); it has one or more accounts that are not themselves closed; or it has one or more payout intents that have not reached a terminal state (successful, completed, failed, rejected, or cancelled).

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

Responses

🟢200

application/json

The entity was closed successfully.

Bodyapplication/json

🟠400

🟠401

🟠403

🟠404

Request Example

Shell

JavaScript

Java

Swift

curl --location --request DELETE '/entities/01JABC1234567890ABCDEFGHIJ' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Success

{
    "message": "Entity closed successfully",
    "status": "success",
    "data": {
        "id": "01JABC1234567890ABCDEFGHIJ",
        "status": "closed"
    }
}

Modified at 2026-09-30 00:29:30

List entities

Update an entity