> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://en.docs.api.corpx.com/ib/referencia/accounts/close-account/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://en.docs.api.corpx.com/_mcp/server. # Close this tenant's access to the account POST https://client.api.corpx.com/v1/accounts/{accountId}/close Removes this tenant's access to the account. The HTTP response is the same whether another CorpX tenant still operates the bank account or this tenant is the last one: the caller cannot tell. Humans need `tenant_manager` or `admin`. Credentials need the `accounts.close` scope (legacy `api2/write` still passes). A `viewer` cannot close. The row is not deleted. It becomes `status=closed` with `status_source=tenant_close`. Already closed in this tenant returns the same 200 without a second email. When this tenant is the last one still operating the account, the raw settlement-bank balance must be zero (`total`, `available` and `locked`). Any non-zero value returns **422** `account_has_balance` and leaves the row active. A zero exclusive close emails MT support and then closes the row. Binding to another tenant's account, a missing account, or a `suspended` row is always **404** `account_not_found` — never `403 tenant_mismatch`. Reference: https://en.docs.api.corpx.com/ib/referencia/accounts/close-account ## Authentication - `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer `, where token is your auth token. ## Request ### Path parameters - `accountId` (string, required) — Account identifier. ### Headers - `X-Tenant-Id` (string, required) — Tenant context used for authorization and routing. - `Idempotency-Key` (string, optional) — Optional client-generated idempotency token (recommended for safe retries). - `X-Request-Timestamp` (string, required) — Unix seconds. Required on the signed host; tolerance is 300s either way (`403 request_timestamp_skew`). - `X-Content-SHA256` (string, required) — Lowercase hex SHA-256 of the body. An empty body hashes the empty string, so the header is always present. Mismatch returns `400 body_hash_mismatch`. - `X-Request-Signature` (string, required) — Detached JWS (`..`, ES256 or PS256) over `METHOD\nPATH?QUERY\nTIMESTAMP\nIDEMPOTENCY_KEY_OR_EMPTY\nX_CONTENT_SHA256`. ## Response ### 200 This tenant lost access. The message is identical on both internal paths. - `accountId` (string, required) - `message` (string, required) ## Errors ### 403 Forbidden Error Requester does not have permission to perform the operation. - `errorCode` (string, required) — Stable machine-readable code. See `ErrorCode` for the known values. - `message` (string, required) — Human-readable explanation (pt-BR). Presentation only; may change. - `docs` (string, optional) — Link to this code in the public error catalogue. - `requestId` (string, optional) — Gateway request id. Quote it when contacting support. - `partner` (ErrorResponsePartner, optional) — Raw error from the settlement bank, when the failure came from it. Diagnostic only. ### 404 Not Found Error Requested resource was not found. - `errorCode` (string, required) — Stable machine-readable code. See `ErrorCode` for the known values. - `message` (string, required) — Human-readable explanation (pt-BR). Presentation only; may change. - `docs` (string, optional) — Link to this code in the public error catalogue. - `requestId` (string, optional) — Gateway request id. Quote it when contacting support. - `partner` (ErrorResponsePartner, optional) — Raw error from the settlement bank, when the failure came from it. Diagnostic only. ### 409 Conflict Error `request_in_progress` — same Idempotency-Key is still being processed. - `errorCode` (string, required) — Stable machine-readable code. See `ErrorCode` for the known values. - `message` (string, required) — Human-readable explanation (pt-BR). Presentation only; may change. - `docs` (string, optional) — Link to this code in the public error catalogue. - `requestId` (string, optional) — Gateway request id. Quote it when contacting support. - `partner` (ErrorResponsePartner, optional) — Raw error from the settlement bank, when the failure came from it. Diagnostic only. ### 422 Unprocessable Entity Error `account_has_balance` — exclusive path; withdraw first. Body includes the raw settlement-bank balance. - `errorCode` (string, required) — Stable machine-readable code. See `ErrorCode` for the known values. - `message` (string, required) — Human-readable explanation (pt-BR). Presentation only; may change. - `docs` (string, optional) — Link to this code in the public error catalogue. - `requestId` (string, optional) — Gateway request id. Quote it when contacting support. - `partner` (V1AccountsAccountIdClosePostResponsesContentApplicationJsonSchemaPartner, optional) — Raw error from the settlement bank, when the failure came from it. Diagnostic only. - `errorReason` (string, optional) - `balance` (V1AccountsAccountIdClosePostResponsesContentApplicationJsonSchemaBalance, optional) ### 503 Service Unavailable Error `email_unavailable` or `banking_unavailable` on the exclusive path. - `errorCode` (string, required) — Stable machine-readable code. See `ErrorCode` for the known values. - `message` (string, required) — Human-readable explanation (pt-BR). Presentation only; may change. - `docs` (string, optional) — Link to this code in the public error catalogue. - `requestId` (string, optional) — Gateway request id. Quote it when contacting support. - `partner` (ErrorResponsePartner, optional) — Raw error from the settlement bank, when the failure came from it. Diagnostic only. ## Types ### ErrorResponsePartner Raw error from the settlement bank, when the failure came from it. Diagnostic only. - `code` (string, optional) - `message` (string, optional) - `field` (string, optional) — Field the partner pointed at, when any. ### V1AccountsAccountIdClosePostResponsesContentApplicationJsonSchemaPartner Raw error from the settlement bank, when the failure came from it. Diagnostic only. - `code` (string, optional) - `message` (string, optional) - `field` (string, optional) — Field the partner pointed at, when any. ### V1AccountsAccountIdClosePostResponsesContentApplicationJsonSchemaBalance - `total` (double, optional) - `available` (double, optional) - `locked` (double, optional) - `currency` (string, optional) ## Examples **Response** ```json { "accountId": "2e6b725b-84a0-400d-8740-22a5ba0f23e6", "message": "Este tenant perdeu o acesso à conta. Ela será encerrada em breve se nenhum outro tenant estiver usando." } ``` **SDK Code** ```python Accounts_closeAccount_example import requests url = "https://client.api.corpx.com/v1/accounts/accountId/close" headers = { "X-Content-SHA256": "X-Content-SHA256", "X-Request-Signature": "X-Request-Signature", "X-Request-Timestamp": "X-Request-Timestamp", "X-Tenant-Id": "X-Tenant-Id", "Authorization": "Bearer " } response = requests.post(url, headers=headers) print(response.json()) ``` ```javascript Accounts_closeAccount_example const url = 'https://client.api.corpx.com/v1/accounts/accountId/close'; const options = { method: 'POST', headers: { 'X-Content-SHA256': 'X-Content-SHA256', 'X-Request-Signature': 'X-Request-Signature', 'X-Request-Timestamp': 'X-Request-Timestamp', 'X-Tenant-Id': 'X-Tenant-Id', Authorization: 'Bearer ' } }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go Accounts_closeAccount_example package main import ( "fmt" "net/http" "io" ) func main() { url := "https://client.api.corpx.com/v1/accounts/accountId/close" req, _ := http.NewRequest("POST", url, nil) req.Header.Add("X-Content-SHA256", "X-Content-SHA256") req.Header.Add("X-Request-Signature", "X-Request-Signature") req.Header.Add("X-Request-Timestamp", "X-Request-Timestamp") req.Header.Add("X-Tenant-Id", "X-Tenant-Id") req.Header.Add("Authorization", "Bearer ") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby Accounts_closeAccount_example require 'uri' require 'net/http' url = URI("https://client.api.corpx.com/v1/accounts/accountId/close") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Post.new(url) request["X-Content-SHA256"] = 'X-Content-SHA256' request["X-Request-Signature"] = 'X-Request-Signature' request["X-Request-Timestamp"] = 'X-Request-Timestamp' request["X-Tenant-Id"] = 'X-Tenant-Id' request["Authorization"] = 'Bearer ' response = http.request(request) puts response.read_body ``` ```java Accounts_closeAccount_example import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.post("https://client.api.corpx.com/v1/accounts/accountId/close") .header("X-Content-SHA256", "X-Content-SHA256") .header("X-Request-Signature", "X-Request-Signature") .header("X-Request-Timestamp", "X-Request-Timestamp") .header("X-Tenant-Id", "X-Tenant-Id") .header("Authorization", "Bearer ") .asString(); ``` ```php Accounts_closeAccount_example request('POST', 'https://client.api.corpx.com/v1/accounts/accountId/close', [ 'headers' => [ 'Authorization' => 'Bearer ', 'X-Content-SHA256' => 'X-Content-SHA256', 'X-Request-Signature' => 'X-Request-Signature', 'X-Request-Timestamp' => 'X-Request-Timestamp', 'X-Tenant-Id' => 'X-Tenant-Id', ], ]); echo $response->getBody(); ``` ```csharp Accounts_closeAccount_example using RestSharp; var client = new RestClient("https://client.api.corpx.com/v1/accounts/accountId/close"); var request = new RestRequest(Method.POST); request.AddHeader("X-Content-SHA256", "X-Content-SHA256"); request.AddHeader("X-Request-Signature", "X-Request-Signature"); request.AddHeader("X-Request-Timestamp", "X-Request-Timestamp"); request.AddHeader("X-Tenant-Id", "X-Tenant-Id"); request.AddHeader("Authorization", "Bearer "); IRestResponse response = client.Execute(request); ``` ```swift Accounts_closeAccount_example import Foundation let headers = [ "X-Content-SHA256": "X-Content-SHA256", "X-Request-Signature": "X-Request-Signature", "X-Request-Timestamp": "X-Request-Timestamp", "X-Tenant-Id": "X-Tenant-Id", "Authorization": "Bearer " ] let request = NSMutableURLRequest(url: NSURL(string: "https://client.api.corpx.com/v1/accounts/accountId/close")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "POST" request.allHTTPHeaderFields = headers let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```