> For a complete index of Agora Finance documentation, fetch https://docs.agora.finance/llms.txt

# Update an Account

PUT https://api.agora.finance/v0/accounts/{accountId}
Content-Type: application/json

Apply a single change to an existing account, selected by `operation`:

- **`setName`**: rename a wallet or bank account (send `name`).
- **`addNetwork`**: register an existing wallet on an additional `network`, which starts a new `mint` entitlement there (see [Wallet entitlements](/api/endpoints/accounts/overview#wallet-entitlements)). Rejected with `409` if the address is already registered there.
- **`requestEntitlement`**: request an `entitlement` (currently `instant_settlement`) on an existing wallet `network`. Returns `400` if the entitlement isn't requestable for that network. See [Wallet entitlements](/api/endpoints/accounts/overview#wallet-entitlements) for how requests are reviewed and approved.

The response is the full updated account, same shape as `GET /v0/accounts`.


Reference: https://docs.agora.finance/api/endpoints/accounts/update

## Authentication

- `Authorization` header (bearer token, required) — Session JWT from `POST /v0/auth/token`, sent as `Authorization: Bearer <sessionJwt>`. See [Authentication](/api/authentication) for more details.

## Request

### Path parameters

- `accountId` (string, required) — Id of the account to update; must belong to the caller's org.

### Body (application/json)

This endpoint expects an object.

- `operation` (enum, required)
  - Allowed values: `setName`, `addNetwork`, `requestEntitlement`
- `name` (string, optional) — User-set label. Free-form; max 200 characters.
- `network` (enum, optional)
  - Allowed values: `arbitrum`, `avalanche`, `base`, `binance-smart-chain`, `core`, `ethereum`, `fraxtal`, `gnosis`, `immutable`, `injective`, `katana`, `mantle`, `monad`, `plume`, `polygon-pos`, `solana`, `sui`
- `entitlement` (enum, optional) — Entitlement to request. Moves to pending_approval; granting stays Agora-side.
  - Allowed values: `instant_settlement`

## Response

### 200

OK

- `accounts_update_Response_200`

## Errors

### 400 Bad Request Error

This entitlement cannot be requested in its current state.

- `code` (enum, required)
  - Allowed values: `entitlement_not_requestable`, `parameter_invalid`
- `docs_url` (string, required)
- `message` (string, required)
- `context` (ErrorResponse400EntitlementNotRequestableParameterInvalidContext, optional)

### 401 Unauthorized Error

Authentication is required.

- `code` (enum, required)
  - Allowed values: `unauthorized`
- `docs_url` (string, required)
- `message` (string, required)
- `context` (ErrorResponse401UnauthorizedContext, optional)

### 403 Forbidden Error

The account is not eligible for the requested route direction.

- `code` (enum, required)
  - Allowed values: `account_not_eligible`, `account_not_provisioned`, `account_verification_pending`, `forbidden`
- `docs_url` (string, required)
- `message` (string, required)

### 404 Not Found Error

Account not found.

- `code` (enum, required)
  - Allowed values: `account_not_found`, `not_found`
- `docs_url` (string, required)
- `message` (string, required)

### 409 Conflict Error

An account with these details already exists.

- `code` (enum, required)
  - Allowed values: `account_already_exists`
- `docs_url` (string, required)
- `message` (string, required)

### 429 Too Many Requests Error

Too many requests.

- `code` (enum, required)
  - Allowed values: `rate_limit_exceeded`
- `docs_url` (string, required)
- `message` (string, required)

### 500 Internal Server Error

An unexpected error occurred.

- `code` (enum, required)
  - Allowed values: `internal_error`
- `docs_url` (string, required)
- `message` (string, required)

## Types

### Wallet

Customer-owned blockchain address (CustomerAddress).

- `id` (string, required) — Stable UUID identifying this account; safe to cache or display.
- `address` (string, required) — On-chain address. EIP-55 checksummed for EVM (`ethereum`), base58 for Solana.
- `addressFormat` (enum, required) — Address syntax family. `ethereum` covers every EVM chain (Ethereum, Base, Polygon, Arbitrum, etc.); per-chain authorization is enforced separately via the account's chain entitlements.
  - Allowed values: `ethereum`, `solana`
- `createdAt` (datetime, required) — ISO-8601 UTC timestamp when this address was added to the org.
- `kind` (enum, required) — Discriminator: this is a customer-owned blockchain address.
  - Allowed values: `wallet`
- `name` (string, required) — User-set label. Free-form; may be empty if the user hasn't set one.
- `networks` (list of V0AccountsAccountIdPutResponsesContentApplicationJsonSchemaOneOf0NetworksItems, required) — The networks this address is registered on, each with its per-type entitlement states.

### Bank Account

Customer-owned bank account (WireDetail, status=verified).

- `id` (string, required) — Stable UUID identifying this account; safe to cache or display.
- `accountNumber` (string, required) — Full bank account number.
- `bankName` (string, required) — Name of the receiving bank.
- `beneficiary` (string, required) — Account-holder name on the wire. Part of the account's identity: distinguishes accounts that share a routing + account number (e.g. omnibus/custodian accounts holding several funds under one account number).
- `createdAt` (datetime, required) — ISO-8601 UTC timestamp when this account was added to the org.
- `currency` (enum, required) — Settlement currency. Today only `usd`; will extend as new currencies launch.
  - Allowed values: `usd`
- `kind` (enum, required) — Discriminator: this is a customer-owned bank account.
  - Allowed values: `bank`
- `name` (string, required) — User-set label. Free-form; may be empty if the user hasn't set one.
- `routingNumber` (string, required) — ABA routing number identifying the receiving bank. A public bank identifier, returned in full.

### ErrorResponse400EntitlementNotRequestableParameterInvalidContext

- `issues` (list of ErrorResponse400EntitlementNotRequestableParameterInvalidContextIssuesItems, required)

### ErrorResponse401UnauthorizedContext

- `reason` (enum, required)
  - Allowed values: `invalid_token`, `key_not_provisioned`, `missing_claim`, `missing_header`, `token_expired`, `token_paused`, `token_revoked`, `unknown_tenant`

### V0AccountsAccountIdPutResponsesContentApplicationJsonSchemaOneOf0NetworksItems

Per-network entitlement state for the wallet.

- `chain` (enum, required) — Network the wallet is registered on (kebab-case public network id).
  - Allowed values: `arbitrum`, `avalanche`, `base`, `binance-smart-chain`, `core`, `ethereum`, `fraxtal`, `gnosis`, `immutable`, `injective`, `katana`, `mantle`, `monad`, `plume`, `polygon-pos`, `solana`, `sui`
- `entitlements` (list of V0AccountsAccountIdPutResponsesContentApplicationJsonSchemaOneOf0NetworksItemsEntitlementsItems, required) — Entitlement states on this network, one per type the wallet holds on the chain.

### ErrorResponse400EntitlementNotRequestableParameterInvalidContextIssuesItems

- `field` (string, required)
- `message` (string, required)

### V0AccountsAccountIdPutResponsesContentApplicationJsonSchemaOneOf0NetworksItemsEntitlementsItems

- `type` (enum, required) — Entitlement type. `mint` is the mint capability gated by the per-chain compliance scan; `instant_settlement` is the instant-settlement whitelist; `rewards` is rewards eligibility.
  - Allowed values: `instant_settlement`, `mint`, `rewards`
- `status` (enum, required) — Entitlement status. `pending_approval` is requested and under Agora review; `approved` is active. `conditionally_approved` applies to `mint` only: the address is usable now (screening and whitelisting are auto-initiated) while final approval is still pending internally. `instant_settlement` and `rewards` stay `pending_approval` until reviewed. The API never auto-approves.
  - Allowed values: `approved`, `conditionally_approved`, `pending_approval`, `pending_removal`, `rejected`, `removed`

## Examples

### Rename

**Request**

```json
{
  "operation": "setName",
  "name": "ETH treasury (primary)"
}
```

**Response**

```json
{
  "address": "0xf5E6d7C8b9A0f5E6d7C8b9A0f5E6d7C8b9A0f5E6",
  "addressFormat": "ethereum",
  "createdAt": "2026-04-02T14:15:00Z",
  "id": "7f3a1b2c-3d4e-5f6a-7b8c-9d0e1f2a3b4c",
  "kind": "wallet",
  "name": "ETH treasury (primary)",
  "networks": [
    {
      "chain": "ethereum",
      "entitlements": [
        {
          "status": "approved",
          "type": "mint"
        }
      ]
    }
  ]
}
```

**SDK Code**

```python Rename
import requests

url = "https://api.agora.finance/v0/accounts/7f3a1b2c-3d4e-5f6a-7b8c-9d0e1f2a3b4c"

payload = {
    "operation": "setName",
    "name": "ETH treasury (primary)"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.json())
```

```javascript Rename
const url = 'https://api.agora.finance/v0/accounts/7f3a1b2c-3d4e-5f6a-7b8c-9d0e1f2a3b4c';
const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"operation":"setName","name":"ETH treasury (primary)"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go Rename
package main

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

func main() {

	url := "https://api.agora.finance/v0/accounts/7f3a1b2c-3d4e-5f6a-7b8c-9d0e1f2a3b4c"

	payload := strings.NewReader("{\n  \"operation\": \"setName\",\n  \"name\": \"ETH treasury (primary)\"\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby Rename
require 'uri'
require 'net/http'

url = URI("https://api.agora.finance/v0/accounts/7f3a1b2c-3d4e-5f6a-7b8c-9d0e1f2a3b4c")

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

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"operation\": \"setName\",\n  \"name\": \"ETH treasury (primary)\"\n}"

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

```java Rename
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.put("https://api.agora.finance/v0/accounts/7f3a1b2c-3d4e-5f6a-7b8c-9d0e1f2a3b4c")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"operation\": \"setName\",\n  \"name\": \"ETH treasury (primary)\"\n}")
  .asString();
```

```php Rename
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('PUT', 'https://api.agora.finance/v0/accounts/7f3a1b2c-3d4e-5f6a-7b8c-9d0e1f2a3b4c', [
  'body' => '{
  "operation": "setName",
  "name": "ETH treasury (primary)"
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp Rename
using RestSharp;

var client = new RestClient("https://api.agora.finance/v0/accounts/7f3a1b2c-3d4e-5f6a-7b8c-9d0e1f2a3b4c");
var request = new RestRequest(Method.PUT);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"operation\": \"setName\",\n  \"name\": \"ETH treasury (primary)\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift Rename
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [
  "operation": "setName",
  "name": "ETH treasury (primary)"
] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.agora.finance/v0/accounts/7f3a1b2c-3d4e-5f6a-7b8c-9d0e1f2a3b4c")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "PUT"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

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()
```

### Add a network

**Request**

```json
{
  "operation": "addNetwork",
  "network": "base"
}
```

**Response**

```json
{
  "address": "0xf5E6d7C8b9A0f5E6d7C8b9A0f5E6d7C8b9A0f5E6",
  "addressFormat": "ethereum",
  "createdAt": "2026-04-02T14:15:00Z",
  "id": "7f3a1b2c-3d4e-5f6a-7b8c-9d0e1f2a3b4c",
  "kind": "wallet",
  "name": "ETH treasury",
  "networks": [
    {
      "chain": "ethereum",
      "entitlements": [
        {
          "status": "approved",
          "type": "mint"
        }
      ]
    },
    {
      "chain": "base",
      "entitlements": [
        {
          "status": "conditionally_approved",
          "type": "mint"
        }
      ]
    }
  ]
}
```

**SDK Code**

```python Add a network
import requests

url = "https://api.agora.finance/v0/accounts/7f3a1b2c-3d4e-5f6a-7b8c-9d0e1f2a3b4c"

payload = {
    "operation": "addNetwork",
    "network": "base"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.json())
```

```javascript Add a network
const url = 'https://api.agora.finance/v0/accounts/7f3a1b2c-3d4e-5f6a-7b8c-9d0e1f2a3b4c';
const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"operation":"addNetwork","network":"base"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go Add a network
package main

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

func main() {

	url := "https://api.agora.finance/v0/accounts/7f3a1b2c-3d4e-5f6a-7b8c-9d0e1f2a3b4c"

	payload := strings.NewReader("{\n  \"operation\": \"addNetwork\",\n  \"network\": \"base\"\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby Add a network
require 'uri'
require 'net/http'

url = URI("https://api.agora.finance/v0/accounts/7f3a1b2c-3d4e-5f6a-7b8c-9d0e1f2a3b4c")

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

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"operation\": \"addNetwork\",\n  \"network\": \"base\"\n}"

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

```java Add a network
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.put("https://api.agora.finance/v0/accounts/7f3a1b2c-3d4e-5f6a-7b8c-9d0e1f2a3b4c")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"operation\": \"addNetwork\",\n  \"network\": \"base\"\n}")
  .asString();
```

```php Add a network
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('PUT', 'https://api.agora.finance/v0/accounts/7f3a1b2c-3d4e-5f6a-7b8c-9d0e1f2a3b4c', [
  'body' => '{
  "operation": "addNetwork",
  "network": "base"
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp Add a network
using RestSharp;

var client = new RestClient("https://api.agora.finance/v0/accounts/7f3a1b2c-3d4e-5f6a-7b8c-9d0e1f2a3b4c");
var request = new RestRequest(Method.PUT);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"operation\": \"addNetwork\",\n  \"network\": \"base\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift Add a network
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [
  "operation": "addNetwork",
  "network": "base"
] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.agora.finance/v0/accounts/7f3a1b2c-3d4e-5f6a-7b8c-9d0e1f2a3b4c")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "PUT"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

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()
```

### Request entitlement

**Request**

```json
{
  "operation": "requestEntitlement",
  "network": "ethereum",
  "entitlement": "instant_settlement"
}
```

**Response**

```json
{
  "address": "0xf5E6d7C8b9A0f5E6d7C8b9A0f5E6d7C8b9A0f5E6",
  "addressFormat": "ethereum",
  "createdAt": "2026-04-02T14:15:00Z",
  "id": "7f3a1b2c-3d4e-5f6a-7b8c-9d0e1f2a3b4c",
  "kind": "wallet",
  "name": "ETH treasury",
  "networks": [
    {
      "chain": "ethereum",
      "entitlements": [
        {
          "status": "approved",
          "type": "mint"
        },
        {
          "status": "pending_approval",
          "type": "instant_settlement"
        }
      ]
    }
  ]
}
```

**SDK Code**

```python Request entitlement
import requests

url = "https://api.agora.finance/v0/accounts/7f3a1b2c-3d4e-5f6a-7b8c-9d0e1f2a3b4c"

payload = {
    "operation": "requestEntitlement",
    "network": "ethereum",
    "entitlement": "instant_settlement"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.json())
```

```javascript Request entitlement
const url = 'https://api.agora.finance/v0/accounts/7f3a1b2c-3d4e-5f6a-7b8c-9d0e1f2a3b4c';
const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"operation":"requestEntitlement","network":"ethereum","entitlement":"instant_settlement"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go Request entitlement
package main

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

func main() {

	url := "https://api.agora.finance/v0/accounts/7f3a1b2c-3d4e-5f6a-7b8c-9d0e1f2a3b4c"

	payload := strings.NewReader("{\n  \"operation\": \"requestEntitlement\",\n  \"network\": \"ethereum\",\n  \"entitlement\": \"instant_settlement\"\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby Request entitlement
require 'uri'
require 'net/http'

url = URI("https://api.agora.finance/v0/accounts/7f3a1b2c-3d4e-5f6a-7b8c-9d0e1f2a3b4c")

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

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"operation\": \"requestEntitlement\",\n  \"network\": \"ethereum\",\n  \"entitlement\": \"instant_settlement\"\n}"

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

```java Request entitlement
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.put("https://api.agora.finance/v0/accounts/7f3a1b2c-3d4e-5f6a-7b8c-9d0e1f2a3b4c")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"operation\": \"requestEntitlement\",\n  \"network\": \"ethereum\",\n  \"entitlement\": \"instant_settlement\"\n}")
  .asString();
```

```php Request entitlement
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('PUT', 'https://api.agora.finance/v0/accounts/7f3a1b2c-3d4e-5f6a-7b8c-9d0e1f2a3b4c', [
  'body' => '{
  "operation": "requestEntitlement",
  "network": "ethereum",
  "entitlement": "instant_settlement"
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp Request entitlement
using RestSharp;

var client = new RestClient("https://api.agora.finance/v0/accounts/7f3a1b2c-3d4e-5f6a-7b8c-9d0e1f2a3b4c");
var request = new RestRequest(Method.PUT);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"operation\": \"requestEntitlement\",\n  \"network\": \"ethereum\",\n  \"entitlement\": \"instant_settlement\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift Request entitlement
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [
  "operation": "requestEntitlement",
  "network": "ethereum",
  "entitlement": "instant_settlement"
] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.agora.finance/v0/accounts/7f3a1b2c-3d4e-5f6a-7b8c-9d0e1f2a3b4c")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "PUT"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

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()
```

> Documentation for the AUSD stablecoin and Agora's APIs.