Archive an account

Archives a subledger account. Only subledger-type accounts (those created via POST /v1/accounts) may be archived, and the account must have a zero balance.

While archived, mutating operations on the account are blocked: transfers into or out of the account, new deposit-address generation, fiat withdrawals, payment-intent creation, and fetching wire instructions are all rejected. Read endpoints (e.g. GET /v1/accounts/{accountId}, GET /v1/accounts/deposits) continue to work.

An archived account is excluded from the default GET /v1/accounts listing; pass status=archived (or include archived in a multi-value status filter) to retrieve it.

Archiving is idempotent: archiving an already-archived account succeeds. An incoming deposit to a pre-existing deposit address or wire instruction on the archived account will auto-unarchive it (status returns to active).

POST /v1/accounts/{accountId}/archive

Archive an account

cURL

curl --request POST \
  --url https://api-sandbox.circle.com/v1/accounts/{accountId}/archive \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api-sandbox.circle.com/v1/accounts/{accountId}/archive"

headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, headers=headers)

print(response.text)

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api-sandbox.circle.com/v1/accounts/{accountId}/archive', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-sandbox.circle.com/v1/accounts/{accountId}/archive",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api-sandbox.circle.com/v1/accounts/{accountId}/archive"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api-sandbox.circle.com/v1/accounts/{accountId}/archive")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api-sandbox.circle.com/v1/accounts/{accountId}/archive")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

200

{
  "data": {
    "accountId": "1000662322",
    "entityId": "a49f9b1d-75e0-44a9-b8d2-4293b3f11ebd",
    "type": "first_party",
    "purpose": "custody",
    "status": "active",
    "description": "End User Wallet",
    "balances": [
      {
        "amount": "3.14",
        "currency": "USD"
      }
    ],
    "clientEntityId": "a3f1b2c4-d5e6-7890-abcd-ef1234567890",
    "businessPii": {
      "businessName": "Acme Corporation",
      "businessUniqueIdentifier": "12-3456789",
      "identifierIssuingCountryCode": "US",
      "address": {
        "line1": "100 Pine Street",
        "city": "San Francisco",
        "postalCode": "94111",
        "country": "US",
        "line2": "Suite 2500",
        "district": "CA"
      }
    },
    "groupId": "9c0f1c0d-6c61-4f3d-9b8a-1a3a4b3c5d6e"
  }
}

{
  "code": 2,
  "message": "API parameter invalid."
}

{
  "code": 4,
  "message": "Unauthorized."
}

{
  "code": 404,
  "message": "Not found."
}

{
  "code": -1,
  "message": "Something went wrong. errId: 1f0b0c455e40f753f07b4f0ae6abd4b4"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

accountId · string · required

Identifier of the account.

Example:

"1000565227"

Response

200

application/json

Successfully archived the account.

data · object

An account exposed by the Accounts API.

Show child attributes