Fireblocks Vaults API

openapi: 3.2.0
info:
  title: Fireblocks Blockchains and Assets Approval Requests Vaults API
  description: 'Fireblocks provides a suite of applications to manage digital asset operations and a complete development platform to build your business on the blockchain.


    - Visit our website for more information: [Fireblocks Website](https://fireblocks.com)

    - Visit our developer docs: [Fireblocks DevPortal](https://developers.fireblocks.com)

    '
  version: 1.8.0
  contact:
    email: developers@fireblocks.com
servers:
- url: https://api.fireblocks.io/v1
  description: Fireblocks Production Environment Base URL
- url: https://sandbox-api.fireblocks.io/v1
  description: Fireblocks Sandbox Environment Base URL
security: []
tags:
- name: Vaults
paths:
  /vault/accounts:
    get:
      x-internal: true
      deprecated: true
      summary: Get vault accounts
      description: 'DEPRECATED - Please use `/vault/accounts_paged` endpoint instead.

        </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer.'
      tags:
      - Vaults
      x-readme:
        code-samples:
        - language: javascript
          code: const vaultAccounts = await fireblocks.getVaultAccounts();
          name: Fireblocks SDK Javascript example
      parameters:
      - in: query
        name: namePrefix
        required: false
        schema:
          type: string
      - in: query
        name: nameSuffix
        required: false
        schema:
          type: string
      - in: query
        name: minAmountThreshold
        required: false
        schema:
          type: number
      - in: query
        name: assetId
        required: false
        schema:
          type: string
          x-fb-entity: asset
      responses:
        '200':
          description: A list of vault accounts
          headers:
            X-Request-ID:
              $ref: '#/components/headers/X-Request-ID'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetVaultAccountsResponse'
        default:
          $ref: '#/components/responses/Error'
      operationId: getVaultAccounts
    post:
      summary: Create a new vault account
      operationId: createVaultAccount
      description: 'Creates a new vault account with the requested name.

        **Note: ** Vault account names should consist of ASCII characters only.

        Learn more about Fireblocks Vault Accounts in the following [guide](https://developers.fireblocks.com/reference/create-vault-account).

        </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor.'
      tags:
      - Vaults
      x-readme:
        code-samples:
        - language: javascript
          code: const vaultAccount = await fireblocks.createVaultAccount(name, hiddenOnUI, customerRefId, autoFueling);
          name: Fireblocks SDK Javascript example
        - language: typescript
          code: 'const response: Promise<FireblocksResponse<VaultAccount>> = fireblocks.vaults.createVaultAccount(vaultsApiCreateVaultAccountRequest);'
          name: Fireblocks SDK TypeScript example
        - language: java
          code: CompletableFuture<ApiResponse<VaultAccount>> response = fireblocks.vaults().createVaultAccount(createVaultAccountRequest, idempotencyKey);
          name: Fireblocks SDK Java example
        - language: python
          code: response = fireblocks.vaults.create_vault_account(create_vault_account_request, idempotency_key);
          name: Fireblocks SDK Python example
      parameters:
      - $ref: '#/components/parameters/X-Idempotency-Key'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateVaultAccountRequest'
      responses:
        '200':
          description: A Vault Account object
          headers:
            X-Request-ID:
              $ref: '#/components/headers/X-Request-ID'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VaultAccount'
        default:
          $ref: '#/components/responses/Error'
      x-codeSamples:
      - lang: TypeScript
        source: 'const response: Promise<FireblocksResponse<VaultAccount>> = fireblocks.vaults.createVaultAccount(vaultsApiCreateVaultAccountRequest);'
      - lang: Java
        source: CompletableFuture<ApiResponse<VaultAccount>> response = fireblocks.vaults().createVaultAccount(createVaultAccountRequest, idempotencyKey);
      - lang: Python
        source: response = fireblocks.vaults.create_vault_account(create_vault_account_request, idempotency_key);
  /vault/accounts/addresses/bulk:
    post:
      operationId: createMultipleDepositAddresses
      summary: Bulk creation of new deposit addresses
      description: '- **For UTXO blockchains only.**

        - **This endpoint is currently in beta mode and may be subject to change. To learn more, contact your Fireblocks Customer Success Manager or email csm@fireblocks.com.**


        Create multiple deposit addresses by running an async job.

        - The target Vault account should already have a UTXO asset wallet with a permanent address.

        - Limited to a maximum of 10,000 addresses per operation. Use multiple operations for the same Vault account/permanent address if needed.


        **Endpoint Permissions:** Admin, Non-Signing Admin.

        '
      tags:
      - Vaults
      parameters:
      - $ref: '#/components/parameters/X-Idempotency-Key'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateMultipleDepositAddressesRequest'
      responses:
        '200':
          description: A JobCreated object
          headers:
            X-Request-ID:
              $ref: '#/components/headers/X-Request-ID'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JobCreated'
        default:
          $ref: '#/components/responses/Error'
  /vault/accounts/addresses/bulk/{jobId}:
    get:
      summary: Get the job status of the bulk deposit address creation
      description: "Returns the current status of (or an error for) the specified deposit addresss bulk creation job.\n\n**Endpoint Permissions:** Admin, Non-Signing Admin, Signer, Approver, Editor, and Viewer.            \n"
      tags:
      - Vaults
      parameters:
      - in: path
        name: jobId
        required: true
        description: The ID of the job to create addresses
        schema:
          type: string
        example: 019681b4-107d-7243-942d-4c3c30e36fae
      responses:
        '200':
          description: A Job with status
          headers:
            X-Request-ID:
              $ref: '#/components/headers/X-Request-ID'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateMultipleDepositAddressesJobStatus'
        default:
          $ref: '#/components/responses/Error'
      operationId: getCreateMultipleDepositAddressesJobStatus
  /vault/accounts/bulk/:
    post:
      operationId: createMultipleAccounts
      summary: Bulk creation of new vault accounts
      description: "- **This endpoint is currently in Early Availability (EA) mode and may be subject to change. To learn more, contact your Fireblocks Customer Success Manager or email csm@fireblocks.com.**\n\nCreate multiple vault accounts by running an async job.      \n- The HBAR, TON, SUI, TERRA, ALGO, and DOT blockchains are not supported.\n- Limited to a maximum of 10,000 accounts per operation.\n\n**Endpoint Permissions:** Admin, Non-Signing Admin, Signer, Approver, Editor.\n"
      tags:
      - Vaults
      x-rate-limit-category: write
      parameters:
      - $ref: '#/components/parameters/X-Idempotency-Key'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateMultipleAccountsRequest'
      responses:
        '200':
          description: A JobCreated object
          headers:
            X-Request-ID:
              $ref: '#/components/headers/X-Request-ID'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JobCreated'
        default:
          $ref: '#/components/responses/Error'
  /vault/accounts/bulk/{jobId}:
    get:
      summary: Get job status of bulk creation of new vault accounts
      description: 'Returns the current status of (or error for) the specified vault account bulk creation job.


        **Endpoint Permissions:** Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer.

        '
      tags:
      - Vaults
      x-rate-limit-category: async
      parameters:
      - in: path
        name: jobId
        required: true
        description: The ID of the job to create addresses
        schema:
          type: string
        example: 019681b4-107d-7243-942d-4c3c30e36fae
      responses:
        '200':
          description: A Job with status
          headers:
            X-Request-ID:
              $ref: '#/components/headers/X-Request-ID'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateMultipleVaultAccountsJobStatus'
        default:
          $ref: '#/components/responses/Error'
      operationId: getCreateMultipleVaultAccountsJobStatus
  /vault/accounts/attached_tags:
    post:
      summary: Attach or detach tags from vault accounts
      description: 'Attach or detach one or more tags from the requested vault accounts.


        **Endpoint Permissions:**

        - For protected tags: Owner, Admin, Non-Signing Admin.

        - For non protected tags: Owner, Admin, Non-Signing Admin, Signer, Editor, Approver.

        '
      tags:
      - Vaults
      x-rate-limit-category: write
      parameters:
      - $ref: '#/components/parameters/X-Idempotency-Key'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/VaultAccountsTagAttachmentOperationsRequest'
      responses:
        '200':
          description: Tags were attached/detached successfully
          headers:
            X-Request-ID:
              $ref: '#/components/headers/X-Request-ID'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VaultAccountsTagAttachmentOperationsResponse'
        '400':
          description: '- Invalid request parameters.

            - Same tag ID is provided in both tagIdsToAttach and tagIdsToDetach.

            - Vault accounts are archived.

            '
          headers:
            X-Request-ID:
              $ref: '#/components/headers/X-Request-ID'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
        '404':
          description: '- Tags with the requested ID not found.

            - Vault accounts with the requested ID not found.

            '
          headers:
            X-Request-ID:
              $ref: '#/components/headers/X-Request-ID'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
      operationId: attachOrDetachTagsFromVaultAccounts
  /vault/accounts_paged:
    get:
      summary: Get vault accounts (Paginated)
      description: "Retrieves a paginated list of all vault accounts in your workspace matching your query's criteria. \n\n**Endpoint Permissions:** Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer.\n"
      tags:
      - Vaults
      x-readme:
        code-samples:
        - language: javascript
          code: const vaultAccounts = await fireblocks.getVaultAccountsWithPageInfo(filters);
          name: Fireblocks SDK Javascript example
        - language: typescript
          code: 'const response: Promise<FireblocksResponse<VaultAccountsPagedResponse>> = fireblocks.vaults.getPagedVaultAccounts(vaultsApiGetPagedVaultAccountsRequest);'
          name: Fireblocks SDK TypeScript example
        - language: java
          code: CompletableFuture<ApiResponse<VaultAccountsPagedResponse>> response = fireblocks.vaults().getPagedVaultAccounts(namePrefix, nameSuffix, minAmountThreshold, assetId, orderBy, before, after, limit);
          name: Fireblocks SDK Java example
        - language: python
          code: response = fireblocks.vaults.get_paged_vault_accounts(name_prefix, name_suffix, min_amount_threshold, asset_id, order_by, before, after, limit);
          name: Fireblocks SDK Python example
      parameters:
      - in: query
        name: namePrefix
        required: false
        schema:
          type: string
          example: MyVaultPrefix
      - in: query
        name: nameSuffix
        required: false
        schema:
          type: string
          example: MyVaultSuffix
      - in: query
        name: minAmountThreshold
        required: false
        description: Specifying minAmountThreshold will filter accounts with balances greater than this value, otherwise, it will return all accounts. The amount set in this parameter is the native asset amount and not its USD value.
        schema:
          type: number
          example: 10
      - in: query
        name: assetId
        required: false
        schema:
          type: string
          x-fb-entity: asset
          example: ETH
      - in: query
        name: orderBy
        required: false
        schema:
          type: string
          enum:
          - ASC
          - DESC
          default: DESC
      - in: query
        name: before
        required: false
        schema:
          type: string
          example: c3RhcnRpbmdWYXVsdElkeD04NTgzNzA2Mw==
      - in: query
        name: after
        required: false
        schema:
          type: string
          example: c3RhcnRpbmdWYXVsdElkeD01NTM1NzUzNg==
      - in: query
        name: limit
        required: false
        schema:
          type: number
          minimum: 1
          maximum: 500
          default: 200
      - in: query
        name: tagIds
        required: false
        description: List of tag IDs to filter vault accounts.
        schema:
          type: array
          items:
            type: string
            format: uuid
          maxItems: 100
      responses:
        '200':
          description: A VaultAccountsPagedResponse object
          headers:
            X-Request-ID:
              $ref: '#/components/headers/X-Request-ID'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VaultAccountsPagedResponse'
      operationId: getPagedVaultAccounts
      x-codeSamples:
      - lang: TypeScript
        source: 'const response: Promise<FireblocksResponse<VaultAccountsPagedResponse>> = fireblocks.vaults.getPagedVaultAccounts(vaultsApiGetPagedVaultAccountsRequest);'
      - lang: Java
        source: CompletableFuture<ApiResponse<VaultAccountsPagedResponse>> response = fireblocks.vaults().getPagedVaultAccounts(namePrefix, nameSuffix, minAmountThreshold, assetId, orderBy, before, after, limit);
      - lang: Python
        source: response = fireblocks.vaults.get_paged_vault_accounts(name_prefix, name_suffix, min_amount_threshold, asset_id, order_by, before, after, limit);
  /vault/accounts/{vaultAccountId}:
    get:
      summary: Get a vault account by ID
      description: 'Get a vault account by its unique ID.

        </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer.'
      tags:
      - Vaults
      x-readme:
        code-samples:
        - language: javascript
          code: const vaultAccount = await fireblocks.getVaultAccount(vault_account_id);
          name: Fireblocks SDK Javascript example
        - language: typescript
          code: 'const response: Promise<FireblocksResponse<VaultAccount>> = fireblocks.vaults.getVaultAccount(vaultsApiGetVaultAccountRequest);'
          name: Fireblocks SDK TypeScript example
        - language: java
          code: CompletableFuture<ApiResponse<VaultAccount>> response = fireblocks.vaults().getVaultAccount(vaultAccountId);
          name: Fireblocks SDK Java example
        - language: python
          code: response = fireblocks.vaults.get_vault_account(vault_account_id);
          name: Fireblocks SDK Python example
      parameters:
      - in: path
        name: vaultAccountId
        required: true
        description: The ID of the vault account
        schema:
          type: string
          format: numeric
          x-fb-entity: vault_account
          example: '0'
      responses:
        '200':
          description: A Vault Account object
          headers:
            X-Request-ID:
              $ref: '#/components/headers/X-Request-ID'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VaultAccount'
        default:
          $ref: '#/components/responses/Error'
      operationId: getVaultAccount
      x-codeSamples:
      - lang: TypeScript
        source: 'const response: Promise<FireblocksResponse<VaultAccount>> = fireblocks.vaults.getVaultAccount(vaultsApiGetVaultAccountRequest);'
      - lang: Java
        source: CompletableFuture<ApiResponse<VaultAccount>> response = fireblocks.vaults().getVaultAccount(vaultAccountId);
      - lang: Python
        source: response = fireblocks.vaults.get_vault_account(vault_account_id);
    put:
      summary: Rename a vault account
      description: 'Renames the requested vault account.

        </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver.'
      tags:
      - Vaults
      x-readme:
        code-samples:
        - language: javascript
          code: const vaultAccount = await fireblocks.updateVaultAccount(vautlAccountId, name);
          name: Fireblocks SDK Javascript example
        - language: typescript
          code: 'const response: Promise<FireblocksResponse<RenameVaultAccountResponse>> = fireblocks.vaults.updateVaultAccount(vaultsApiUpdateVaultAccountRequest);'
          name: Fireblocks SDK TypeScript example
        - language: java
          code: CompletableFuture<ApiResponse<RenameVaultAccountResponse>> response = fireblocks.vaults().updateVaultAccount(updateVaultAccountRequest, vaultAccountId, idempotencyKey);
          name: Fireblocks SDK Java example
        - language: python
          code: response = fireblocks.vaults.update_vault_account(update_vault_account_request, vault_account_id, idempotency_key);
          name: Fireblocks SDK Python example
      parameters:
      - in: path
        name: vaultAccountId
        required: true
        description: The ID of the vault account
        schema:
          type: string
          format: numeric
          x-fb-entity: vault_account
          example: '0'
      - $ref: '#/components/parameters/X-Idempotency-Key'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateVaultAccountRequest'
      responses:
        '201':
          description: OK
          headers:
            X-Request-ID:
              $ref: '#/components/headers/X-Request-ID'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenameVaultAccountResponse'
        default:
          $ref: '#/components/responses/Error'
      operationId: updateVaultAccount
      x-codeSamples:
      - lang: TypeScript
        source: 'const response: Promise<FireblocksResponse<RenameVaultAccountResponse>> = fireblocks.vaults.updateVaultAccount(vaultsApiUpdateVaultAccountRequest);'
      - lang: Java
        source: CompletableFuture<ApiResponse<RenameVaultAccountResponse>> response = fireblocks.vaults().updateVaultAccount(updateVaultAccountRequest, vaultAccountId, idempotencyKey);
      - lang: Python
        source: response = fireblocks.vaults.update_vault_account(update_vault_account_request, vault_account_id, idempotency_key);
  /vault/asset_wallets:
    get:
      summary: Get vault wallets (Paginated)
      description: "Get all vault wallets of the vault accounts in your workspace. \nA vault wallet is an asset in a vault account. \n\nThis method allows fast traversal of all account balances.\n</br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer."
      tags:
      - Vaults
      x-readme:
        code-samples:
        - language: javascript
          code: const vaultAccounts = await fireblocks.getAssetWallets(filters);
          name: Fireblocks SDK Javascript example
        - language: typescript
          code: 'const response: Promise<FireblocksResponse<PaginatedAssetWalletResponse>> = fireblocks.vaults.getAssetWallets(vaultsApiGetAssetWalletsRequest);'
          name: Fireblocks SDK TypeScript example
        - language: java
          code: CompletableFuture<ApiResponse<PaginatedAssetWalletResponse>> response = fireblocks.vaults().getAssetWallets(totalAmountLargerThan, assetId, orderBy, before, after, limit);
          name: Fireblocks SDK Java example
        - language: python
          code: response = fireblocks.vaults.get_asset_wallets(total_amount_larger_than, asset_id, order_by, before, after, limit);
          name: Fireblocks SDK Python example
      parameters:
      - in: query
        name: totalAmountLargerThan
        description: When specified, only vault wallets with total balance greater than this amount are returned.
        required: false
        schema:
          type: number
          example: 14
      - in: query
        name: assetId
        required: false
        description: When specified, only vault wallets with the specified ID are returned.
        schema:
          type: string
          x-fb-entity: asset
          example: ETH
      - in: query
        name: orderBy
        required: false
        schema:
          type: string
          enum:
          - ASC
          - DESC
          default: DESC
      - in: query
        name: before
        required: false
        description: "Fetches the next paginated response before this element. \nThis element is a cursor and is returned at the response of the previous page.\n"
        schema:
          type: string
          example: c3RhcnRpbmdWYXVsdElkeD04NTgzNzA2Mw
      - in: query
        name: after
        required: false
        description: Fetches the next paginated response after this element. This element is a cursor and is returned at the response of the previous page.
        schema:
          type: string
          example: c3RhcnRpbmdWYXVsdElkeD01NTM1NzUzNg
      - in: query
        name: limit
        required: false
        description: "The maximum number of vault wallets in a single response. \n\nThe default is 200 and the maximum is 1000.\n"
        schema:
          type: number
          minimum: 1
          maximum: 1000
          default: 200
      responses:
        '200':
          description: A PaginatedAssetWalletResponse object
          headers:
            X-Request-ID:
              $ref: '#/components/headers/X-Request-ID'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedAssetWalletResponse'
      operationId: getAssetWallets
      x-codeSamples:
      - lang: TypeScript
        source: 'const response: Promise<FireblocksResponse<PaginatedAssetWalletResponse>> = fireblocks.vaults.getAssetWallets(vaultsApiGetAssetWalletsRequest);'
      - lang: Java
        source: CompletableFuture<ApiResponse<PaginatedAssetWalletResponse>> response = fireblocks.vaults().getAssetWallets(totalAmountLargerThan, assetId, orderBy, before, after, limit);
      - lang: Python
        source: response = fireblocks.vaults.get_asset_wallets(total_amount_larger_than, asset_id, order_by, before, after, limit);
  /vault/accounts/{vaultAccountId}/hide:
    post:
      summary: Hide a vault account in the console
      description: 'Hides the requested vault account from the web console view.

        This operation is required when creating thousands of vault accounts to serve your end-users.

        Used for preventing the web console to be swamped with too much vault accounts.

        Learn more in the following [guide](https://developers.fireblocks.com/docs/create-direct-custody-wallets#hiding-vault-accounts).

        NOTE: Hiding the vault account from the web console will also hide all the related transactions to/from this vault.

        </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor.'
      tags:
      - Vaults
      x-readme:
        code-samples:
        - language: javascript
          code: const vaultAsset = await fireblocks.hideVaultAccount(vaultAccountId);
          name: Fireblocks SDK Javascript example
        - language: typescript
          code: 'const response: Promise<FireblocksResponse<VaultActionStatus>> = fireblocks.vaults.hideVaultAccount(vaultsApiHideVaultAccountRequest);'
          name: Fireblocks SDK TypeScript example
        - language: java
          code: CompletableFuture<ApiResponse<VaultActionStatus>> response = fireblocks.vaults().hideVaultAccount(vaultAccountId, idempotencyKey);
          name: Fireblocks SDK Java example
        - language: python
          code: response = fireblocks.vaults.hide_vault_account(vault_account_id, idempotency_key);
          name: Fireblocks SDK Python example
      parameters:
      - in: path
        name: vaultAccountId
        required: true
        description: The vault account to hide
        schema:
          type: string
          format: numeric
          x-fb-entity: vault_account
          example: '0'
      - $ref: '#/components/parameters/X-Idempotency-Key'
      responses:
        '201':
          description: OK
          headers:
            X-Request-ID:
              $ref: '#/components/headers/X-Request-ID'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VaultActionStatus'
        default:
          $ref: '#/components/responses/Error'
      operationId: hideVaultAccount
      x-codeSamples:
      - lang: TypeScript
        source: 'const response: Promise<FireblocksResponse<VaultActionStatus>> = fireblocks.vaults.hideVaultAccount(vaultsApiHideVaultAccountRequest);'
      - lang: Java
        source: CompletableFuture<ApiResponse<VaultActionStatus>> response = fireblocks.vaults().hideVaultAccount(vaultAccountId, idempotencyKey);
      - lang: Python
        source: response = fireblocks.vaults.hide_vault_account(vault_account_id, idempotency_key);
  /vault/accounts/{vaultAccountId}/unhide:
    post:
      summary: Unhide a vault account in the console
      description: 'Makes a hidden vault account visible in web console view.

        </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor.'
      tags:
      - Vaults
      x-readme:
        code-samples:
        - language: javascript
          code: const vaultAsset = await fireblocks.unhideVaultAccount(vaultAccountId);
          name: Fireblocks SDK Javascript example
        - language: typescript
          code: 'const response: Promise<FireblocksResponse<VaultActionStatus>> = fireblocks.vaults.unhideVaultAccount(vaultsApiUnhideVaultAccountRequest);'
          name: Fireblocks SDK TypeScript example
        - language: java
          code: CompletableFuture<ApiResponse<VaultActionStatus>> response = fireblocks.vaults().unhideVaultAccount(vaultAccountId, idempotencyKey);
          name: Fireblocks SDK Java example
        - language: python
          code: response = fireblocks.vaults.unhide_vault_account(vault_account_id, idempotency_key);
          name: Fireblocks SDK Python example
      parameters:
      - in: path
        name: vaultAccountId
        required: true
        description: The vault account to unhide
        schema:
          type: string
          format: numeric
          x-fb-entity: vault_account
          example: '0'
      - $ref: '#/components/parameters/X-Idempotency-Key'
      responses:
        '201':
          description: OK
          headers:
            X-Request-ID:
              $ref: '#/components/headers/X-Request-ID'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VaultActionStatus'
        default:
          $ref: '#/components/responses/Error'
      operationId: unhideVaultAccount
      x-codeSamples:
      - lang: TypeScript
        source: 'const response: Promise<FireblocksResponse<VaultActionStatus>> = fireblocks.vaults.unhideVaultAccount(vaultsApiUnhideVaultAccountRequest);'
      - lang: Java
        source: CompletableFuture<ApiResponse<VaultActionStatus>> response = fireblocks.vaults().unhideVaultAccount(vaultAccountId, idempotencyKey);
      - lang: Python
        source: response = fireblocks.vaults.unhide_vault_account(vault_account_id, idempotency_key);
  /vault/accounts/{vaultAccountId}/{assetId}/activate:
    post:
      summary: Activate a wallet in a vault account
      description: "Initiates activation for a wallet in a vault account. \nActivation is required for tokens that need an on-chain transaction for creation (XLM tokens, SOL tokens etc).\n</br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor."
      x-readme:
        code-samples:
        - language: typescript
          code: 'const response: Promise<FireblocksResponse<CreateVaultAssetResponse>> = fireblocks.vaults.activateAssetForVaultAccount(vaultsApiActivateAssetForVaultAccountRequest);'
          name: Fireblocks SDK TypeScript example
        - language: java
          code: CompletableFuture<ApiResponse<CreateVaultAssetResponse>> response = fireblocks.vaults().activateAssetForVaultAccount(vaultAccountId, assetId, idempotencyKey);
          name: Fireblocks SDK Java example
        - language: python
          code: response = fireblocks.vaults.activate_asset_for_vault_account(vault_account_id, asset_id, idempotency_key);
          name: Fireblocks SDK Python example
      tags:
      - Vaults
      parameters:
      - in: path
        name: vaultAccountId
        required: true
        description: The ID of the vault account
        schema:
          type: string
          format: numeric
          x-fb-entity: vault_account
          example: '0'
      - in: path
        name: assetId
        required: true
        description: The ID of the asset
        schema:
          type: string
          x-fb-entity: asset
          example: SOL_USDC_PTHX
      - $ref: '#/components/parameters/X-Idempotency-Key'
      responses:
        '200':
          description: OK
          headers:
            X-Request-ID:
              $ref: '#/components/headers/X-Request-ID'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateVaultAssetResponse'
        default:
          $ref: '#/components/responses/Error'
      operationId: activateAssetForVaultAccount
      x-codeSamples:
      - lang: TypeScript
        source: 'const response: Promise<FireblocksResponse<CreateVaultAssetResponse>> = fireblocks.vaults.activateAssetForVaultAccount(vaultsApiActivateAssetForVaultAccountRequest);'
      - lang: Java
        source: CompletableFuture<ApiResponse<CreateVaultAssetResponse>> response = fireblocks.vaults().activateAssetForVaultAccount(vaultAccountId, assetId, idempotencyKey);
      - lang: Python
        source: response = fireblocks.vaults.activate_asset_for_vault_account(vault_account_id, asset_id, idempotency_key);
  /vault/accounts/{vaultAccountId}/set_customer_ref_id:
    post:
      summary: Set an AML/KYT ID for a vault account
      description: 'Assigns an AML/KYT customer reference ID for the vault account.

        Learn more about Fireblocks AML management in the following [guide](https://developers.fireblocks.com/docs/define-aml-policies).

        </br>Endpoint Permission: Admin, Non-Signing Admin.'
      tags:
      - Vaults
      x-readme:
        code-samples:
        - language: javascript
          code: const vaultAsset = await fireblocks.setCustomerRefIdForVaultAccount(vaultAccountId, customerRefId);
          name: Fireblocks SDK Javascript example
        - language: typescript
          code: 'const response: Promise<FireblocksResponse<VaultActionStatus>> = fireblocks.vaults.setVaultAcco

# --- truncated at 32 KB (106 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/fireblocks/refs/heads/main/openapi/fireblocks-vaults-api-openapi.yml