> ## Documentation Index
> Fetch the complete documentation index at: https://docs.anchorage.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Update an account

> Permissions required: **Manage Accounts**

Update an existing account.



## OpenAPI

````yaml /knowledge-base/openapi/v4.yaml patch /accounts/{accountId}
openapi: 3.1.0
info:
  title: Anchorage Digital Account APIs (v4)
  version: 4.0.0-beta
  description: >-
    Reference for the Anchorage Digital v4 API, the surface behind Crypto as a
    Service: account management (accounts and the account tree, beneficiaries,
    freeze/unfreeze/close), balances and transactions, trusted destinations,
    orders and allocations, withdrawals, deposit instructions, deposit
    attributions, the policy engine (policies, approval keys), and supported
    asset types. Approval groups, endorsements, compliance profiles, customers
    (onboarding), fee configuration updates, interest enrollment, funding
    allocations, and destination removal are under construction and return
    mocked data only.


    Status: BETA. The v4 API is available in the sandbox only
    (https://api.anchorage-staging.com/v4) and is not available in production
    yet. The contract may change until general availability. Which endpoints are
    live, in final testing, or under construction:
    https://docs.anchorage.com/platform/developers/caas/caas-overview


    Authentication: every request carries an `Api-Access-Key` header. Every
    POST, PATCH, and DELETE additionally requires an `Idempotency-Key`, and is
    signed with `Api-Signature` (hex-encoded Ed25519 over
    `timestamp_epoch_seconds + uppercase(http_method) + request_path +
    request_body`) plus `Api-Timestamp` (unix epoch seconds).


    Pagination: list endpoints accept `after` (cursor) and `limit` (page size, 1
    to 1000, default 100) and return a `page.endCursor` to continue from. Errors
    use a common envelope with a human-readable `message`; batch endpoints
    return a result per item instead.


    Guides: https://docs.anchorage.com/platform/developers/caas/caas-overview
servers:
  - url: https://api.anchorage-staging.com/v4
security:
  - Api-Access-Key: []
tags:
  - name: Accounts
  - name: Compliance Profiles
  - name: Balances
  - name: Transactions
  - name: Trusted Destinations
  - name: Orders & Allocations
  - name: Withdrawals
  - name: Deposit Instructions
  - name: Deposit Attributions
  - name: Policies
  - name: Approval Groups
  - name: Endorsements
  - name: Customers
  - name: Asset Types
paths:
  /accounts/{accountId}:
    patch:
      tags:
        - Accounts
      summary: Update an account
      description: |-
        Permissions required: **Manage Accounts**

        Update an existing account.
      operationId: updateAccount
      parameters:
        - name: Idempotency-Key
          in: header
          schema:
            type: string
          required: true
          description: >-
            Client-supplied key that deduplicates retried requests. Reusing a
            key returns the original result instead of repeating the action.
        - name: Api-Signature
          in: header
          required: true
          schema:
            type: string
            pattern: ^[0-9A-Fa-f]{128,160}$
          description: >-
            A hex-encoded Ed25519 signature of `timestamp_epoch_seconds +
            uppercase(http_method) + request_path + request_body`.
        - name: Api-Timestamp
          in: header
          required: true
          schema:
            type: integer
            format: int64
          description: Current timestamp, represented as unix epoch seconds
        - name: If-Match
          in: header
          schema:
            type: string
          required: false
          description: >-
            Optional concurrency token, taken from a prior response's `ETag`
            header.

            When set, the update is rejected with 409 Conflict if the account
            has

            changed since that ETag was issued. An empty value is the same as no

            header.
        - name: accountId
          in: path
          schema:
            type: string
            format: uuid
            example: 3486b413-93d3-4447-afce-2b9c9dc34a32
          required: true
          description: Unique identifier for the account
      requestBody:
        description: Account fields to update
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateAccountRequest'
      responses:
        '200':
          description: Success
          headers:
            ETag:
              description: >-
                Opaque concurrency token for this account. Pass back via
                `If-Match` on update to guard against overwriting a stale
                account.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDetails'
        '401':
          description: Unauthenticated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDetails'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDetails'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDetails'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDetails'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDetails'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDetails'
components:
  schemas:
    UpdateAccountRequest:
      title: Update Account Request
      description: >-
        Fields to update on an existing account: only `name` and `externalId`
        can be changed, and any other field is rejected. The `type`
        discriminator must match the account's actual type. Interest enrollment
        is changed with `PATCH /accounts/{accountId}/interest-enrollment`.
      discriminator:
        propertyName: type
        mapping:
          SEGREGATED: '#/components/schemas/UpdateSegregatedAccountRequest'
          OMNIBUS: '#/components/schemas/UpdateOmnibusAccountRequest'
          FBO: '#/components/schemas/UpdateFboAccountRequest'
      oneOf:
        - $ref: '#/components/schemas/UpdateSegregatedAccountRequest'
        - $ref: '#/components/schemas/UpdateOmnibusAccountRequest'
        - $ref: '#/components/schemas/UpdateFboAccountRequest'
    AccountResponse:
      title: Account Response
      type: object
      required:
        - data
      properties:
        data:
          $ref: '#/components/schemas/Account'
    ErrorDetails:
      title: ErrorDetails
      type: object
      properties:
        message:
          description: A human-readable message providing more details about the error.
          example: Missing required field 'amount'.
          type: string
      required:
        - message
    UpdateSegregatedAccountRequest:
      title: Update Segregated Account
      type: object
      description: Details of the segregatedAccount to update.
      properties:
        name:
          type: string
          description: The name of the account.
        externalId:
          type: string
          description: The external unique identifier used to identify this account.
        type:
          type: string
          description: Set to `SEGREGATED` to create a segregated account.
          enum:
            - SEGREGATED
      additionalProperties: false
      required:
        - type
    UpdateOmnibusAccountRequest:
      title: Update Omnibus Account
      type: object
      description: >-
        Pure Omnibus account: all customers share one org-level on-chain wallet
        per asset.
      properties:
        name:
          type: string
          description: The name of the account.
        externalId:
          type: string
          description: The external unique identifier used to identify this account.
        type:
          type: string
          description: Set to `OMNIBUS` to create an omnibus account.
          enum:
            - OMNIBUS
      additionalProperties: false
      required:
        - type
    UpdateFboAccountRequest:
      title: Update FBO Account
      type: object
      description: Details of the FBO account to update.
      properties:
        name:
          type: string
          description: The name of the account.
        externalId:
          type: string
          description: The external unique identifier used to identify this account.
        type:
          type: string
          description: Set to `FBO` to create an FBO account.
          enum:
            - FBO
      additionalProperties: false
      required:
        - type
    Account:
      title: Account Details
      description: >-
        The full details of an account. The `type` discriminator indicates
        whether the underlying object is a SegregatedAccount, Omnibus, or FBO
        account.
      discriminator:
        propertyName: type
        mapping:
          SEGREGATED: '#/components/schemas/SegregatedAccount'
          OMNIBUS: '#/components/schemas/OmnibusAccount'
          FBO: '#/components/schemas/FboAccount'
      oneOf:
        - $ref: '#/components/schemas/SegregatedAccount'
        - $ref: '#/components/schemas/OmnibusAccount'
        - $ref: '#/components/schemas/FboAccount'
    SegregatedAccount:
      title: Segregated Account Details
      type: object
      description: >-
        A segregatedAccount underneath an FBO or omnibus parent account. Whether
        it is disclosed or undisclosed follows from its parent.
      properties:
        complianceProfileId:
          description: >-
            Reference to the Compliance Profile holding this account's tax
            classification, customers, and signers. Optional; immutable once the
            account is created.
          type: string
          format: uuid
          example: 3486b413-93d3-4447-afce-2b9c9dc34a32
        id:
          description: Unique Identifier for the account
          type: string
          format: uuid
          example: 3486b413-93d3-4447-afce-2b9c9dc34a32
        createdAt:
          description: The timestamp when the account was created.
          type: string
          format: date-time
          example: '2019-01-02T12:34:56.000Z'
        name:
          type: string
          description: The name of the account.
        externalId:
          type: string
          description: The external unique identifier used to identify this account.
        parentId:
          type: string
          description: >-
            The account id of the parent account (FBO or omnibus) this account
            is under. Whether this segregatedAccount is disclosed or undisclosed
            follows from its parent.
        type:
          type: string
          description: Set to `SEGREGATED` to create a segregated account.
          enum:
            - SEGREGATED
        updatedAt:
          description: The timestamp when the account was last updated.
          type: string
          format: date-time
          example: '2019-01-02T12:34:56.000Z'
        status:
          $ref: '#/components/schemas/AccountStatus'
      required:
        - id
        - type
        - status
        - parentId
        - createdAt
        - updatedAt
    OmnibusAccount:
      title: Omnibus Account Details
      type: object
      description: >-
        Pure Omnibus account: all customers share one org-level on-chain wallet
        per asset. Anchorage Digital sees aggregate balance only; the partner
        maintains the customer-level subledger. Closing this account also closes
        every segregated account under it.
      properties:
        complianceProfileId:
          description: >-
            Reference to the Compliance Profile holding this account's tax
            classification, customers, and signers. Optional; immutable once the
            account is created.
          type: string
          format: uuid
          example: 3486b413-93d3-4447-afce-2b9c9dc34a32
        id:
          description: Unique Identifier for the account
          type: string
          format: uuid
          example: 3486b413-93d3-4447-afce-2b9c9dc34a32
        createdAt:
          description: The timestamp when the account was created.
          type: string
          format: date-time
          example: '2019-01-02T12:34:56.000Z'
        isDisclosed:
          type: boolean
          description: >-
            Whether the underlying segregatedAccounts are disclosed. Each value
            of this flag must be contractually approved — operating disclosed vs
            undisclosed is a contractual matter. On create, required on a
            top-level account and must be absent on an account with a parentId:
            it is inherited from the top of the branch.
        name:
          type: string
          description: The name of the account.
        externalId:
          type: string
          description: The external unique identifier used to identify this account.
        parentId:
          type: string
          description: >-
            Optional. The account id of the parent account this account is
            under. The parent must be an FBO or an omnibus with SEGREGATED
            ledgering. A pure omnibus (SELF ledgering) is always top level. An
            account's children are either all accounts that hold accounts (FBO
            or omnibus) or all segregated accounts.
        type:
          type: string
          description: Set to `OMNIBUS` to create an omnibus account.
          enum:
            - OMNIBUS
        ledgering:
          type: string
          description: >-
            Where balances for this omnibus account are ledgered: SELF for
            org-level aggregate balance (Pure Omnibus), SEGREGATED for
            per-customer virtual balances.
          enum:
            - SELF
            - SEGREGATED
          default: SELF
        updatedAt:
          description: The timestamp when the account was last updated.
          type: string
          format: date-time
          example: '2019-01-02T12:34:56.000Z'
        status:
          $ref: '#/components/schemas/AccountStatus'
      required:
        - id
        - type
        - status
        - ledgering
        - isDisclosed
        - createdAt
        - updatedAt
    FboAccount:
      title: FBO Account Details
      type: object
      description: >-
        An FBO (for-benefit-of) account: the parent container under which
        segregated accounts are created. isDisclosed indicates whether its
        segregated accounts are disclosed (titled at Anchorage Digital) or
        undisclosed. Closing this account also closes every segregated account
        under it.
      properties:
        complianceProfileId:
          description: >-
            Reference to the Compliance Profile holding this account's tax
            classification, customers, and signers. Optional; immutable once the
            account is created.
          type: string
          format: uuid
          example: 3486b413-93d3-4447-afce-2b9c9dc34a32
        id:
          description: Unique Identifier for the account
          type: string
          format: uuid
          example: 3486b413-93d3-4447-afce-2b9c9dc34a32
        createdAt:
          description: The timestamp when the account was created.
          type: string
          format: date-time
          example: '2019-01-02T12:34:56.000Z'
        isDisclosed:
          type: boolean
          description: >-
            Whether the underlying segregatedAccounts are disclosed. Each value
            of this flag must be contractually approved — operating disclosed vs
            undisclosed is a contractual matter. On create, required on a
            top-level account and must be absent on an account with a parentId:
            it is inherited from the top of the branch.
        name:
          type: string
          description: The name of the account.
        externalId:
          type: string
          description: The external unique identifier used to identify this account.
        parentId:
          type: string
          description: >-
            Optional. The account id of the parent account this account is
            under. The parent must be an FBO or an omnibus with SEGREGATED
            ledgering. A pure omnibus (SELF ledgering) is always top level. An
            account's children are either all accounts that hold accounts (FBO
            or omnibus) or all segregated accounts.
        type:
          type: string
          description: Set to `FBO` to create an FBO account.
          enum:
            - FBO
        updatedAt:
          description: The timestamp when the account was last updated.
          type: string
          format: date-time
          example: '2019-01-02T12:34:56.000Z'
        status:
          $ref: '#/components/schemas/AccountStatus'
      required:
        - id
        - type
        - status
        - isDisclosed
        - createdAt
        - updatedAt
    AccountStatus:
      title: Account Status
      type: string
      enum:
        - OPENING
        - OPEN
        - FROZEN
        - CLOSING
        - CLOSED
      description: >-
        Status of the account.


        * `FROZEN` - Assets are retained on the account, but all activity
        (deposits, withdrawals, transfers) is blocked.

        * `CLOSING` - The account's closing procedure and/or closing
        requirements have been initiated but not yet completed.

        * `CLOSED` - The account's closing procedure and/or closing requirements
        are complete.
  securitySchemes:
    Api-Access-Key:
      type: apiKey
      name: Api-Access-Key
      in: header
      description: An API key associated with a security role

````

## Related topics

- [Accounts](https://docs.anchorage.com/knowledge-base/platform/developers/caas/caas-accounts.md)
- [Update account beneficiaries](https://docs.anchorage.com/knowledge-base/api-reference/v4/accounts/update-account-beneficiaries.md)
- [Update account fee configurations](https://docs.anchorage.com/knowledge-base/api-reference/v4/accounts/update-account-fee-configurations.md)
- [Getting started](https://docs.anchorage.com/knowledge-base/platform/developers/caas/caas-getting-started.md)
- [Update interest enrollment](https://docs.anchorage.com/knowledge-base/api-reference/v4/accounts/update-interest-enrollment.md)
