> ## 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. # Get task by id > Returns the full details of a single task, including its payload, the activity timeline, and reviewer/quorum state. Available only to callers in the task's owning organization. For batch action types the payload is replaced by per-item operations. **Rate limit:** 200 requests per 30 seconds per IP. ## OpenAPI ````yaml /openapi/insto-custody-rest.yaml get /v0/insto/custody/tasks/{id} 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/tasks/{id}: get: tags: - Custody External API - apiFormat:kraken2025 summary: Get task by id description: >- Returns the full details of a single task, including its payload, the activity timeline, and reviewer/quorum state. Available only to callers in the task's owning organization. For batch action types the payload is replaced by per-item operations. **Rate limit:** 200 requests per 30 seconds per IP. operationId: getV0InstoCustodyTasksId parameters: - in: path name: id required: true description: Task identifier, a `T`-prefixed 14-char base32 string. schema: type: string example: TABCDEF234567A style: simple responses: '200': description: Full details of the requested task. content: application/json: schema: type: object properties: id: description: Task identifier, a `T`-prefixed 14-char base32 string. type: string example: TABCDEF234567A approval_id: description: Approval UUID, when the task is part of an approval flow. type: string example: 1ef8cecf-5d7b-4f83-9640-96d74db0e858 type: description: >- Action-type discriminator for the task (e.g. `request_withdrawal`, `create_vault`, `normalized_task`). type: string example: request_withdrawal type_label: description: >- Human-readable label for the task type, suitable for UI display. type: string example: Withdrawal Request state: description: >- Lifecycle state of the task. One of `pending`, `approved`, `rejected`, `canceled`, `expired`, `failed`, `executed`. type: string example: pending created_at: description: Unix timestamp (seconds) when the task was created. type: string example: '1737028496' updated_at: description: Unix timestamp (seconds) when the task was last updated. type: string example: '1737028496' expires_at: description: >- Unix timestamp (seconds) when the task expires if no decision is reached. type: string example: '1737114896' initiator: description: User or API key that initiated the task. type: object properties: full_name: description: >- Display name of the initiator at the time the task was created. type: string example: Alex Doe role: description: >- Role assigned to the initiator at the time the task was created. type: string example: vault_admin ip_address: description: >- Source IP address recorded when the task was initiated. type: string example: 203.0.113.10 iiban: description: >- 16-char IIBAN identifying the initiating user or API key. type: string example: ABCD EFGH IJKL MNOP quorum_type: description: >- Scope of the quorum required to advance the task. `domain` for org-wide quorum, `vault` for vault-scoped quorum. type: string example: vault can_review: description: >- True if the caller may still cast a review decision on this task. type: boolean example: true reviewer_statistics: description: >- Tally of reviewer decisions for single-quorum tasks. Omitted for multi-quorum tasks. Use `subquorum_approvals` when `reviewer_statistics_label` is `multiquorum`. type: object properties: current_count: description: >- Total number of reviewers currently assigned to the task. type: integer format: int32 example: 3 approved: description: Number of reviewers who have approved. type: integer example: 2 format: int32 denied: description: Number of reviewers who have denied. type: integer format: int32 example: 0 undecided: description: >- Number of assigned reviewers who have not yet cast a decision. type: integer example: 1 format: int32 required_quorum: description: >- Number of approving reviewers required for the task to advance. type: integer format: int32 example: 2 required: - approved - denied - undecided current_user_decision: description: >- The caller's own decision on this task. One of `undecided`, `approved`, `denied`. type: string example: undecided vault_info: description: >- Vault the task is scoped to. Omitted for domain-level tasks that do not target a specific vault. type: object properties: id: description: >- Vault identifier, a `V`-prefixed 14-char base32 string with a final check character. type: string example: VABCDEF234567A name: description: Display name of the vault. type: string example: My Vault status: description: >- Current vault lifecycle status (lowercase, e.g. `active`, `archived`). type: string example: active subquorum_config: description: >- Vault's current subquorum policy, the group structure used to compute approvals on multi-quorum tasks. type: object properties: groups: type: array items: type: object properties: id: type: string example: 1ef8cecf-5d7b-4f83-9640-96d74db0e858 required: type: number example: 2 format: double members: type: array items: type: object properties: iiban: type: string example: ABCD EFGH IJKL MNOP full_name: type: string example: Alex Doe email: type: string example: alex.doe@example.com role: type: string example: vault_admin required: - iiban required: - id - required - members required: - groups required: - id payload: description: >- Task payload, shaped according to the task's action type. Exactly one variant field is populated. type: object properties: request_withdrawal: description: >- Withdrawal of crypto/fiat from a custody vault to a whitelisted external address. type: object properties: amount: type: string example: '0.5' comment: type: string example: Transaction approved by finance team. address: type: object properties: asset: type: string example: BTC address_name: type: string example: My BTC Wallet method: type: string example: Bitcoin info: type: object properties: address: type: string example: 1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa tag: type: string example: '1234567' beneficiary: type: object properties: recipient: type: string example: self type: type: string example: business name: type: string example: Acme Trading Ltd last_name: type: string example: Doe country: type: string example: US province: type: string example: CA address_1: type: string example: 123 Main Street address_2: type: string example: Suite 400 city: type: string example: San Francisco postal_code: type: string example: '94105' vasp_name: type: string example: Example VASP Inc. description: type: string example: Primary cold storage vault. required: - asset - address_name - method - info fee_info: type: object properties: amount: type: string example: '0.5' asset: type: string example: BTC included: type: boolean example: true level: type: string example: default quote_id: type: string example: Q-2026-0115-ABCDEF quote_amount: type: string example: '32500.00' quote_asset: type: string example: USD required: - amount - asset - included - level - quote_id quote_amount: type: string example: '32500.00' quote_asset: type: string example: USD required: - amount - address - fee_info create_vault: description: >- Creation of a new custody vault, including its initial policies, users, and whitelisted withdrawal addresses. type: object properties: name: type: string example: My Vault description: type: string example: Primary cold storage vault. policies: type: array items: type: object properties: type: type: string example: withdrawal_limit amount: type: string example: '0.5' required: type: number example: 2 format: double available: type: number example: 5 format: double enable: type: boolean example: true required: - type - amount - required - enable users: type: array items: type: object properties: iiban: type: string example: ABCD EFGH IJKL MNOP full_name: type: string example: Alex Doe email: type: string example: alex.doe@example.com role: type: string example: vault_admin required: - iiban - role withdrawal_addresses: type: array items: type: object properties: asset: type: string example: BTC address_name: type: string example: My BTC Wallet method: type: string example: Bitcoin info: type: object properties: address: type: string example: 1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa tag: type: string example: '1234567' beneficiary: type: object properties: recipient: type: string example: self type: type: string example: business name: type: string example: Acme Trading Ltd last_name: type: string example: Doe country: type: string example: US province: type: string example: CA address_1: type: string example: 123 Main Street address_2: type: string example: Suite 400 city: type: string example: San Francisco postal_code: type: string example: '94105' vasp_name: type: string example: Example VASP Inc. description: type: string example: Primary cold storage vault. required: - asset - address_name - method - info required: - name - policies - users update_vault: description: >- Update of a vault's display metadata such as name, description, or organization IIBAN. type: object properties: name: type: string example: My Vault description: type: string example: Primary cold storage vault. org_iiban: type: string example: ABCD EFGH IJKL MNOP request_transfer_to_spot: description: >- Transfer of funds from a custody vault to a Kraken spot trading account. type: object properties: tx_id: type: string example: 01HXYZABCDEF amount: type: string example: '0.5' asset: type: string example: BTC iiban: type: string example: ABCD EFGH IJKL MNOP fee_info: type: object properties: amount: type: string example: '0.5' asset: type: string example: BTC included: type: boolean example: true level: type: string example: default quote_id: type: string example: Q-2026-0115-ABCDEF quote_amount: type: string example: '32500.00' quote_asset: type: string example: USD required: - amount - asset - included - level - quote_id quote_amount: type: string example: '32500.00' quote_asset: type: string example: USD required: - tx_id - amount - asset - iiban request_allocation: description: >- Allocation of vault assets to a staking provider for bonded rewards. type: object properties: fee_info: type: object properties: quote_id: type: string example: Q-2026-0115-ABCDEF level: type: string example: default asset: type: string example: BTC amount: type: string example: '0.5' quote_amount: type: string example: '32500.00' quote_asset: type: string example: USD required: - quote_id - level - asset - amount provider: type: string example: Kraken Staking bonding_period: type: number example: 7 format: double unbonding_period: type: number example: 14 format: double asset: type: string example: BTC amount: type: string example: '0.5' quote_amount: type: string example: '32500.00' quote_asset: type: string example: USD required: - fee_info - provider - asset - amount request_deallocation: description: >- Deallocation (unbonding) of staked assets from a staking provider. type: object properties: provider: type: string example: Kraken Staking unbonding_period: type: number example: 14 format: double fee_info: type: object properties: quote_id: type: string example: Q-2026-0115-ABCDEF level: type: string example: default asset: type: string example: BTC amount: type: string example: '0.5' quote_amount: type: string example: '32500.00' quote_asset: type: string example: USD required: - quote_id - level - asset - amount asset: type: string example: BTC amount: type: string example: '0.5' quote_amount: type: string example: '32500.00' quote_asset: type: string example: USD required: - provider - asset - amount request_custody_transfer_to_spot: description: >- Internal custody-to-spot transfer, available alongside `request_transfer_to_spot`. type: object properties: tx_id: type: string example: 01HXYZABCDEF amount: type: string example: '0.5' asset: type: string example: BTC iiban: type: string example: ABCD EFGH IJKL MNOP fee_info: type: object properties: quote_id: type: string example: Q-2026-0115-ABCDEF level: type: string example: default asset: type: string example: BTC amount: type: string example: '0.5' quote_amount: type: string example: '32500.00' quote_asset: type: string example: USD required: - quote_id - level - asset - amount quote_amount: type: string example: '32500.00' quote_asset: type: string example: USD required: - tx_id - amount - asset - iiban request_pledge: description: >- Pledge of vault assets as collateral for a third-party position. type: object properties: amount: type: string example: '0.5' asset: type: string example: BTC asset_class: type: string example: currency user_id: type: number example: 12345 format: double transaction_id: type: string example: 01HXYZABCDEF quote_amount: type: string example: '32500.00' quote_asset: type: string example: USD required: - amount - asset - asset_class - user_id - transaction_id request_release: description: Release of previously pledged vault assets. type: object properties: amount: type: string example: '0.5' asset: type: string example: BTC asset_class: type: string example: currency user_id: type: number example: 12345 format: double transaction_id: type: string example: 01HXYZABCDEF quote_amount: type: string example: '32500.00' quote_asset: type: string example: USD required: - amount - asset - asset_class - user_id - transaction_id normalized_task: description: >- Container for one or more instructions that make up the task. type: object properties: instructions: type: array items: type: object properties: org_remove_user: type: object properties: version: type: number example: 1 format: double intent: type: object properties: label: type: string example: Remove user from organisation categories: type: array items: type: string example: user required: - label - categories org_iiban: type: string example: AA88 N84G AET3 RAOA user_iiban: type: string example: ABCD EFGH IJKL MNOP reason: type: string example: Employee offboarded user_full_name: type: string example: Alex Doe user_email: type: string example: alex.doe@example.com execution: type: object properties: state: type: string example: completed started_at: type: number example: 1737028496 format: double completed_at: type: number example: 1737028596 format: double error: type: string example: '' required: - state required: - version - intent - org_iiban - user_iiban subquorum_update: type: object properties: version: type: number example: 1 format: double intent: type: object properties: label: type: string example: Subquorum policy update categories: type: array items: type: string example: policy required: - label - categories vault_id: type: string example: VABCDEF234567A subquorum_config: type: object properties: groups: type: array items: type: object properties: id: type: string example: 1ef8cecf-5d7b-4f83-9640-96d74db0e858 required: type: number example: 2 format: double members: type: array items: type: object properties: iiban: type: string example: ABCD EFGH IJKL MNOP full_name: type: string example: Alex Doe email: type: string example: alex.doe@example.com role: type: string example: vault_admin required: - iiban required: - id - required - members required: - groups execution: type: object properties: state: type: string example: completed started_at: type: number example: 1737028496 format: double completed_at: type: number example: 1737028596 format: double error: type: string example: '' required: - state required: - version - intent - vault_id - subquorum_config update_vaults_users: type: object properties: version: type: number example: 1 format: double intent: type: object properties: label: type: string example: Subquorum policy update categories: type: array items: type: string example: policy required: - label - categories vault_id: type: string example: VABCDEF234567A operation_type: type: string example: add user: type: string example: ABCD EFGH IJKL MNOP reason: type: string example: Routine quarterly rotation. execution: type: object properties: state: type: string example: completed started_at: type: number example: 1737028496 format: double completed_at: type: number example: 1737028596 format: double error: type: string example: '' required: - state vault_name: type: string example: My Vault required: - version - intent - vault_id - operation_type - user update_vault_policies: type: object properties: version: type: number example: 1 format: double intent: type: object properties: label: type: string example: Subquorum policy update categories: type: array items: type: string example: policy required: - label - categories vault_id: type: string example: VABCDEF234567A operations: type: array items: type: object properties: type: type: string example: add item: type: object properties: type: type: string example: withdrawal_limit amount: type: string example: '0.5' required: type: number example: 2 format: double available: type: number example: 5 format: double enable: type: boolean example: true required: - type - amount - required - enable required: - type - item execution: type: object properties: state: type: string example: completed started_at: type: number example: 1737028496 format: double completed_at: type: number example: 1737028596 format: double error: type: string example: '' required: - state required: - version - intent - vault_id - operations required: - instructions operations: description: >- For batch action types such as policy and user updates, the list of per-item operations that make up the task. Each entry populates exactly one of the variant fields. type: array items: type: object properties: update_domain_policies: description: >- Add, remove, or modify a domain-level policy (e.g. required-approvals threshold). type: object properties: type: type: string example: add item: type: object properties: type: type: string example: withdrawal_limit required: type: number example: 2 format: double available: type: number example: 5 format: double required: - type - required required: - type - item create_users: description: >- Provision a new user in the domain with the supplied role, profile, and attributes. type: object properties: type: type: string example: add item: type: object properties: email: type: string example: alex.doe@example.com role: type: string example: vault_admin full_name: type: object properties: first_name: type: string example: Alex middle_name: type: string example: M last_name: type: string example: Doe required: - first_name - last_name language: type: string example: en timezone: type: string example: UTC attributes: type: array items: type: string example: withdrawal required: - email - role - full_name required: - type - item update_status_users: description: Enable or disable an existing user. type: object properties: type: type: string example: add item: type: object properties: user: type: object properties: iiban: type: string example: ABCD EFGH IJKL MNOP full_name: type: string example: Alex Doe email: type: string example: alex.doe@example.com role: type: string example: vault_admin required: - iiban - role reason: type: string example: Routine quarterly rotation. required: - user required: - item update_withdrawal_addresses: description: >- Whitelist a new withdrawal address or remove an existing one. type: object properties: type: type: string example: add item: type: object properties: asset: type: string example: BTC address_name: type: string example: My BTC Wallet method: type: string example: Bitcoin info: type: object properties: address: type: string example: 1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa tag: type: string example: '1234567' beneficiary: type: object properties: recipient: type: string example: self type: type: string example: business name: type: string example: Acme Trading Ltd last_name: type: string example: Doe country: type: string example: US province: type: string example: CA address_1: type: string example: 123 Main Street address_2: type: string example: Suite 400 city: type: string example: San Francisco postal_code: type: string example: '94105' vasp_name: type: string example: Example VASP Inc. description: type: string example: Primary cold storage vault. reason: type: string example: Routine quarterly rotation. required: - asset - address_name - method - info required: - item update_vault_users: description: Add or remove a user as a member of a vault. type: object properties: type: type: string example: add item: type: object properties: user: type: object properties: iiban: type: string example: ABCD EFGH IJKL MNOP full_name: type: string example: Alex Doe email: type: string example: alex.doe@example.com role: type: string example: vault_admin required: - iiban - role reason: type: string example: Routine quarterly rotation. required: - user required: - item update_vault_policies: description: Add, remove, or modify a vault-level policy. type: object properties: type: type: string example: add item: type: object properties: type: type: string example: withdrawal_limit amount: type: string example: '0.5' required: type: number example: 2 format: double available: type: number example: 5 format: double enable: type: boolean example: true required: - type - amount - required - enable required: - type - item update_permission_users: description: Change a user's role or attribute assignment. type: object properties: type: type: string example: add item: type: object properties: user: type: object properties: iiban: type: string example: ABCD EFGH IJKL MNOP full_name: type: string example: Alex Doe email: type: string example: alex.doe@example.com role: type: string example: vault_admin required: - iiban - role reason: type: string example: Routine quarterly rotation. role: type: string example: vault_admin attribute: type: string example: owner required: - user - role - attribute required: - item create_api_users: description: >- Provision a new API user with the supplied role, allowlist, validity, and vault scope. type: object properties: type: type: string example: add item: type: object properties: attributes: type: array items: type: string example: withdrawal role: type: string example: vault_admin name: type: string example: My Vault ip_allowlist: type: array items: type: string example: 203.0.113.10 valid_until: type: string example: '2026-12-31T23:59:59Z' vaults: type: array items: type: string example: VABCDEF234567A required: - role - name required: - type - item update_api_users: description: >- Change an API user's settings such as allowlist, expiry, role, attribute, or vault assignment. type: object properties: type: type: string example: add item: type: object properties: ip_allowlist: type: array items: type: string example: 203.0.113.10 valid_until: type: string example: '2026-12-31T23:59:59Z' user: type: object properties: iiban: type: string example: ABCD EFGH IJKL MNOP full_name: type: string example: Alex Doe email: type: string example: alex.doe@example.com role: type: string example: vault_admin required: - iiban - role reason: type: string example: Routine quarterly rotation. role: type: string example: vault_admin attribute: type: string example: owner vault: type: object properties: id: type: string example: VABCDEF234567A iiban: type: string example: ABCD EFGH IJKL MNOP name: type: string example: My Vault required: - id required: - user - role - attribute - vault required: - item update_vaults_users: description: >- Add or remove a user across a set of vaults in one operation. type: object properties: type: type: string example: add item: type: object properties: user: type: object properties: iiban: type: string example: ABCD EFGH IJKL MNOP full_name: type: string example: Alex Doe email: type: string example: alex.doe@example.com role: type: string example: vault_admin required: - iiban - role reason: type: string example: Routine quarterly rotation. vault_id: type: string example: VABCDEF234567A vault_name: type: string example: My Vault required: - user - vault_id required: - item activities: description: >- Chronological audit trail of actions taken against the task: creation, reviews, executions, and state transitions. type: array items: type: object properties: id: description: Activity identifier (UUID v4). type: string example: 9f8c3a1b-4d2e-4f5a-8e7c-1a2b3c4d5e6f user_iiban: description: >- IIBAN of the user or API key that performed the action. type: string example: ABCD EFGH IJKL MNOP action: description: >- Activity action discriminator (lowercase), e.g. `created`, `review_approved`, `review_denied`, `executed`. type: string example: review_approved state: description: Task state at the time of the activity (lowercase). type: string example: pending is_pending: description: >- True if the activity reflects a pending (not yet finalized) action. type: boolean example: false timestamp: description: Unix timestamp (seconds) when the activity occurred. type: string example: '1737028496' user_ip: description: Source IP address recorded for the activity. type: string example: 203.0.113.10 comment: description: Reviewer-supplied comment, when present. type: string example: Transaction approved by finance team. vault_id: description: Vault the activity is scoped to, when applicable. type: string example: VABCDEF234567A user: description: >- Resolved user/API-key details, when the actor can be looked up at read time. type: object properties: full_name: type: string example: Alex Doe role: type: string example: vault_admin ip_address: type: string example: 203.0.113.10 iiban: type: string example: ABCD EFGH IJKL MNOP required: - id - user_iiban - action - state - is_pending - timestamp reviewer_statistics_label: description: >- Indicates which reviewer-tally field to consult. `standard` means use `reviewer_statistics`; `multiquorum` means use `subquorum_approvals`. type: string example: standard subquorum_snapshot: description: >- Subquorum policy snapshot taken when the task was created. Approvals are evaluated against this snapshot so a later policy change cannot retroactively invalidate decisions already cast. type: object properties: groups: description: Subquorum groups captured in the snapshot. type: array items: type: object properties: id: type: string example: 1ef8cecf-5d7b-4f83-9640-96d74db0e858 required: type: number example: 2 format: double members: type: array items: type: object properties: iiban: type: string example: ABCD EFGH IJKL MNOP full_name: type: string example: Alex Doe email: type: string example: alex.doe@example.com role: type: string example: vault_admin required: - iiban required: - id - required - members required: - groups subquorum_approvals: description: >- Per-group approval tally for multi-quorum tasks. Each entry lists a group's ID and the IIBANs of members in that group who have approved so far. type: array items: type: object properties: group_id: description: >- Subquorum group identifier (UUID v4) matching an entry in `subquorum_snapshot.groups`. type: string example: 1ef8cecf-5d7b-4f83-9640-96d74db0e858 approved_iibans: description: IIBANs of group members who have approved the task. type: array items: type: string example: ABCD EFGH IJKL MNOP required: - group_id - approved_iibans required: - id - type - type_label - state - created_at - updated_at - expires_at - initiator - quorum_type - can_review - current_user_decision - activities - reviewer_statistics_label '400': description: >- Bad Request. The request failed validation. Examples: unknown filter value, malformed ID, or invalid date range. 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: Request failed validation. 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 example: Request failed validation. required: - message required: - data - status - title - type '403': description: >- Forbidden. The caller lacks access to the requested task, vault, or organization scope. 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: Forbidden detail: nullable: true description: Help to solve the problem type: string example: Caller lacks access to the requested resource. 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 example: Caller lacks access to the requested resource. 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 servicing the request. 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. 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 ````