POST
Close an account

Authorizations

Authorization
string
header
required

The back-office user's id_token — the ID token, not the access_token. The API rejects access tokens.

Path Parameters

customerId
string<uuid>
required

The customer's ID.

accountId
string<uuid>
required

The account's ID.

Query Parameters

programId
string
required

The program the customer/account belongs to. Required on every request.

Body

application/json
reason
string
required

Why the status is changing — stored on the customer's or account's status history for audit.

Minimum string length: 1

Response

The account was closed.

Standard mutation envelope. Additional fields may be present depending on the operation.

success
boolean
Example:

true