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

# Get whether a vault account is opted out of the address registry

> Returns whether this vault account is on the workspace opt-out list (`optedOut` true or false). List, add, and clear-all are available on `/v1/address_registry/vaults`; this path reads or removes one vault.



## OpenAPI

````yaml https://docs.fireblocks.com/api/v1/swagger.yaml get /address_registry/vaults/{vaultAccountId}
openapi: 3.0.0
info:
  title: Fireblocks 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.6.2
  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: []
paths:
  /address_registry/vaults/{vaultAccountId}:
    get:
      tags:
        - Compliance
      summary: Get whether a vault account is opted out of the address registry
      description: >-
        Returns whether this vault account is on the workspace opt-out list
        (`optedOut` true or false). List, add, and clear-all are available on
        `/v1/address_registry/vaults`; this path reads or removes one vault.
      operationId: getAddressRegistryVaultOptOut
      parameters:
        - name: vaultAccountId
          in: path
          required: true
          schema:
            type: integer
            format: int32
            minimum: 0
            example: 10001
          description: Vault account id (non-negative integer).
      responses:
        '200':
          description: Current opt-out flag for the vault
          headers:
            X-Request-ID:
              $ref: '#/components/headers/X-Request-ID'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AddressRegistryGetVaultOptOutResponse'
        '400':
          description: >-
            Invalid path parameter (e.g. negative or out-of-range vault account
            id)
          headers:
            X-Request-ID:
              $ref: '#/components/headers/X-Request-ID'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AddressRegistryError'
        default:
          $ref: '#/components/responses/Error'
      x-codeSamples:
        - lang: TypeScript
          source: >-
            const response:
            Promise<FireblocksResponse<AddressRegistryGetVaultOptOutResponse>> =
            fireblocks.compliance.getAddressRegistryVaultOptOut(complianceApiGetAddressRegistryVaultOptOutRequest);
        - lang: Java
          source: >-
            CompletableFuture<ApiResponse<AddressRegistryGetVaultOptOutResponse>>
            response =
            fireblocks.compliance().getAddressRegistryVaultOptOut(vaultAccountId);
        - lang: Python
          source: >-
            response =
            fireblocks.compliance.get_address_registry_vault_opt_out(vault_account_id);
components:
  headers:
    X-Request-ID:
      schema:
        type: string
      description: >-
        Unique ID correlated to the API request. Please provide it in any
        support ticket you create or on Github issues related to Fireblocks SDKs
  schemas:
    AddressRegistryGetVaultOptOutResponse:
      type: object
      description: >-
        Whether the given vault account is excluded from the address registry
        for your workspace.
      properties:
        optedOut:
          type: boolean
          description: >
            `true` if this vault account is excluded from the address registry;
            `false` if it is not excluded.
          example: false
      required:
        - optedOut
    AddressRegistryError:
      type: object
      description: Error body for address registry operations (4xx and 5xx).
      properties:
        code:
          type: integer
          description: >
            Application error code when present. For HTTP 400 on legal-entity
            lookup, distinguish: 4100 — request validation (e.g. missing, empty,
            or whitespace-only `address` after trim); 2140 — workspace not opted
            in to the address registry (`AR_OPT_IN_REQUIRED`). 2142 — not found
            (404). Other codes may appear, including on server errors.
          example: 2140
        message:
          type: string
          description: Human-readable error message
          example: Address registry opt-in required for this workspace.
      required:
        - message
    ErrorSchema:
      type: object
      properties:
        message:
          type: string
        code:
          type: number
  responses:
    Error:
      description: Error Response
      headers:
        X-Request-ID:
          $ref: '#/components/headers/X-Request-ID'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorSchema'

````