> ## Documentation Index > Fetch the complete documentation index at: https://docs.kraken.com/llms.txt > Use this file to discover all available pages before exploring further. # List whitelist addresses > Returns the whitelisted withdrawal addresses for a vault, optionally filtered by asset. **Rate limit:** 200 requests per 30 seconds per IP. ## OpenAPI ````yaml /openapi/insto-custody-rest.yaml get /v0/insto/custody/vaults/{vault_id}/whitelist/addresses openapi: 3.0.0 info: title: Insto Custody External REST API version: 1.0.0 description: '' servers: - url: https://api.kraken.com description: Production Server security: - API-Key: [] API-Sign: [] tags: - name: Custody External API - name: apiFormat:kraken2025 paths: /v0/insto/custody/vaults/{vault_id}/whitelist/addresses: get: tags: - Custody External API - apiFormat:kraken2025 summary: List whitelist addresses description: >- Returns the whitelisted withdrawal addresses for a vault, optionally filtered by asset. **Rate limit:** 200 requests per 30 seconds per IP. operationId: getV0InstoCustodyVaultsVaultIdWhitelistAddresses parameters: - in: path name: vault_id required: true description: >- Vault identifier, a `V`-prefixed 14-char base32 string with a final check character. schema: type: string example: VABCDEF234567A style: simple - in: query name: asset description: >- Filter results to a single asset code (e.g. `BTC`). Requires `asset_class` when supplied. schema: type: string example: BTC style: form - in: query name: asset_class description: >- Asset class filter. Required when `asset` is supplied. Currently only `currency` is supported. schema: type: string example: currency style: form responses: '200': description: Whitelisted withdrawal addresses for the vault. content: application/json: schema: type: array items: type: object properties: asset: type: string description: >- Asset code of the whitelisted address (e.g. `BTC`, `ETH`, `USD`). example: BTC asset_class: type: string description: Asset class. Currently always `currency`. example: currency address_name: type: string description: >- Human-readable label assigned to the address at whitelisting time. example: My BTC Wallet address: type: string description: >- Destination blockchain address. Omitted for entries that only carry beneficiary information. example: 1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa tag: type: string description: >- Destination tag, memo, or other secondary identifier required by chains that use one. Examples: XRP destination tag, EOS memo. example: destination-tag-42 description: type: string description: >- Free-text description provided when the address was whitelisted. example: Primary cold storage wallet beneficiary: type: object properties: recipient: type: string description: >- Beneficiary recipient classification (e.g. `other`, `self`). example: other type: type: string description: Beneficiary type (e.g. `business`, `individual`). example: business name: type: string description: Beneficiary first or given name. example: Blue Moon last_name: type: string description: Beneficiary surname. example: Smith vasp_name: type: string description: >- Virtual Asset Service Provider name for the beneficiary. example: Self-custody country: type: string description: Beneficiary country (ISO 3166-1 alpha-2 code). example: US province: type: string description: Beneficiary state, province, or region. example: California address_1: type: string description: Beneficiary street address, line 1. example: 123 Main St address_2: type: string description: Beneficiary street address, line 2. example: Apt 4B city: type: string description: Beneficiary city. example: New York postal_code: type: string description: Beneficiary postal or ZIP code. example: '10001' description: >- Beneficiary details captured for the address. Omitted when no beneficiary information was provided. required: - asset - asset_class - address_name description: >- A whitelisted withdrawal address entry. Beneficiary fields are present only when supplied at whitelisting time. description: List of whitelisted addresses for the vault. '400': description: >- Bad Request. The request failed validation. Examples: malformed `vault_id`, or `asset` supplied without `asset_class`. content: application/problem+json: schema: description: >- Type for errors when using the Kraken2025 format. This format follows `Problem Details for HTTP APIs` ([rfc7807]). [rfc7807]: https://datatracker.ietf.org/doc/html/rfc7807 type: object properties: type: description: >- URL uniquely identifying the error type relative to an operation type: string enum: - tag:kraken.com,2025:BadRequest example: tag:kraken.com,2025:BadRequest status: description: HTTP status (provided for convenience) type: integer format: uint16 minimum: 0 example: 400 title: description: Short human-readable summary type: string example: Bad Request detail: nullable: true description: Help to solve the problem type: string example: asset supplied without asset_class instance: nullable: true description: Link to debug data for this particular error type: string example: https://debug.kraken.com/req/01HXYZABCDEF data: description: Error-specific payload. type: object properties: message: description: Human-readable description of the validation failure. type: string example: asset_class is required when asset is supplied required: - message required: - data - status - title - type '403': description: Forbidden. The caller lacks access to the requested vault. content: application/problem+json: schema: description: >- Type for errors when using the Kraken2025 format. This format follows `Problem Details for HTTP APIs` ([rfc7807]). [rfc7807]: https://datatracker.ietf.org/doc/html/rfc7807 type: object properties: type: description: >- URL uniquely identifying the error type relative to an operation type: string enum: - tag:kraken.com,2025:PermissionDenied example: tag:kraken.com,2025:PermissionDenied status: description: HTTP status (provided for convenience) type: integer format: uint16 minimum: 0 example: 403 title: description: Short human-readable summary type: string example: Permission Denied detail: nullable: true description: Help to solve the problem type: string example: The caller does not have access to the requested vault. instance: nullable: true description: Link to debug data for this particular error type: string example: https://debug.kraken.com/req/01HXYZABCDEF data: description: Error-specific payload. type: object properties: message: description: Human-readable description of why access was denied. type: string example: Caller lacks read access to vault VABCDEF234567A required: - message required: - data - status - title - type '500': description: >- Internal Server Error. An unhandled exception occurred while serving the request. content: application/problem+json: schema: oneOf: - description: >- Type for errors when using the Kraken2025 format. This format follows `Problem Details for HTTP APIs` ([rfc7807]). [rfc7807]: https://datatracker.ietf.org/doc/html/rfc7807 type: object properties: type: description: >- URL uniquely identifying the error type relative to an operation type: string enum: - tag:kraken.com,2025:gateway/ReadUpstream example: tag:kraken.com,2025:gateway/ReadUpstream status: description: HTTP status (provided for convenience) type: integer format: uint16 minimum: 0 example: 500 title: description: Short human-readable summary type: string example: Internal Server Error detail: nullable: true description: Help to solve the problem type: string example: Failed to read response from upstream custody service. instance: nullable: true description: Link to debug data for this particular error type: string example: https://debug.kraken.com/req/01HXYZABCDEF data: description: Custom data attached to this problem required: - data - status - title - type - description: >- Type for errors when using the Kraken2025 format. This format follows `Problem Details for HTTP APIs` ([rfc7807]). [rfc7807]: https://datatracker.ietf.org/doc/html/rfc7807 type: object properties: type: description: >- URL uniquely identifying the error type relative to an operation type: string enum: - tag:kraken.com,2025:gateway/ReadUpstream example: tag:kraken.com,2025:gateway/ReadUpstream status: description: HTTP status (provided for convenience) type: integer format: uint16 minimum: 0 example: 500 title: description: Short human-readable summary type: string example: Internal Server Error detail: nullable: true description: Help to solve the problem type: string example: Failed to read response from upstream custody service. instance: nullable: true description: Link to debug data for this particular error type: string example: https://debug.kraken.com/req/01HXYZABCDEF data: description: Custom data attached to this problem required: - data - status - title - type - description: >- Type for errors when using the Kraken2025 format. This format follows `Problem Details for HTTP APIs` ([rfc7807]). [rfc7807]: https://datatracker.ietf.org/doc/html/rfc7807 type: object properties: type: description: >- URL uniquely identifying the error type relative to an operation type: string enum: - tag:kraken.com,2025:gateway/ReadUpstream example: tag:kraken.com,2025:gateway/ReadUpstream status: description: HTTP status (provided for convenience) type: integer format: uint16 minimum: 0 example: 500 title: description: Short human-readable summary type: string example: Internal Server Error detail: nullable: true description: Help to solve the problem type: string example: Failed to read response from upstream custody service. instance: nullable: true description: Link to debug data for this particular error type: string example: https://debug.kraken.com/req/01HXYZABCDEF data: description: Custom data attached to this problem required: - data - status - title - type - description: >- Type for errors when using the Kraken2025 format. This format follows `Problem Details for HTTP APIs` ([rfc7807]). [rfc7807]: https://datatracker.ietf.org/doc/html/rfc7807 type: object properties: type: description: >- URL uniquely identifying the error type relative to an operation type: string enum: - tag:kraken.com,2025:gateway/WriteResponse example: tag:kraken.com,2025:gateway/WriteResponse status: description: HTTP status (provided for convenience) type: integer format: uint16 minimum: 0 example: 500 title: description: Short human-readable summary type: string example: Internal Server Error detail: nullable: true description: Help to solve the problem type: string example: Failed to write response to upstream custody service. instance: nullable: true description: Link to debug data for this particular error type: string example: https://debug.kraken.com/req/01HXYZABCDEF data: description: Custom data attached to this problem required: - data - status - title - type - description: >- Type for errors when using the Kraken2025 format. This format follows `Problem Details for HTTP APIs` ([rfc7807]). [rfc7807]: https://datatracker.ietf.org/doc/html/rfc7807 type: object properties: type: description: >- URL uniquely identifying the error type relative to an operation type: string enum: - tag:kraken.com,2025:gateway/Connect example: tag:kraken.com,2025:gateway/Connect status: description: HTTP status (provided for convenience) type: integer format: uint16 minimum: 0 example: 500 title: description: Short human-readable summary type: string example: Internal Server Error detail: nullable: true description: Help to solve the problem type: string example: Failed to connect to upstream custody service. instance: nullable: true description: Link to debug data for this particular error type: string example: https://debug.kraken.com/req/01HXYZABCDEF data: description: Custom data attached to this problem required: - data - status - title - type - description: >- Type for errors when using the Kraken2025 format. This format follows `Problem Details for HTTP APIs` ([rfc7807]). [rfc7807]: https://datatracker.ietf.org/doc/html/rfc7807 type: object properties: type: description: >- URL uniquely identifying the error type relative to an operation type: string enum: - tag:kraken.com,2025:gateway/ReadUpstream example: tag:kraken.com,2025:gateway/ReadUpstream status: description: HTTP status (provided for convenience) type: integer format: uint16 minimum: 0 example: 500 title: description: Short human-readable summary type: string example: Internal Server Error detail: nullable: true description: Help to solve the problem type: string example: Failed to read response from upstream custody service. instance: nullable: true description: Link to debug data for this particular error type: string example: https://debug.kraken.com/req/01HXYZABCDEF data: description: Custom data attached to this problem required: - data - status - title - type - description: >- Type for errors when using the Kraken2025 format. This format follows `Problem Details for HTTP APIs` ([rfc7807]). [rfc7807]: https://datatracker.ietf.org/doc/html/rfc7807 type: object properties: type: description: >- URL uniquely identifying the error type relative to an operation type: string enum: - tag:kraken.com,2025:gateway/ReadUpstream example: tag:kraken.com,2025:gateway/ReadUpstream status: description: HTTP status (provided for convenience) type: integer format: uint16 minimum: 0 example: 500 title: description: Short human-readable summary type: string example: Internal Server Error detail: nullable: true description: Help to solve the problem type: string example: Failed to read response from upstream custody service. instance: nullable: true description: Link to debug data for this particular error type: string example: https://debug.kraken.com/req/01HXYZABCDEF data: description: Custom data attached to this problem required: - data - status - title - type - description: >- Type for errors when using the Kraken2025 format. This format follows `Problem Details for HTTP APIs` ([rfc7807]). [rfc7807]: https://datatracker.ietf.org/doc/html/rfc7807 type: object properties: type: description: >- URL uniquely identifying the error type relative to an operation type: string enum: - tag:kraken.com,2025:gateway/ReadUpstream example: tag:kraken.com,2025:gateway/ReadUpstream status: description: HTTP status (provided for convenience) type: integer format: uint16 minimum: 0 example: 500 title: description: Short human-readable summary type: string example: Internal Server Error detail: nullable: true description: Help to solve the problem type: string example: Failed to read response from upstream custody service. instance: nullable: true description: Link to debug data for this particular error type: string example: https://debug.kraken.com/req/01HXYZABCDEF data: description: Custom data attached to this problem required: - data - status - title - type - description: >- Type for errors when using the Kraken2025 format. This format follows `Problem Details for HTTP APIs` ([rfc7807]). [rfc7807]: https://datatracker.ietf.org/doc/html/rfc7807 type: object properties: type: description: >- URL uniquely identifying the error type relative to an operation type: string enum: - tag:kraken.com,2025:gateway/WriteResponse example: tag:kraken.com,2025:gateway/WriteResponse status: description: HTTP status (provided for convenience) type: integer format: uint16 minimum: 0 example: 500 title: description: Short human-readable summary type: string example: Internal Server Error detail: nullable: true description: Help to solve the problem type: string example: Failed to write response to upstream custody service. instance: nullable: true description: Link to debug data for this particular error type: string example: https://debug.kraken.com/req/01HXYZABCDEF data: description: Custom data attached to this problem required: - data - status - title - type - description: >- Type for errors when using the Kraken2025 format. This format follows `Problem Details for HTTP APIs` ([rfc7807]). [rfc7807]: https://datatracker.ietf.org/doc/html/rfc7807 type: object properties: type: description: >- URL uniquely identifying the error type relative to an operation type: string enum: - tag:kraken.com,2025:gateway/Fatal example: tag:kraken.com,2025:gateway/Fatal status: description: HTTP status (provided for convenience) type: integer format: uint16 minimum: 0 example: 500 title: description: Short human-readable summary type: string example: Internal Server Error detail: nullable: true description: Help to solve the problem type: string example: >- A fatal gateway error occurred while serving the request. instance: nullable: true description: Link to debug data for this particular error type: string example: https://debug.kraken.com/req/01HXYZABCDEF data: description: Custom data attached to this problem required: - data - status - title - type - description: >- Type for errors when using the Kraken2025 format. This format follows `Problem Details for HTTP APIs` ([rfc7807]). [rfc7807]: https://datatracker.ietf.org/doc/html/rfc7807 type: object properties: type: description: >- URL uniquely identifying the error type relative to an operation type: string enum: - tag:kraken.com,2025:Unknown example: tag:kraken.com,2025:Unknown status: description: HTTP status (provided for convenience) type: integer format: uint16 minimum: 0 example: 500 title: description: Short human-readable summary type: string example: Internal Server Error detail: nullable: true description: Help to solve the problem type: string example: >- An unexpected error occurred while serving the request. instance: nullable: true description: Link to debug data for this particular error type: string example: https://debug.kraken.com/req/01HXYZABCDEF data: type: object properties: message: type: string description: >- Human-readable description of the underlying failure. example: >- Unhandled exception while listing whitelisted addresses core_error: type: string description: Identifier for the originating error. example: InternalError required: - message - core_error description: >- Error-specific payload returned for an unhandled exception. required: - data - status - title - type '503': description: >- Service Unavailable. The upstream custody service could not be reached. content: application/problem+json: schema: description: >- Type for errors when using the Kraken2025 format. This format follows `Problem Details for HTTP APIs` ([rfc7807]). [rfc7807]: https://datatracker.ietf.org/doc/html/rfc7807 type: object properties: type: description: >- URL uniquely identifying the error type relative to an operation type: string enum: - tag:kraken.com,2025:gateway/Connect example: tag:kraken.com,2025:gateway/Connect status: description: HTTP status (provided for convenience) type: integer format: uint16 minimum: 0 example: 503 title: description: Short human-readable summary type: string example: Service Unavailable detail: nullable: true description: Help to solve the problem type: string example: >- Downstream custody service is temporarily unreachable; retry with backoff. instance: nullable: true description: Link to debug data for this particular error type: string example: https://debug.kraken.com/req/01HXYZABCDEF data: description: Custom data attached to this problem required: - data - status - title - type security: - API Key Auth (key): [] API Key Auth (signature): [] API Key Auth (nonce): [] API Key Auth (otp): [] components: securitySchemes: API Key Auth (key): type: apiKey in: header name: api-key API Key Auth (signature): type: apiKey in: header name: api-sign API Key Auth (nonce): type: apiKey in: header name: api-nonce API Key Auth (otp): type: apiKey in: header name: api-otp ````