> ## Documentation Index > Fetch the complete documentation index at: https://kraken-sandbox.mintlify.site/llms.txt > Use this file to discover all available pages before exploring further. # List activities > Retrieve all activities that match the specified filter criteria. ## OpenAPI ````yaml /openapi/custody-rest.yaml post /0/private/ListCustodyActivities openapi: 3.0.0 info: title: REST API version: 1.1.0 description: '' servers: - url: https://api.kraken.com description: Production Server security: - API-Key: [] API-Sign: [] tags: - name: Portfolios - name: Transfers - name: Tasks paths: /0/private/ListCustodyActivities: post: tags: - Tasks summary: List activities description: Retrieve all activities that match the specified filter criteria. operationId: listCustodyTasksActivities requestBody: $ref: '#/components/requestBodies/listCustodyTasksActivities' responses: '200': content: application/json: schema: $ref: '#/components/schemas/listCustodyTasksActivities' description: '' components: requestBodies: listCustodyTasksActivities: content: application/json: schema: type: object properties: nonce: $ref: '#/components/schemas/nonce' filters: example: and: [] description: >- Specify a subset of filter items. All filter objects are `AND` combined. Inside a filter object all properties are `OR` combined. default: and: [] oneOf: - description: All elements are combined with `AND`. title: and type: object properties: and: type: array items: description: Filtering expressions with or expressions oneOf: - description: All elements are combined with `OR`. title: or type: object properties: or: type: array items: oneOf: - title: id description: Filter by id oneOf: - title: equals description: Field must match the filter exactly. type: object properties: type: type: string enum: - equals values: description: Exact values to match against type: array items: description: ActivityId type: string pattern: ^A[A-Z2-7]{12}[ACEGIKMOQSUWY246]$ minLength: 14 maxLength: 14 by: type: string enum: - id required: - by - type - values - title: scope description: Filter by scope oneOf: - title: equals description: Field must match the filter exactly. type: object properties: type: type: string enum: - equals values: description: Exact values to match against type: array items: oneOf: - title: domain type: string enum: - domain - title: vault type: string enum: - vault by: type: string enum: - scope required: - by - type - values - title: vault_id description: Filter by vault_id oneOf: - title: equals description: Field must match the filter exactly. type: object properties: type: type: string enum: - equals values: description: Exact values to match against type: array items: description: VaultId type: string pattern: ^V[A-Z2-7]{12}[ACEGIKMOQSUWY246]$ minLength: 14 maxLength: 14 by: type: string enum: - vault_id required: - by - type - values - title: task_id description: Filter by task_id oneOf: - title: equals description: Field must match the filter exactly. type: object properties: type: type: string enum: - equals values: description: Exact values to match against type: array items: description: TaskId type: string pattern: ^T[A-Z2-7]{12}[ACEGIKMOQSUWY246]$ minLength: 14 maxLength: 14 by: type: string enum: - task_id required: - by - type - values - title: approval_id description: Filter by approval_id oneOf: - title: equals description: Field must match the filter exactly. type: object properties: type: type: string enum: - equals values: description: Exact values to match against type: array items: type: string by: type: string enum: - approval_id required: - by - type - values - title: task_action description: Filter by task_action oneOf: - title: equals description: Field must match the filter exactly. type: object properties: type: type: string enum: - equals values: description: Exact values to match against type: array items: description: Task action oneOf: - title: update_withdrawal_addresses type: string enum: - update_withdrawal_addresses - title: request_withdrawal description: Request a withdrawal from a vault type: string enum: - request_withdrawal - title: create_vault description: Create a new vault type: string enum: - create_vault - title: update_group_users description: Add/remove users to groups type: string enum: - update_group_users - title: update_role_users description: Add/remove users to roles type: string enum: - update_role_users - title: update_vault_users description: Add/remove users to a vault type: string enum: - update_vault_users - title: update_domain_policies description: Update specific domain policies type: string enum: - update_domain_policies - title: update_vault_policies description: Update a vault's specific policies type: string enum: - update_vault_policies - title: create_users description: >- Invite new users to the custody organization type: string enum: - create_users - title: update_vault description: >- Update vault meta information like its name type: string enum: - update_vault - title: update_status_users description: >- Enable/disable users in a custody organization type: string enum: - update_status_users - title: request_transfer_to_spot description: >- Request a transfer from a vault to a spot account type: string enum: - request_transfer_to_spot - title: create_group description: Create a new group type: string enum: - create_group - title: update_permission_users description: Update user permissions type: string enum: - update_permission_users - title: create_api_users description: Create new API key users type: string enum: - create_api_users - title: update_api_users description: Update existing API key users type: string enum: - update_api_users - title: update_vaults_users description: Add/remove users to vaults type: string enum: - update_vaults_users - title: request_allocation description: Request staking allocation type: string enum: - request_allocation - title: request_deallocation description: Request staking deallocation type: string enum: - request_deallocation by: type: string enum: - task_action required: - by - type - values - title: activity_action description: Filter by activity_action oneOf: - title: equals description: Field must match the filter exactly. type: object properties: type: type: string enum: - equals values: description: Exact values to match against type: array items: oneOf: - title: created description: >- Event that is emitted once the initiator has submitted the request type: string enum: - created - title: review_approved description: >- Event that is emitted when a user reviewed and approved the request type: string enum: - review_approved - title: review_denied description: >- Event that is emitted when a user reviewed and denied the request type: string enum: - review_denied - title: canceled description: >- Event that is emitted when a user cancelled the request type: string enum: - canceled - title: executed description: >- Event that is emitted when the request has been successfully executed type: string enum: - executed - title: failed description: >- Event that is emitted when the request has failed during execution type: string enum: - failed - title: expired description: >- Event that is emitted when the request has expired and was cancelled. type: string enum: - expired by: type: string enum: - activity_action required: - by - type - values - title: created_at description: Filter by created_at oneOf: - title: equals description: Field must match the filter exactly. type: object properties: type: type: string enum: - equals values: type: array items: title: UnixTimestamp description: Unix timestamp in seconds type: string maxLength: 13 by: type: string enum: - created_at required: - by - type - values - title: in description: >- A range uses closed intervals `[left, right]` with `left <= column <= right`. Not providing a `left` will result a left-unbounded intervals `(−∞, right]` and respectively not providing `right` will result in a right-unbounded interval `[left, ∞)`. type: object properties: type: type: string enum: - in left: nullable: true title: UnixTimestamp description: Unix timestamp in seconds type: string maxLength: 13 right: nullable: true title: UnixTimestamp description: Unix timestamp in seconds type: string maxLength: 13 by: type: string enum: - created_at required: - by - type - title: user description: Filter by user oneOf: - title: equals description: Field must match the filter exactly. type: object properties: type: type: string enum: - equals values: description: Exact values to match against type: array items: description: IBAN type: string minLength: 14 maxLength: 42 by: type: string enum: - user required: - by - type - values required: - or required: - and pagination: description: Define which items will get returned default: limit: 100 offset: 0 type: object properties: limit: description: Number of records to retrieve type: integer format: uint32 minimum: 1 maximum: 1000 offset: description: Result Offset type: integer format: uint32 minimum: 0 required: - limit - offset orderings: example: - by: activity_created_at direction: desc description: >- Specify how to order the returned items. If a column in the `orderings` list contains `null` values, these are always sorted to the end. default: - by: activity_created_at direction: desc type: array items: description: Result ordering type: object properties: by: description: |- Column to order by - `activity_created_at`: Order by event creation date enum: - activity_created_at direction: $ref: '#/components/schemas/orderDirection' required: - by required: - nonce required: true schemas: listCustodyTasksActivities: type: object properties: result: nullable: true example: - task: id: TDO2CDW6GMSZHC approval_id: 550e8400-e29b-41d4-a716-446655440000 type: update_vault state: pending vault_info: id: VW44KPQC4C62K6 name: My Vault status: created payload: name: Example Vault name description: Example vault description created_at: '1710877421' updated_at: '1710877421' expires_at: '1710877421' initiator: full_name: John Doe role: initiator ip_address: 127.0.0.1 iiban: AA88 N84G AET3 RAOA id: AW44KPQC4C62K6 created_at: '1710877421' type: created comment: My comment user: full_name: John Doe role: initiator ip_address: 127.0.0.1 iiban: AA88 N84G AET3 RAOA type: array items: description: An activity represents an event on a task. properties: task: description: Task information properties: id: example: TN2F7NJJWKJHI2 description: Task ID type: string pattern: ^T[A-Z2-7]{12}[ACEGIKMOQSUWY246]$ minLength: 14 maxLength: 14 approval_id: description: Approval ID type: string created_at: title: UnixTimestamp description: Creation time type: string maxLength: 13 updated_at: title: UnixTimestamp description: Update time type: string maxLength: 13 expires_at: title: UnixTimestamp description: Task expiration time type: string maxLength: 13 initiator: description: Task initiator type: object properties: full_name: nullable: true description: User full name type: string role: nullable: true description: User role oneOf: - title: admin description: Admin type: string enum: - admin - title: initiator description: Initiator type: string enum: - initiator - title: reviewer description: Reviewer type: string enum: - reviewer - title: auditor description: Auditor type: string enum: - auditor ip_address: nullable: true description: User IP address type: string iiban: nullable: true description: User IIBAN type: string minLength: 14 maxLength: 42 required: - approval_id - created_at - expires_at - id - initiator - updated_at oneOf: - title: update_group_users description: Add/remove users to groups properties: type: type: string enum: - update_group_users operations: type: array items: oneOf: - title: add type: object properties: type: type: string enum: - add item: description: User operation with extra fields type: object properties: user: description: User to be updated type: object properties: iiban: description: The IIBAN of the user. type: string minLength: 14 maxLength: 42 full_name: nullable: true description: The user full name. type: string email: nullable: true description: The e-mail of the user. type: string pattern: ^.+@\S+\.\S+$ minLength: 1 maxLength: 128 role: description: >- Role that the user holds in the organization. oneOf: - title: admin description: Admin type: string enum: - admin - title: initiator description: Initiator type: string enum: - initiator - title: reviewer description: Reviewer type: string enum: - reviewer - title: auditor description: Auditor type: string enum: - auditor required: - iiban - role reason: nullable: true description: User facing Reason type: string maxLength: 1024 group_id: example: GN2F7NJJWKJHI2 type: string pattern: ^G[A-Z2-7]{12}[ACEGIKMOQSUWY246]$ minLength: 14 maxLength: 14 required: - group_id - user required: - item - type - title: remove type: object properties: type: type: string enum: - remove item: description: User operation with extra fields type: object properties: user: description: User to be updated type: object properties: iiban: description: The IIBAN of the user. type: string minLength: 14 maxLength: 42 full_name: nullable: true description: The user full name. type: string email: nullable: true description: The e-mail of the user. type: string pattern: ^.+@\S+\.\S+$ minLength: 1 maxLength: 128 role: description: >- Role that the user holds in the organization. oneOf: - title: admin description: Admin type: string enum: - admin - title: initiator description: Initiator type: string enum: - initiator - title: reviewer description: Reviewer type: string enum: - reviewer - title: auditor description: Auditor type: string enum: - auditor required: - iiban - role reason: nullable: true description: User facing Reason type: string maxLength: 1024 group_id: example: GN2F7NJJWKJHI2 type: string pattern: ^G[A-Z2-7]{12}[ACEGIKMOQSUWY246]$ minLength: 14 maxLength: 14 required: - group_id - user required: - item - type minItems: 1 maxItems: 50 required: - operations - type oneOf: - title: pending description: >- The task is still waiting for approvals and has not reached a quorum yet type: object properties: state: type: string enum: - pending required: - state - title: approved description: >- The task has reached the quorum, but has not been executed type: object properties: state: type: string enum: - approved required: - state - title: denied description: The task has been rejected and not reached the quorum type: object properties: state: type: string enum: - denied required: - state - title: canceled description: The task was canceled type: object properties: state: type: string enum: - canceled required: - state - title: expired description: The task expired type: object properties: state: type: string enum: - expired required: - state - title: executed description: >- The task has reached the quorum and has been successfully executed type: object properties: state: type: string enum: - executed errors: nullable: true type: array items: oneOf: - title: unknown_internal description: Unknown internal error type: object properties: type: type: string enum: - unknown_internal description: Unknown internal error required: - type - title: group_not_found description: Group not found type: object properties: type: type: string enum: - group_not_found description: Group not found required: - type - title: invalid_role description: Invalid role type: object properties: type: type: string enum: - invalid_role description: Invalid role required: - type - title: invalid_user_iiban description: Invalid user IIBAN type: object properties: type: type: string enum: - invalid_user_iiban description: Invalid user IIBAN required: - type - title: user_not_found description: User not found type: object properties: type: type: string enum: - user_not_found description: User not found required: - type - title: auditor_cannot_be_vault_member description: Auditor cannot be member of a vault type: object properties: type: type: string enum: - auditor_cannot_be_vault_member description: Auditor cannot be member of a vault required: - type - title: quorum_locking_operation description: >- The user cannot be removed because it would lock the minimum quorum type: object properties: type: type: string enum: - quorum_locking_operation description: >- The user cannot be removed because it would lock the minimum quorum required: - type - title: update_group_users_multiple_times description: >- Group user updated multiple times in the bulk operation type: object properties: type: type: string enum: - update_group_users_multiple_times description: >- Group user updated multiple times in the bulk operation required: - type required: - state - title: failed description: >- The task has reached the quorum, but has errored during execution type: object properties: state: type: string enum: - failed errors: type: array items: oneOf: - title: unknown_internal description: Unknown internal error type: object properties: type: type: string enum: - unknown_internal description: Unknown internal error required: - type - title: group_not_found description: Group not found type: object properties: type: type: string enum: - group_not_found description: Group not found required: - type - title: invalid_role description: Invalid role type: object properties: type: type: string enum: - invalid_role description: Invalid role required: - type - title: invalid_user_iiban description: Invalid user IIBAN type: object properties: type: type: string enum: - invalid_user_iiban description: Invalid user IIBAN required: - type - title: user_not_found description: User not found type: object properties: type: type: string enum: - user_not_found description: User not found required: - type - title: auditor_cannot_be_vault_member description: Auditor cannot be member of a vault type: object properties: type: type: string enum: - auditor_cannot_be_vault_member description: Auditor cannot be member of a vault required: - type - title: quorum_locking_operation description: >- The user cannot be removed because it would lock the minimum quorum type: object properties: type: type: string enum: - quorum_locking_operation description: >- The user cannot be removed because it would lock the minimum quorum required: - type - title: update_group_users_multiple_times description: >- Group user updated multiple times in the bulk operation type: object properties: type: type: string enum: - update_group_users_multiple_times description: >- Group user updated multiple times in the bulk operation required: - type required: - errors - state - title: update_role_users description: Add/remove users to roles properties: type: type: string enum: - update_role_users operations: type: array items: oneOf: - title: update description: Update a role type: object properties: type: type: string enum: - update description: Update a role item: type: object properties: user: description: User to be updated type: object properties: iiban: description: The IIBAN of the user. type: string minLength: 14 maxLength: 42 full_name: nullable: true description: The user full name. type: string email: nullable: true description: The e-mail of the user. type: string pattern: ^.+@\S+\.\S+$ minLength: 1 maxLength: 128 role: description: >- Role that the user holds in the organization. oneOf: - title: admin description: Admin type: string enum: - admin - title: initiator description: Initiator type: string enum: - initiator - title: reviewer description: Reviewer type: string enum: - reviewer - title: auditor description: Auditor type: string enum: - auditor required: - iiban - role reason: nullable: true description: User facing Reason type: string maxLength: 1024 role: description: The new role oneOf: - title: admin description: Admin type: string enum: - admin - title: initiator description: Initiator type: string enum: - initiator - title: reviewer description: Reviewer type: string enum: - reviewer - title: auditor description: Auditor type: string enum: - auditor required: - role - user required: - item - type minItems: 1 maxItems: 50 required: - operations - type oneOf: - title: pending description: >- The task is still waiting for approvals and has not reached a quorum yet type: object properties: state: type: string enum: - pending required: - state - title: approved description: >- The task has reached the quorum, but has not been executed type: object properties: state: type: string enum: - approved required: - state - title: denied description: The task has been rejected and not reached the quorum type: object properties: state: type: string enum: - denied required: - state - title: canceled description: The task was canceled type: object properties: state: type: string enum: - canceled required: - state - title: expired description: The task expired type: object properties: state: type: string enum: - expired required: - state - title: executed description: >- The task has reached the quorum and has been successfully executed type: object properties: state: type: string enum: - executed errors: nullable: true type: array items: oneOf: - title: unknown_internal description: Unknown internal error type: object properties: type: type: string enum: - unknown_internal description: Unknown internal error required: - type - title: update_role_users_multiple_times description: >- User role updated multiple times in the bulk operation type: object properties: type: type: string enum: - update_role_users_multiple_times description: >- User role updated multiple times in the bulk operation required: - type - title: user_not_found description: User not found type: object properties: type: type: string enum: - user_not_found description: User not found required: - type - title: invalid_role description: Invalid role type: object properties: type: type: string enum: - invalid_role description: Invalid role required: - type - title: auditor_in_vault description: Auditor cannot be member of a vault type: object properties: type: type: string enum: - auditor_in_vault description: Auditor cannot be member of a vault required: - type - title: quorum_locking_operation description: >- The user cannot be removed because it would lock the minimum quorum type: object properties: type: type: string enum: - quorum_locking_operation description: >- The user cannot be removed because it would lock the minimum quorum required: - type required: - state - title: failed description: >- The task has reached the quorum, but has errored during execution type: object properties: state: type: string enum: - failed errors: type: array items: oneOf: - title: unknown_internal description: Unknown internal error type: object properties: type: type: string enum: - unknown_internal description: Unknown internal error required: - type - title: update_role_users_multiple_times description: >- User role updated multiple times in the bulk operation type: object properties: type: type: string enum: - update_role_users_multiple_times description: >- User role updated multiple times in the bulk operation required: - type - title: user_not_found description: User not found type: object properties: type: type: string enum: - user_not_found description: User not found required: - type - title: invalid_role description: Invalid role type: object properties: type: type: string enum: - invalid_role description: Invalid role required: - type - title: auditor_in_vault description: Auditor cannot be member of a vault type: object properties: type: type: string enum: - auditor_in_vault description: Auditor cannot be member of a vault required: - type - title: quorum_locking_operation description: >- The user cannot be removed because it would lock the minimum quorum type: object properties: type: type: string enum: - quorum_locking_operation description: >- The user cannot be removed because it would lock the minimum quorum required: - type required: - errors - state - title: update_domain_policies description: Update specific domain policies properties: type: type: string enum: - update_domain_policies operations: type: array items: oneOf: - title: update type: object properties: type: type: string enum: - update item: oneOf: - title: required_approvals description: >- Requires a certain number of reviewers for an approval type: object properties: type: type: string enum: - required_approvals description: >- Requires a certain number of reviewers for an approval available: nullable: true description: Number of currently available reviewers type: integer format: uint32 minimum: 0 required: - required - type required: - item - type minItems: 1 maxItems: 50 required: - operations - type oneOf: - title: pending description: >- The task is still waiting for approvals and has not reached a quorum yet type: object properties: state: type: string enum: - pending required: - state - title: approved description: >- The task has reached the quorum, but has not been executed type: object properties: state: type: string enum: - approved required: - state - title: denied description: The task has been rejected and not reached the quorum type: object properties: state: type: string enum: - denied required: - state - title: canceled description: The task was canceled type: object properties: state: type: string enum: - canceled required: - state - title: expired description: The task expired type: object properties: state: type: string enum: - expired required: - state - title: executed description: >- The task has reached the quorum and has been successfully executed type: object properties: state: type: string enum: - executed errors: nullable: true type: array items: oneOf: - title: unknown_internal description: Unknown internal error type: object properties: type: type: string enum: - unknown_internal description: Unknown internal error required: - type - title: invalid_quorum description: Invalid quorum type: object properties: type: type: string enum: - invalid_quorum description: Invalid quorum required: - type - title: domain_policy_not_found description: Domain policy not found type: object properties: type: type: string enum: - domain_policy_not_found description: Domain policy not found required: - type - title: domain_policies_not_specified description: Domain polices not specified in the request type: object properties: type: type: string enum: - domain_policies_not_specified description: >- Domain polices not specified in the request required: - type - title: >- invalid_number_of_domain_policy_update_operations description: Only one domain policy update is allowed type: object properties: type: type: string enum: - >- invalid_number_of_domain_policy_update_operations description: Only one domain policy update is allowed required: - type - title: quorum_locking_operation description: >- The user cannot be removed because it would lock the minimum quorum type: object properties: type: type: string enum: - quorum_locking_operation description: >- The user cannot be removed because it would lock the minimum quorum required: - type required: - state - title: failed description: >- The task has reached the quorum, but has errored during execution type: object properties: state: type: string enum: - failed errors: type: array items: oneOf: - title: unknown_internal description: Unknown internal error type: object properties: type: type: string enum: - unknown_internal description: Unknown internal error required: - type - title: invalid_quorum description: Invalid quorum type: object properties: type: type: string enum: - invalid_quorum description: Invalid quorum required: - type - title: domain_policy_not_found description: Domain policy not found type: object properties: type: type: string enum: - domain_policy_not_found description: Domain policy not found required: - type - title: domain_policies_not_specified description: Domain polices not specified in the request type: object properties: type: type: string enum: - domain_policies_not_specified description: >- Domain polices not specified in the request required: - type - title: >- invalid_number_of_domain_policy_update_operations description: Only one domain policy update is allowed type: object properties: type: type: string enum: - >- invalid_number_of_domain_policy_update_operations description: Only one domain policy update is allowed required: - type - title: quorum_locking_operation description: >- The user cannot be removed because it would lock the minimum quorum type: object properties: type: type: string enum: - quorum_locking_operation description: >- The user cannot be removed because it would lock the minimum quorum required: - type required: - errors - state - title: create_users description: Invite new users to the custody organization properties: type: type: string enum: - create_users operations: type: array items: oneOf: - title: add description: Invite a user type: object properties: type: type: string enum: - add description: Invite a user item: type: object properties: attributes: nullable: true type: array items: oneOf: - title: otc_trader description: OtcTrader type: string enum: - otc_trader - title: staker description: Staker type: string enum: - staker minItems: 0 maxItems: 50 email: description: The email address type: string pattern: ^.+@\S+\.\S+$ minLength: 1 maxLength: 128 role: oneOf: - title: admin description: Admin type: string enum: - admin - title: initiator description: Initiator type: string enum: - initiator - title: reviewer description: Reviewer type: string enum: - reviewer - title: auditor description: Auditor type: string enum: - auditor full_name: type: object properties: first_name: description: First name type: string minLength: 1 maxLength: 128 middle_name: nullable: true description: Optional middle name type: string minLength: 1 maxLength: 128 last_name: description: Last name type: string minLength: 1 maxLength: 128 required: - first_name - last_name language: nullable: true type: string timezone: nullable: true type: string required: - email - full_name - role required: - item - type minItems: 1 maxItems: 50 required: - operations - type oneOf: - title: pending description: >- The task is still waiting for approvals and has not reached a quorum yet type: object properties: state: type: string enum: - pending required: - state - title: approved description: >- The task has reached the quorum, but has not been executed type: object properties: state: type: string enum: - approved required: - state - title: denied description: The task has been rejected and not reached the quorum type: object properties: state: type: string enum: - denied required: - state - title: canceled description: The task was canceled type: object properties: state: type: string enum: - canceled required: - state - title: expired description: The task expired type: object properties: state: type: string enum: - expired required: - state - title: executed description: >- The task has reached the quorum and has been successfully executed type: object properties: state: type: string enum: - executed result: nullable: true type: object properties: users: description: Created users type: array items: type: object properties: iiban: description: IBAN type: string minLength: 14 maxLength: 42 email: description: The email address type: string pattern: ^.+@\S+\.\S+$ minLength: 1 maxLength: 128 role: oneOf: - title: admin description: Admin type: string enum: - admin - title: initiator description: Initiator type: string enum: - initiator - title: reviewer description: Reviewer type: string enum: - reviewer - title: auditor description: Auditor type: string enum: - auditor attributes: default: [] type: array items: oneOf: - title: otc_trader description: OtcTrader type: string enum: - otc_trader - title: staker description: Staker type: string enum: - staker required: - email - iiban - role required: - users errors: nullable: true type: array items: oneOf: - title: unknown_internal description: Unknown internal error type: object properties: type: type: string enum: - unknown_internal description: Unknown internal error required: - type - title: role_not_found description: Role not found type: object properties: type: type: string enum: - role_not_found description: Role not found required: - type - title: duplicate_email_in_request description: Duplicate email type: object properties: type: type: string enum: - duplicate_email_in_request description: Duplicate email required: - type - title: empty_full_name description: Empty full name type: object properties: type: type: string enum: - empty_full_name description: Empty full name required: - type - title: max_length_full_name description: Max length full name type: object properties: type: type: string enum: - max_length_full_name description: Max length full name required: - type - title: missing_domain_info description: Missing domain info type: object properties: type: type: string enum: - missing_domain_info description: Missing domain info required: - type - title: invalid_user_email description: Invalid user email type: object properties: type: type: string enum: - invalid_user_email description: Invalid user email required: - type - title: organization_not_found description: Organization not found type: object properties: type: type: string enum: - organization_not_found description: Organization not found required: - type - title: master_not_found description: Master not found type: object properties: type: type: string enum: - master_not_found description: Master not found required: - type - title: domain_disabled description: Domain disabled type: object properties: type: type: string enum: - domain_disabled description: Domain disabled required: - type - title: master_account_is_not_configured description: Master account is not configured type: object properties: type: type: string enum: - master_account_is_not_configured description: Master account is not configured required: - type - title: master_account_does_not_have_a_full_name description: Master account does not have a full name type: object properties: type: type: string enum: - master_account_does_not_have_a_full_name description: Master account does not have a full name required: - type - title: missing_country description: Country not specified type: object properties: type: type: string enum: - missing_country description: Country not specified required: - type - title: domain_not_found description: Invalid domain type: object properties: type: type: string enum: - domain_not_found description: Invalid domain required: - type - title: invalid_arguments description: Invalid arguments type: object properties: type: type: string enum: - invalid_arguments description: Invalid arguments required: - type - title: org_limit_custody_users_exceeded description: >- Limit of custody accounts has been reached for the current organization type: object properties: type: type: string enum: - org_limit_custody_users_exceeded description: >- Limit of custody accounts has been reached for the current organization required: - type - title: org_limit_custody_vaults_exceeded description: >- Limit of custody vaults has been reached for the current organization type: object properties: type: type: string enum: - org_limit_custody_vaults_exceeded description: >- Limit of custody vaults has been reached for the current organization required: - type required: - state - title: failed description: >- The task has reached the quorum, but has errored during execution type: object properties: state: type: string enum: - failed errors: type: array items: oneOf: - title: unknown_internal description: Unknown internal error type: object properties: type: type: string enum: - unknown_internal description: Unknown internal error required: - type - title: role_not_found description: Role not found type: object properties: type: type: string enum: - role_not_found description: Role not found required: - type - title: duplicate_email_in_request description: Duplicate email type: object properties: type: type: string enum: - duplicate_email_in_request description: Duplicate email required: - type - title: empty_full_name description: Empty full name type: object properties: type: type: string enum: - empty_full_name description: Empty full name required: - type - title: max_length_full_name description: Max length full name type: object properties: type: type: string enum: - max_length_full_name description: Max length full name required: - type - title: missing_domain_info description: Missing domain info type: object properties: type: type: string enum: - missing_domain_info description: Missing domain info required: - type - title: invalid_user_email description: Invalid user email type: object properties: type: type: string enum: - invalid_user_email description: Invalid user email required: - type - title: organization_not_found description: Organization not found type: object properties: type: type: string enum: - organization_not_found description: Organization not found required: - type - title: master_not_found description: Master not found type: object properties: type: type: string enum: - master_not_found description: Master not found required: - type - title: domain_disabled description: Domain disabled type: object properties: type: type: string enum: - domain_disabled description: Domain disabled required: - type - title: master_account_is_not_configured description: Master account is not configured type: object properties: type: type: string enum: - master_account_is_not_configured description: Master account is not configured required: - type - title: master_account_does_not_have_a_full_name description: Master account does not have a full name type: object properties: type: type: string enum: - master_account_does_not_have_a_full_name description: Master account does not have a full name required: - type - title: missing_country description: Country not specified type: object properties: type: type: string enum: - missing_country description: Country not specified required: - type - title: domain_not_found description: Invalid domain type: object properties: type: type: string enum: - domain_not_found description: Invalid domain required: - type - title: invalid_arguments description: Invalid arguments type: object properties: type: type: string enum: - invalid_arguments description: Invalid arguments required: - type - title: org_limit_custody_users_exceeded description: >- Limit of custody accounts has been reached for the current organization type: object properties: type: type: string enum: - org_limit_custody_users_exceeded description: >- Limit of custody accounts has been reached for the current organization required: - type - title: org_limit_custody_vaults_exceeded description: >- Limit of custody vaults has been reached for the current organization type: object properties: type: type: string enum: - org_limit_custody_vaults_exceeded description: >- Limit of custody vaults has been reached for the current organization required: - type required: - errors - state - title: update_status_users description: Enable/disable users in a custody organization properties: type: type: string enum: - update_status_users operations: type: array items: oneOf: - title: add type: object properties: type: type: string enum: - add item: description: User operation without any extra fields type: object properties: user: description: User to be updated type: object properties: iiban: description: The IIBAN of the user. type: string minLength: 14 maxLength: 42 full_name: nullable: true description: The user full name. type: string email: nullable: true description: The e-mail of the user. type: string pattern: ^.+@\S+\.\S+$ minLength: 1 maxLength: 128 role: description: >- Role that the user holds in the organization. oneOf: - title: admin description: Admin type: string enum: - admin - title: initiator description: Initiator type: string enum: - initiator - title: reviewer description: Reviewer type: string enum: - reviewer - title: auditor description: Auditor type: string enum: - auditor required: - iiban - role reason: nullable: true description: User facing Reason type: string maxLength: 1024 required: - user required: - item - type - title: remove type: object properties: type: type: string enum: - remove item: description: User operation without any extra fields type: object properties: user: description: User to be updated type: object properties: iiban: description: The IIBAN of the user. type: string minLength: 14 maxLength: 42 full_name: nullable: true description: The user full name. type: string email: nullable: true description: The e-mail of the user. type: string pattern: ^.+@\S+\.\S+$ minLength: 1 maxLength: 128 role: description: >- Role that the user holds in the organization. oneOf: - title: admin description: Admin type: string enum: - admin - title: initiator description: Initiator type: string enum: - initiator - title: reviewer description: Reviewer type: string enum: - reviewer - title: auditor description: Auditor type: string enum: - auditor required: - iiban - role reason: nullable: true description: User facing Reason type: string maxLength: 1024 required: - user required: - item - type minItems: 1 maxItems: 50 required: - operations - type oneOf: - title: pending description: >- The task is still waiting for approvals and has not reached a quorum yet type: object properties: state: type: string enum: - pending required: - state - title: approved description: >- The task has reached the quorum, but has not been executed type: object properties: state: type: string enum: - approved required: - state - title: denied description: The task has been rejected and not reached the quorum type: object properties: state: type: string enum: - denied required: - state - title: canceled description: The task was canceled type: object properties: state: type: string enum: - canceled required: - state - title: expired description: The task expired type: object properties: state: type: string enum: - expired required: - state - title: executed description: >- The task has reached the quorum and has been successfully executed type: object properties: state: type: string enum: - executed errors: nullable: true type: array items: oneOf: - title: unknown_internal description: Unknown internal error type: object properties: type: type: string enum: - unknown_internal description: Unknown internal error required: - type - title: user_is_a_vault_member description: >- User cannot be disabled because is a vault member type: object properties: type: type: string enum: - user_is_a_vault_member description: >- User cannot be disabled because is a vault member required: - type - title: user_is_a_group_member description: >- User cannot be disabled because is a group member type: object properties: type: type: string enum: - user_is_a_group_member description: >- User cannot be disabled because is a group member required: - type - title: update_status_users_multiple_times description: >- User status updated multiple times in the bulk operation type: object properties: type: type: string enum: - update_status_users_multiple_times description: >- User status updated multiple times in the bulk operation required: - type - title: user_not_found description: User not found type: object properties: type: type: string enum: - user_not_found description: User not found required: - type - title: user_already_has_status description: User already has the status type: object properties: type: type: string enum: - user_already_has_status description: User already has the status required: - type - title: quorum_locking_operation description: >- The user cannot be removed because it would lock the minimum quorum type: object properties: type: type: string enum: - quorum_locking_operation description: >- The user cannot be removed because it would lock the minimum quorum required: - type required: - state - title: failed description: >- The task has reached the quorum, but has errored during execution type: object properties: state: type: string enum: - failed errors: type: array items: oneOf: - title: unknown_internal description: Unknown internal error type: object properties: type: type: string enum: - unknown_internal description: Unknown internal error required: - type - title: user_is_a_vault_member description: >- User cannot be disabled because is a vault member type: object properties: type: type: string enum: - user_is_a_vault_member description: >- User cannot be disabled because is a vault member required: - type - title: user_is_a_group_member description: >- User cannot be disabled because is a group member type: object properties: type: type: string enum: - user_is_a_group_member description: >- User cannot be disabled because is a group member required: - type - title: update_status_users_multiple_times description: >- User status updated multiple times in the bulk operation type: object properties: type: type: string enum: - update_status_users_multiple_times description: >- User status updated multiple times in the bulk operation required: - type - title: user_not_found description: User not found type: object properties: type: type: string enum: - user_not_found description: User not found required: - type - title: user_already_has_status description: User already has the status type: object properties: type: type: string enum: - user_already_has_status description: User already has the status required: - type - title: quorum_locking_operation description: >- The user cannot be removed because it would lock the minimum quorum type: object properties: type: type: string enum: - quorum_locking_operation description: >- The user cannot be removed because it would lock the minimum quorum required: - type required: - errors - state - title: update_withdrawal_addresses description: Add/remove withdrawal addresses to vaults properties: type: type: string enum: - update_withdrawal_addresses vault_info: description: Vault information type: object properties: id: example: VN2F7NJJWKJHI2 description: Vault ID type: string pattern: ^V[A-Z2-7]{12}[ACEGIKMOQSUWY246]$ minLength: 14 maxLength: 14 name: description: Vault name type: string pattern: ^[a-zA-Z0-9\s\/-]+$ minLength: 1 maxLength: 32 status: description: Vault status oneOf: - title: pending description: The HSM vault is still initializing type: string enum: - pending - title: created description: The HSM vault has been created type: string enum: - created - title: failed description: The HSM vault creation has failed type: string enum: - failed - title: disabled description: The underlying account has been disabled type: string enum: - disabled required: - id - name - status operations: type: array items: oneOf: - title: add type: object properties: type: type: string enum: - add item: type: object properties: asset: description: >- The name of the asset that the address identifies type: string minLength: 1 maxLength: 16 address_name: description: Name of the address type: string minLength: 2 maxLength: 100 method: description: >- The withdrawal method allowed for this address type: string info: description: >- Additional info associated with the withdrawal address. Some fields will only be available for certain withdrawal methods. type: object properties: address: nullable: true type: string beneficiary: nullable: true type: object properties: recipient: description: Recipient type: string minLength: 2 maxLength: 100 type: nullable: true description: Type type: string name: nullable: true description: Name type: string minLength: 2 maxLength: 100 last_name: nullable: true description: Last name type: string country: nullable: true description: Country type: string minLength: 2 maxLength: 100 province: nullable: true description: Province type: string minLength: 2 maxLength: 100 address_1: nullable: true description: Address line 1 type: string maxLength: 100 address_2: nullable: true description: Address line 2 type: string maxLength: 100 city: nullable: true description: City type: string minLength: 2 maxLength: 100 postal_code: nullable: true description: Postal Code type: string minLength: 2 maxLength: 100 vasp_name: nullable: true description: VASP name type: string minLength: 2 maxLength: 100 required: - recipient description: nullable: true description: Optional description type: string maxLength: 1024 required: - address_name - asset - info - method required: - item - type - title: remove type: object properties: type: type: string enum: - remove item: type: object properties: reason: nullable: true description: Optional reason for the address removal type: string maxLength: 1024 asset: description: >- The name of the asset that the address identifies type: string minLength: 1 maxLength: 16 address_name: description: Name of the address type: string minLength: 2 maxLength: 100 method: description: >- The withdrawal method allowed for this address type: string info: description: >- Additional info associated with the withdrawal address. Some fields will only be available for certain withdrawal methods. type: object properties: address: nullable: true type: string beneficiary: nullable: true type: object properties: recipient: description: Recipient type: string minLength: 2 maxLength: 100 type: nullable: true description: Type type: string name: nullable: true description: Name type: string minLength: 2 maxLength: 100 last_name: nullable: true description: Last name type: string country: nullable: true description: Country type: string minLength: 2 maxLength: 100 province: nullable: true description: Province type: string minLength: 2 maxLength: 100 address_1: nullable: true description: Address line 1 type: string maxLength: 100 address_2: nullable: true description: Address line 2 type: string maxLength: 100 city: nullable: true description: City type: string minLength: 2 maxLength: 100 postal_code: nullable: true description: Postal Code type: string minLength: 2 maxLength: 100 vasp_name: nullable: true description: VASP name type: string minLength: 2 maxLength: 100 required: - recipient description: nullable: true description: Optional description type: string maxLength: 1024 required: - address_name - asset - info - method required: - item - type minItems: 1 maxItems: 50 required: - operations - type - vault_info oneOf: - title: pending description: >- The task is still waiting for approvals and has not reached a quorum yet type: object properties: state: type: string enum: - pending required: - state - title: approved description: >- The task has reached the quorum, but has not been executed type: object properties: state: type: string enum: - approved required: - state - title: denied description: The task has been rejected and not reached the quorum type: object properties: state: type: string enum: - denied required: - state - title: canceled description: The task was canceled type: object properties: state: type: string enum: - canceled required: - state - title: expired description: The task expired type: object properties: state: type: string enum: - expired required: - state - title: executed description: >- The task has reached the quorum and has been successfully executed type: object properties: state: type: string enum: - executed errors: nullable: true type: array items: oneOf: - title: unknown_internal description: Unknown internal error type: object properties: type: type: string enum: - unknown_internal description: Unknown internal error required: - type - title: invalid_vault_id description: Invalid vault id type: object properties: type: type: string enum: - invalid_vault_id description: Invalid vault id required: - type - title: vault_not_found description: Vault not found type: object properties: type: type: string enum: - vault_not_found description: Vault not found required: - type - title: permission_denied description: Permission denied type: object properties: type: type: string enum: - permission_denied description: Permission denied required: - type required: - state - title: failed description: >- The task has reached the quorum, but has errored during execution type: object properties: state: type: string enum: - failed errors: type: array items: oneOf: - title: unknown_internal description: Unknown internal error type: object properties: type: type: string enum: - unknown_internal description: Unknown internal error required: - type - title: invalid_vault_id description: Invalid vault id type: object properties: type: type: string enum: - invalid_vault_id description: Invalid vault id required: - type - title: vault_not_found description: Vault not found type: object properties: type: type: string enum: - vault_not_found description: Vault not found required: - type - title: permission_denied description: Permission denied type: object properties: type: type: string enum: - permission_denied description: Permission denied required: - type required: - errors - state - title: update_vault_users description: Add/remove users to a vault properties: type: type: string enum: - update_vault_users vault_info: description: Vault information type: object properties: id: example: VN2F7NJJWKJHI2 description: Vault ID type: string pattern: ^V[A-Z2-7]{12}[ACEGIKMOQSUWY246]$ minLength: 14 maxLength: 14 name: description: Vault name type: string pattern: ^[a-zA-Z0-9\s\/-]+$ minLength: 1 maxLength: 32 status: description: Vault status oneOf: - title: pending description: The HSM vault is still initializing type: string enum: - pending - title: created description: The HSM vault has been created type: string enum: - created - title: failed description: The HSM vault creation has failed type: string enum: - failed - title: disabled description: The underlying account has been disabled type: string enum: - disabled required: - id - name - status operations: type: array items: oneOf: - title: add type: object properties: type: type: string enum: - add item: description: User operation without any extra fields type: object properties: user: description: User to be updated type: object properties: iiban: description: The IIBAN of the user. type: string minLength: 14 maxLength: 42 full_name: nullable: true description: The user full name. type: string email: nullable: true description: The e-mail of the user. type: string pattern: ^.+@\S+\.\S+$ minLength: 1 maxLength: 128 role: description: >- Role that the user holds in the organization. oneOf: - title: admin description: Admin type: string enum: - admin - title: initiator description: Initiator type: string enum: - initiator - title: reviewer description: Reviewer type: string enum: - reviewer - title: auditor description: Auditor type: string enum: - auditor required: - iiban - role reason: nullable: true description: User facing Reason type: string maxLength: 1024 required: - user required: - item - type - title: remove type: object properties: type: type: string enum: - remove item: description: User operation without any extra fields type: object properties: user: description: User to be updated type: object properties: iiban: description: The IIBAN of the user. type: string minLength: 14 maxLength: 42 full_name: nullable: true description: The user full name. type: string email: nullable: true description: The e-mail of the user. type: string pattern: ^.+@\S+\.\S+$ minLength: 1 maxLength: 128 role: description: >- Role that the user holds in the organization. oneOf: - title: admin description: Admin type: string enum: - admin - title: initiator description: Initiator type: string enum: - initiator - title: reviewer description: Reviewer type: string enum: - reviewer - title: auditor description: Auditor type: string enum: - auditor required: - iiban - role reason: nullable: true description: User facing Reason type: string maxLength: 1024 required: - user required: - item - type minItems: 1 maxItems: 50 required: - operations - type - vault_info oneOf: - title: pending description: >- The task is still waiting for approvals and has not reached a quorum yet type: object properties: state: type: string enum: - pending required: - state - title: approved description: >- The task has reached the quorum, but has not been executed type: object properties: state: type: string enum: - approved required: - state - title: denied description: The task has been rejected and not reached the quorum type: object properties: state: type: string enum: - denied required: - state - title: canceled description: The task was canceled type: object properties: state: type: string enum: - canceled required: - state - title: expired description: The task expired type: object properties: state: type: string enum: - expired required: - state - title: executed description: >- The task has reached the quorum and has been successfully executed type: object properties: state: type: string enum: - executed errors: nullable: true type: array items: oneOf: - title: unknown_internal description: Unknown internal error type: object properties: type: type: string enum: - unknown_internal description: Unknown internal error required: - type - title: vault_not_found description: Vault not found type: object properties: type: type: string enum: - vault_not_found description: Vault not found required: - type - title: invalid_vault_id description: Invalid vault id type: object properties: type: type: string enum: - invalid_vault_id description: Invalid vault id required: - type - title: group_not_found description: Group not found type: object properties: type: type: string enum: - group_not_found description: Group not found required: - type - title: user_not_found description: User not found type: object properties: type: type: string enum: - user_not_found description: User not found required: - type - title: invalid_role description: Invalid role type: object properties: type: type: string enum: - invalid_role description: Invalid role required: - type - title: users_from_different_domains description: >- The requested operations contains users from different domains type: object properties: type: type: string enum: - users_from_different_domains description: >- The requested operations contains users from different domains required: - type - title: auditor_in_vault description: Auditor cannot be member of a vault type: object properties: type: type: string enum: - auditor_in_vault description: Auditor cannot be member of a vault required: - type - title: update_vault_users_multiple_times description: >- Vault user updated multiple times in the bulk operation type: object properties: type: type: string enum: - update_vault_users_multiple_times description: >- Vault user updated multiple times in the bulk operation required: - type - title: permission_denied description: Permission denied type: object properties: type: type: string enum: - permission_denied description: Permission denied required: - type required: - state - title: failed description: >- The task has reached the quorum, but has errored during execution type: object properties: state: type: string enum: - failed errors: type: array items: oneOf: - title: unknown_internal description: Unknown internal error type: object properties: type: type: string enum: - unknown_internal description: Unknown internal error required: - type - title: vault_not_found description: Vault not found type: object properties: type: type: string enum: - vault_not_found description: Vault not found required: - type - title: invalid_vault_id description: Invalid vault id type: object properties: type: type: string enum: - invalid_vault_id description: Invalid vault id required: - type - title: group_not_found description: Group not found type: object properties: type: type: string enum: - group_not_found description: Group not found required: - type - title: user_not_found description: User not found type: object properties: type: type: string enum: - user_not_found description: User not found required: - type - title: invalid_role description: Invalid role type: object properties: type: type: string enum: - invalid_role description: Invalid role required: - type - title: users_from_different_domains description: >- The requested operations contains users from different domains type: object properties: type: type: string enum: - users_from_different_domains description: >- The requested operations contains users from different domains required: - type - title: auditor_in_vault description: Auditor cannot be member of a vault type: object properties: type: type: string enum: - auditor_in_vault description: Auditor cannot be member of a vault required: - type - title: update_vault_users_multiple_times description: >- Vault user updated multiple times in the bulk operation type: object properties: type: type: string enum: - update_vault_users_multiple_times description: >- Vault user updated multiple times in the bulk operation required: - type - title: permission_denied description: Permission denied type: object properties: type: type: string enum: - permission_denied description: Permission denied required: - type required: - errors - state - title: update_vault_policies description: Update a vault's specific policies properties: type: type: string enum: - update_vault_policies vault_info: description: Vault information type: object properties: id: example: VN2F7NJJWKJHI2 description: Vault ID type: string pattern: ^V[A-Z2-7]{12}[ACEGIKMOQSUWY246]$ minLength: 14 maxLength: 14 name: description: Vault name type: string pattern: ^[a-zA-Z0-9\s\/-]+$ minLength: 1 maxLength: 32 status: description: Vault status oneOf: - title: pending description: The HSM vault is still initializing type: string enum: - pending - title: created description: The HSM vault has been created type: string enum: - created - title: failed description: The HSM vault creation has failed type: string enum: - failed - title: disabled description: The underlying account has been disabled type: string enum: - disabled required: - id - name - status operations: type: array items: oneOf: - title: update type: object properties: type: type: string enum: - update item: oneOf: - title: max_transaction_amount description: >- Limits the maximum transaction amount for a transaction type: object properties: type: type: string enum: - max_transaction_amount description: >- Limits the maximum transaction amount for a transaction amount: example: '1.23' description: Maximum transaction amount type: string pattern: ^-?[0-9]+(\.[0-9]+)?$ minLength: 1 maxLength: 64 required: - amount - type - title: required_approvals description: >- Requires a certain number of reviewers for an approval type: object properties: type: type: string enum: - required_approvals description: >- Requires a certain number of reviewers for an approval available: nullable: true description: Number of currently available reviewers type: integer format: uint32 minimum: 0 required: - required - type - title: otc_max_transaction_amount description: >- Limits the maximum amount for an OTC transaction type: object properties: type: type: string enum: - otc_max_transaction_amount description: >- Limits the maximum amount for an OTC transaction amount: example: '1.23' description: Maximum transaction amount type: string pattern: ^-?[0-9]+(\.[0-9]+)?$ minLength: 1 maxLength: 64 required: - amount - type - title: otc_enabled description: >- Enable/disable the vault OTC capabilities type: object properties: type: type: string enum: - otc_enabled description: >- Enable/disable the vault OTC capabilities enable: type: boolean required: - enable - type - title: staking_enabled description: >- Enable/disable the vault staking capabilities type: object properties: type: type: string enum: - staking_enabled description: >- Enable/disable the vault staking capabilities enable: type: boolean required: - enable - type - title: staking_max_transaction_amount description: >- Limits the maximum amount for a staking transaction type: object properties: type: type: string enum: - staking_max_transaction_amount description: >- Limits the maximum amount for a staking transaction amount: example: '1.23' description: Maximum transaction amount type: string pattern: ^-?[0-9]+(\.[0-9]+)?$ minLength: 1 maxLength: 64 required: - amount - type required: - item - type minItems: 1 maxItems: 50 required: - operations - type - vault_info oneOf: - title: pending description: >- The task is still waiting for approvals and has not reached a quorum yet type: object properties: state: type: string enum: - pending required: - state - title: approved description: >- The task has reached the quorum, but has not been executed type: object properties: state: type: string enum: - approved required: - state - title: denied description: The task has been rejected and not reached the quorum type: object properties: state: type: string enum: - denied required: - state - title: canceled description: The task was canceled type: object properties: state: type: string enum: - canceled required: - state - title: expired description: The task expired type: object properties: state: type: string enum: - expired required: - state - title: executed description: >- The task has reached the quorum and has been successfully executed type: object properties: state: type: string enum: - executed errors: nullable: true type: array items: oneOf: - title: unknown_internal description: Unknown internal error type: object properties: type: type: string enum: - unknown_internal description: Unknown internal error required: - type - title: invalid_quorum description: Invalid quorum type: object properties: type: type: string enum: - invalid_quorum description: Invalid quorum required: - type - title: max_withdrawal_amount description: Invalid maximum withdrawal amount type: object properties: type: type: string enum: - max_withdrawal_amount description: Invalid maximum withdrawal amount required: - type - title: max_otc_withdrawal_amount description: Invalid maximum OTC withdrawal amount type: object properties: type: type: string enum: - max_otc_withdrawal_amount description: Invalid maximum OTC withdrawal amount required: - type - title: max_staking_withdrawal_amount description: Invalid maximum staking withdrawal amount type: object properties: type: type: string enum: - max_staking_withdrawal_amount description: >- Invalid maximum staking withdrawal amount required: - type - title: vault_policy_not_found description: Vault policy not found type: object properties: type: type: string enum: - vault_policy_not_found description: Vault policy not found required: - type - title: >- invalid_number_of_vault_policy_update_operations description: Only one vault policy update is allowed type: object properties: type: type: string enum: - >- invalid_number_of_vault_policy_update_operations description: Only one vault policy update is allowed required: - type - title: quorum_locking_operation description: >- The user cannot be removed because it would lock the minimum quorum type: object properties: type: type: string enum: - quorum_locking_operation description: >- The user cannot be removed because it would lock the minimum quorum required: - type - title: staking_not_enabled description: Staking is not enabled type: object properties: type: type: string enum: - staking_not_enabled description: Staking is not enabled required: - type required: - state - title: failed description: >- The task has reached the quorum, but has errored during execution type: object properties: state: type: string enum: - failed errors: type: array items: oneOf: - title: unknown_internal description: Unknown internal error type: object properties: type: type: string enum: - unknown_internal description: Unknown internal error required: - type - title: invalid_quorum description: Invalid quorum type: object properties: type: type: string enum: - invalid_quorum description: Invalid quorum required: - type - title: max_withdrawal_amount description: Invalid maximum withdrawal amount type: object properties: type: type: string enum: - max_withdrawal_amount description: Invalid maximum withdrawal amount required: - type - title: max_otc_withdrawal_amount description: Invalid maximum OTC withdrawal amount type: object properties: type: type: string enum: - max_otc_withdrawal_amount description: Invalid maximum OTC withdrawal amount required: - type - title: max_staking_withdrawal_amount description: Invalid maximum staking withdrawal amount type: object properties: type: type: string enum: - max_staking_withdrawal_amount description: >- Invalid maximum staking withdrawal amount required: - type - title: vault_policy_not_found description: Vault policy not found type: object properties: type: type: string enum: - vault_policy_not_found description: Vault policy not found required: - type - title: >- invalid_number_of_vault_policy_update_operations description: Only one vault policy update is allowed type: object properties: type: type: string enum: - >- invalid_number_of_vault_policy_update_operations description: Only one vault policy update is allowed required: - type - title: quorum_locking_operation description: >- The user cannot be removed because it would lock the minimum quorum type: object properties: type: type: string enum: - quorum_locking_operation description: >- The user cannot be removed because it would lock the minimum quorum required: - type - title: staking_not_enabled description: Staking is not enabled type: object properties: type: type: string enum: - staking_not_enabled description: Staking is not enabled required: - type required: - errors - state - title: request_withdrawal description: Request a withdrawal from a vault properties: type: type: string enum: - request_withdrawal vault_info: description: Vault information type: object properties: id: example: VN2F7NJJWKJHI2 description: Vault ID type: string pattern: ^V[A-Z2-7]{12}[ACEGIKMOQSUWY246]$ minLength: 14 maxLength: 14 name: description: Vault name type: string pattern: ^[a-zA-Z0-9\s\/-]+$ minLength: 1 maxLength: 32 status: description: Vault status oneOf: - title: pending description: The HSM vault is still initializing type: string enum: - pending - title: created description: The HSM vault has been created type: string enum: - created - title: failed description: The HSM vault creation has failed type: string enum: - failed - title: disabled description: The underlying account has been disabled type: string enum: - disabled required: - id - name - status payload: type: object properties: amount: example: '1.23' description: The amount type: string pattern: ^-?[0-9]+(\.[0-9]+)?$ minLength: 1 maxLength: 64 comment: nullable: true description: User facing Comment type: string maxLength: 1024 address: type: object properties: asset: description: >- The name of the asset that the address identifies type: string minLength: 1 maxLength: 16 address_name: description: Name of the address type: string minLength: 2 maxLength: 100 info: description: >- Additional info associated with the withdrawal address. type: object properties: address: nullable: true type: string beneficiary: nullable: true type: object properties: recipient: description: Recipient type: string minLength: 2 maxLength: 100 type: nullable: true description: Type type: string name: nullable: true description: Name type: string minLength: 2 maxLength: 100 last_name: nullable: true description: Last name type: string minLength: 2 maxLength: 100 country: nullable: true description: Country type: string minLength: 2 maxLength: 100 province: nullable: true description: Province type: string minLength: 2 maxLength: 100 address_1: nullable: true description: Address line 1 type: string maxLength: 100 address_2: nullable: true description: Address line 2 type: string maxLength: 100 city: nullable: true description: City type: string minLength: 2 maxLength: 100 postal_code: nullable: true description: Postal Code type: string minLength: 2 maxLength: 100 vasp_name: nullable: true description: VASP name type: string minLength: 2 maxLength: 100 required: - recipient description: nullable: true description: Optional address description type: string maxLength: 1024 required: - address_name - asset - info fee_info: type: object properties: amount: example: '1.23' description: Max fee amount type: string pattern: ^-?[0-9]+(\.[0-9]+)?$ minLength: 1 maxLength: 64 asset: description: The asset as ISO x-iso-4217-a3 type: string minLength: 1 maxLength: 16 included: description: Fee included type: boolean level: description: Fee level for the transaction oneOf: - title: normal type: string enum: - normal - title: fast type: string enum: - fast - title: urgent type: string enum: - urgent quote_id: description: Unique ID for the fee quote type: string quote_amount: nullable: true example: '1.23' description: The amount type: string pattern: ^-?[0-9]+(\.[0-9]+)?$ minLength: 1 maxLength: 64 quote_asset: nullable: true description: The asset name type: string minLength: 1 maxLength: 16 required: - amount - asset - included - level - quote_id quote_amount: nullable: true example: '1.23' description: The amount type: string pattern: ^-?[0-9]+(\.[0-9]+)?$ minLength: 1 maxLength: 64 quote_asset: nullable: true description: The asset name type: string minLength: 1 maxLength: 16 required: - address - amount - fee_info required: - payload - type - vault_info oneOf: - title: pending description: >- The task is still waiting for approvals and has not reached a quorum yet type: object properties: state: type: string enum: - pending required: - state - title: approved description: >- The task has reached the quorum, but has not been executed type: object properties: state: type: string enum: - approved required: - state - title: denied description: The task has been rejected and not reached the quorum type: object properties: state: type: string enum: - denied required: - state - title: canceled description: The task was canceled type: object properties: state: type: string enum: - canceled required: - state - title: expired description: The task expired type: object properties: state: type: string enum: - expired required: - state - title: executed description: >- The task has reached the quorum and has been successfully executed type: object properties: state: type: string enum: - executed result: nullable: true type: object properties: ref_id: description: Funding reference ID type: string required: - ref_id errors: nullable: true type: array items: oneOf: - title: unknown_internal description: Unknown internal error type: object properties: type: type: string enum: - unknown_internal description: Unknown internal error required: - type - title: vault_not_found description: Vault not found type: object properties: type: type: string enum: - vault_not_found description: Vault not found required: - type - title: invalid_vault_id description: Invalid vault id type: object properties: type: type: string enum: - invalid_vault_id description: Invalid vault id required: - type - title: max_withdrawal_amount_exceeded description: Maximum withdrawal amount exceeded type: object properties: type: type: string enum: - max_withdrawal_amount_exceeded description: Maximum withdrawal amount exceeded required: - type - title: invalid_withdrawal_amount description: Invalid withdrawal amount type: object properties: type: type: string enum: - invalid_withdrawal_amount description: Invalid withdrawal amount required: - type - title: invalid_fee_amount description: Invalid fee amount type: object properties: type: type: string enum: - invalid_fee_amount description: Invalid fee amount required: - type - title: invalid_total_amount description: Invalid total amount type: object properties: type: type: string enum: - invalid_total_amount description: Invalid total amount required: - type - title: invalid_quote_id description: Invalid quote id type: object properties: type: type: string enum: - invalid_quote_id description: Invalid quote id required: - type - title: invalid_asset description: Invalid asset type: object properties: type: type: string enum: - invalid_asset description: Invalid asset required: - type - title: negative_withdrawal_amount description: Negative withdrawal amount type: object properties: type: type: string enum: - negative_withdrawal_amount description: Negative withdrawal amount required: - type - title: quote_id_expired description: Quote ID expired type: object properties: type: type: string enum: - quote_id_expired description: Quote ID expired required: - type - title: quote_id_not_found description: Quote ID not found type: object properties: type: type: string enum: - quote_id_not_found description: Quote ID not found required: - type - title: permission_denied description: Permission denied type: object properties: type: type: string enum: - permission_denied description: Permission denied required: - type required: - state - title: failed description: >- The task has reached the quorum, but has errored during execution type: object properties: state: type: string enum: - failed errors: type: array items: oneOf: - title: unknown_internal description: Unknown internal error type: object properties: type: type: string enum: - unknown_internal description: Unknown internal error required: - type - title: vault_not_found description: Vault not found type: object properties: type: type: string enum: - vault_not_found description: Vault not found required: - type - title: invalid_vault_id description: Invalid vault id type: object properties: type: type: string enum: - invalid_vault_id description: Invalid vault id required: - type - title: max_withdrawal_amount_exceeded description: Maximum withdrawal amount exceeded type: object properties: type: type: string enum: - max_withdrawal_amount_exceeded description: Maximum withdrawal amount exceeded required: - type - title: invalid_withdrawal_amount description: Invalid withdrawal amount type: object properties: type: type: string enum: - invalid_withdrawal_amount description: Invalid withdrawal amount required: - type - title: invalid_fee_amount description: Invalid fee amount type: object properties: type: type: string enum: - invalid_fee_amount description: Invalid fee amount required: - type - title: invalid_total_amount description: Invalid total amount type: object properties: type: type: string enum: - invalid_total_amount description: Invalid total amount required: - type - title: invalid_quote_id description: Invalid quote id type: object properties: type: type: string enum: - invalid_quote_id description: Invalid quote id required: - type - title: invalid_asset description: Invalid asset type: object properties: type: type: string enum: - invalid_asset description: Invalid asset required: - type - title: negative_withdrawal_amount description: Negative withdrawal amount type: object properties: type: type: string enum: - negative_withdrawal_amount description: Negative withdrawal amount required: - type - title: quote_id_expired description: Quote ID expired type: object properties: type: type: string enum: - quote_id_expired description: Quote ID expired required: - type - title: quote_id_not_found description: Quote ID not found type: object properties: type: type: string enum: - quote_id_not_found description: Quote ID not found required: - type - title: permission_denied description: Permission denied type: object properties: type: type: string enum: - permission_denied description: Permission denied required: - type required: - errors - state - title: update_vault description: Update vault meta information like its name properties: type: type: string enum: - update_vault vault_info: description: Vault information type: object properties: id: example: VN2F7NJJWKJHI2 description: Vault ID type: string pattern: ^V[A-Z2-7]{12}[ACEGIKMOQSUWY246]$ minLength: 14 maxLength: 14 name: description: Vault name type: string pattern: ^[a-zA-Z0-9\s\/-]+$ minLength: 1 maxLength: 32 status: description: Vault status oneOf: - title: pending description: The HSM vault is still initializing type: string enum: - pending - title: created description: The HSM vault has been created type: string enum: - created - title: failed description: The HSM vault creation has failed type: string enum: - failed - title: disabled description: The underlying account has been disabled type: string enum: - disabled required: - id - name - status payload: type: object properties: name: nullable: true description: New vault name type: string pattern: ^[a-zA-Z0-9\s\/-]+$ minLength: 1 maxLength: 32 description: nullable: true description: New description of the vault type: string maxLength: 1024 required: - payload - type - vault_info oneOf: - title: pending description: >- The task is still waiting for approvals and has not reached a quorum yet type: object properties: state: type: string enum: - pending required: - state - title: approved description: >- The task has reached the quorum, but has not been executed type: object properties: state: type: string enum: - approved required: - state - title: denied description: The task has been rejected and not reached the quorum type: object properties: state: type: string enum: - denied required: - state - title: canceled description: The task was canceled type: object properties: state: type: string enum: - canceled required: - state - title: expired description: The task expired type: object properties: state: type: string enum: - expired required: - state - title: executed description: >- The task has reached the quorum and has been successfully executed type: object properties: state: type: string enum: - executed errors: nullable: true type: array items: oneOf: - title: unknown_internal description: Unknown internal error type: object properties: type: type: string enum: - unknown_internal description: Unknown internal error required: - type - title: invalid_vault_id description: Invalid vault id type: object properties: type: type: string enum: - invalid_vault_id description: Invalid vault id required: - type - title: vault_not_found description: Vault not found type: object properties: type: type: string enum: - vault_not_found description: Vault not found required: - type required: - state - title: failed description: >- The task has reached the quorum, but has errored during execution type: object properties: state: type: string enum: - failed errors: type: array items: oneOf: - title: unknown_internal description: Unknown internal error type: object properties: type: type: string enum: - unknown_internal description: Unknown internal error required: - type - title: invalid_vault_id description: Invalid vault id type: object properties: type: type: string enum: - invalid_vault_id description: Invalid vault id required: - type - title: vault_not_found description: Vault not found type: object properties: type: type: string enum: - vault_not_found description: Vault not found required: - type required: - errors - state - title: create_vault description: Create a new vault properties: type: type: string enum: - create_vault payload: description: Vault creation task parameters type: object properties: users: description: Users info of the users to be added to the vault type: array items: description: Abridged custody user info object type: object properties: iiban: description: The IIBAN of the user. type: string minLength: 14 maxLength: 42 full_name: nullable: true description: The user full name. type: string email: nullable: true description: The e-mail of the user. type: string pattern: ^.+@\S+\.\S+$ minLength: 1 maxLength: 128 role: description: >- Role that the user holds in the organization. oneOf: - title: admin description: Admin type: string enum: - admin - title: initiator description: Initiator type: string enum: - initiator - title: reviewer description: Reviewer type: string enum: - reviewer - title: auditor description: Auditor type: string enum: - auditor required: - iiban - role policies: description: Policies attached to the vault type: array items: oneOf: - title: max_transaction_amount description: >- Limits the maximum transaction amount for a transaction type: object properties: type: type: string enum: - max_transaction_amount description: >- Limits the maximum transaction amount for a transaction amount: example: '1.23' description: Maximum transaction amount type: string pattern: ^-?[0-9]+(\.[0-9]+)?$ minLength: 1 maxLength: 64 required: - amount - type - title: required_approvals description: >- Requires a certain number of reviewers for an approval type: object properties: type: type: string enum: - required_approvals description: >- Requires a certain number of reviewers for an approval available: nullable: true description: Number of currently available reviewers type: integer format: uint32 minimum: 0 required: - required - type - title: otc_max_transaction_amount description: >- Limits the maximum amount for an OTC transaction type: object properties: type: type: string enum: - otc_max_transaction_amount description: >- Limits the maximum amount for an OTC transaction amount: example: '1.23' description: Maximum transaction amount type: string pattern: ^-?[0-9]+(\.[0-9]+)?$ minLength: 1 maxLength: 64 required: - amount - type - title: otc_enabled description: Enable/disable the vault OTC capabilities type: object properties: type: type: string enum: - otc_enabled description: >- Enable/disable the vault OTC capabilities enable: type: boolean required: - enable - type - title: staking_enabled description: >- Enable/disable the vault staking capabilities type: object properties: type: type: string enum: - staking_enabled description: >- Enable/disable the vault staking capabilities enable: type: boolean required: - enable - type - title: staking_max_transaction_amount description: >- Limits the maximum amount for a staking transaction type: object properties: type: type: string enum: - staking_max_transaction_amount description: >- Limits the maximum amount for a staking transaction amount: example: '1.23' description: Maximum transaction amount type: string pattern: ^-?[0-9]+(\.[0-9]+)?$ minLength: 1 maxLength: 64 required: - amount - type withdrawal_addresses: nullable: true description: Withdrawal addresses to be added to the vault type: array items: type: object properties: asset: description: >- The name of the asset that the address identifies type: string minLength: 1 maxLength: 16 address_name: description: Name of the address type: string minLength: 2 maxLength: 100 method: description: >- The withdrawal method allowed for this address type: string info: description: >- Additional info associated with the withdrawal address. Some fields will only be available for certain withdrawal methods. type: object properties: address: nullable: true type: string beneficiary: nullable: true type: object properties: recipient: description: Recipient type: string minLength: 2 maxLength: 100 type: nullable: true description: Type type: string name: nullable: true description: Name type: string minLength: 2 maxLength: 100 last_name: nullable: true description: Last name type: string country: nullable: true description: Country type: string minLength: 2 maxLength: 100 province: nullable: true description: Province type: string minLength: 2 maxLength: 100 address_1: nullable: true description: Address line 1 type: string maxLength: 100 address_2: nullable: true description: Address line 2 type: string maxLength: 100 city: nullable: true description: City type: string minLength: 2 maxLength: 100 postal_code: nullable: true description: Postal Code type: string minLength: 2 maxLength: 100 vasp_name: nullable: true description: VASP name type: string minLength: 2 maxLength: 100 required: - recipient description: nullable: true description: Optional description type: string maxLength: 1024 required: - address_name - asset - info - method name: description: Vault name type: string pattern: ^[a-zA-Z0-9\s\/-]+$ minLength: 1 maxLength: 32 description: nullable: true description: A description of the vault type: string maxLength: 1024 required: - name - policies - users required: - payload - type oneOf: - title: pending description: >- The task is still waiting for approvals and has not reached a quorum yet type: object properties: state: type: string enum: - pending required: - state - title: approved description: >- The task has reached the quorum, but has not been executed type: object properties: state: type: string enum: - approved required: - state - title: denied description: The task has been rejected and not reached the quorum type: object properties: state: type: string enum: - denied required: - state - title: canceled description: The task was canceled type: object properties: state: type: string enum: - canceled required: - state - title: expired description: The task expired type: object properties: state: type: string enum: - expired required: - state - title: executed description: >- The task has reached the quorum and has been successfully executed type: object properties: state: type: string enum: - executed result: nullable: true type: object properties: id: example: VN2F7NJJWKJHI2 description: ID of the created vault type: string pattern: ^V[A-Z2-7]{12}[ACEGIKMOQSUWY246]$ minLength: 14 maxLength: 14 required: - id errors: nullable: true type: array items: oneOf: - title: unknown_internal description: Unknown internal error type: object properties: type: type: string enum: - unknown_internal description: Unknown internal error required: - type - title: invalid_quorum description: Invalid quorum type: object properties: type: type: string enum: - invalid_quorum description: Invalid quorum required: - type - title: vault_quorum_not_reached description: Vault quorum hasn't been reached type: object properties: type: type: string enum: - vault_quorum_not_reached description: Vault quorum hasn't been reached required: - type - title: duplicate_vault_name description: A vault with this name already exists type: object properties: type: type: string enum: - duplicate_vault_name description: A vault with this name already exists required: - type - title: organization_not_found description: Specified organization not found type: object properties: type: type: string enum: - organization_not_found description: Specified organization not found required: - type - title: max_withdrawal_amount description: Invalid maximum withdrawal amount type: object properties: type: type: string enum: - max_withdrawal_amount description: Invalid maximum withdrawal amount required: - type - title: max_otc_withdrawal_amount description: Invalid maximum OTC withdrawal amount type: object properties: type: type: string enum: - max_otc_withdrawal_amount description: Invalid maximum OTC withdrawal amount required: - type - title: max_staking_withdrawal_amount description: Invalid maximum staking withdrawal amount type: object properties: type: type: string enum: - max_staking_withdrawal_amount description: >- Invalid maximum staking withdrawal amount required: - type - title: max_withdrawal_amount_not_found description: Maximum withdrawal amount not found type: object properties: type: type: string enum: - max_withdrawal_amount_not_found description: Maximum withdrawal amount not found required: - type - title: vault_gateway description: Creation of the vault failed in CSFG type: object properties: type: type: string enum: - vault_gateway description: Creation of the vault failed in CSFG required: - type - title: org_limit_custody_vaults_exceeded description: >- Limit of custody vaults has been reached for the current organization type: object properties: type: type: string enum: - org_limit_custody_vaults_exceeded description: >- Limit of custody vaults has been reached for the current organization required: - type required: - state - title: failed description: >- The task has reached the quorum, but has errored during execution type: object properties: state: type: string enum: - failed errors: type: array items: oneOf: - title: unknown_internal description: Unknown internal error type: object properties: type: type: string enum: - unknown_internal description: Unknown internal error required: - type - title: invalid_quorum description: Invalid quorum type: object properties: type: type: string enum: - invalid_quorum description: Invalid quorum required: - type - title: vault_quorum_not_reached description: Vault quorum hasn't been reached type: object properties: type: type: string enum: - vault_quorum_not_reached description: Vault quorum hasn't been reached required: - type - title: duplicate_vault_name description: A vault with this name already exists type: object properties: type: type: string enum: - duplicate_vault_name description: A vault with this name already exists required: - type - title: organization_not_found description: Specified organization not found type: object properties: type: type: string enum: - organization_not_found description: Specified organization not found required: - type - title: max_withdrawal_amount description: Invalid maximum withdrawal amount type: object properties: type: type: string enum: - max_withdrawal_amount description: Invalid maximum withdrawal amount required: - type - title: max_otc_withdrawal_amount description: Invalid maximum OTC withdrawal amount type: object properties: type: type: string enum: - max_otc_withdrawal_amount description: Invalid maximum OTC withdrawal amount required: - type - title: max_staking_withdrawal_amount description: Invalid maximum staking withdrawal amount type: object properties: type: type: string enum: - max_staking_withdrawal_amount description: >- Invalid maximum staking withdrawal amount required: - type - title: max_withdrawal_amount_not_found description: Maximum withdrawal amount not found type: object properties: type: type: string enum: - max_withdrawal_amount_not_found description: Maximum withdrawal amount not found required: - type - title: vault_gateway description: Creation of the vault failed in CSFG type: object properties: type: type: string enum: - vault_gateway description: Creation of the vault failed in CSFG required: - type - title: org_limit_custody_vaults_exceeded description: >- Limit of custody vaults has been reached for the current organization type: object properties: type: type: string enum: - org_limit_custody_vaults_exceeded description: >- Limit of custody vaults has been reached for the current organization required: - type required: - errors - state - title: create_group description: Create a new group properties: type: type: string enum: - create_group payload: description: Group creation task parameters type: object properties: users: description: Users info of the users to be added to the group type: array items: description: Abridged custody user info object type: object properties: iiban: description: The IIBAN of the user. type: string minLength: 14 maxLength: 42 full_name: nullable: true description: The user full name. type: string email: nullable: true description: The e-mail of the user. type: string pattern: ^.+@\S+\.\S+$ minLength: 1 maxLength: 128 role: description: >- Role that the user holds in the organization. oneOf: - title: admin description: Admin type: string enum: - admin - title: initiator description: Initiator type: string enum: - initiator - title: reviewer description: Reviewer type: string enum: - reviewer - title: auditor description: Auditor type: string enum: - auditor required: - iiban - role name: description: The group name. type: string pattern: ^[a-zA-Z0-9\s\/-]+$ minLength: 1 maxLength: 32 description: nullable: true description: A description of the group. type: string maxLength: 1024 required: - name - users required: - payload - type oneOf: - title: pending description: >- The task is still waiting for approvals and has not reached a quorum yet type: object properties: state: type: string enum: - pending required: - state - title: approved description: >- The task has reached the quorum, but has not been executed type: object properties: state: type: string enum: - approved required: - state - title: denied description: The task has been rejected and not reached the quorum type: object properties: state: type: string enum: - denied required: - state - title: canceled description: The task was canceled type: object properties: state: type: string enum: - canceled required: - state - title: expired description: The task expired type: object properties: state: type: string enum: - expired required: - state - title: executed description: >- The task has reached the quorum and has been successfully executed type: object properties: state: type: string enum: - executed result: nullable: true type: object properties: id: example: GN2F7NJJWKJHI2 description: ID of the created group type: string pattern: ^G[A-Z2-7]{12}[ACEGIKMOQSUWY246]$ minLength: 14 maxLength: 14 required: - id errors: nullable: true type: array items: oneOf: - title: unknown_internal description: Unknown internal error type: object properties: type: type: string enum: - unknown_internal description: Unknown internal error required: - type - title: auditor_in_vault description: Auditor cannot be member of a vault type: object properties: type: type: string enum: - auditor_in_vault description: Auditor cannot be member of a vault required: - type - title: group_user_disabled description: Group user disabled type: object properties: type: type: string enum: - group_user_disabled description: Group user disabled required: - type - title: non_existent_group_user description: Group user does not exist type: object properties: type: type: string enum: - non_existent_group_user description: Group user does not exist required: - type - title: group_user_domain_mismatch description: Group user from a different domain type: object properties: type: type: string enum: - group_user_domain_mismatch description: Group user from a different domain required: - type required: - state - title: failed description: >- The task has reached the quorum, but has errored during execution type: object properties: state: type: string enum: - failed errors: type: array items: oneOf: - title: unknown_internal description: Unknown internal error type: object properties: type: type: string enum: - unknown_internal description: Unknown internal error required: - type - title: auditor_in_vault description: Auditor cannot be member of a vault type: object properties: type: type: string enum: - auditor_in_vault description: Auditor cannot be member of a vault required: - type - title: group_user_disabled description: Group user disabled type: object properties: type: type: string enum: - group_user_disabled description: Group user disabled required: - type - title: non_existent_group_user description: Group user does not exist type: object properties: type: type: string enum: - non_existent_group_user description: Group user does not exist required: - type - title: group_user_domain_mismatch description: Group user from a different domain type: object properties: type: type: string enum: - group_user_domain_mismatch description: Group user from a different domain required: - type required: - errors - state - title: request_transfer_to_spot description: Request a transfer from a vault properties: type: type: string enum: - request_transfer_to_spot vault_info: description: Vault information type: object properties: id: example: VN2F7NJJWKJHI2 description: Vault ID type: string pattern: ^V[A-Z2-7]{12}[ACEGIKMOQSUWY246]$ minLength: 14 maxLength: 14 name: description: Vault name type: string pattern: ^[a-zA-Z0-9\s\/-]+$ minLength: 1 maxLength: 32 status: description: Vault status oneOf: - title: pending description: The HSM vault is still initializing type: string enum: - pending - title: created description: The HSM vault has been created type: string enum: - created - title: failed description: The HSM vault creation has failed type: string enum: - failed - title: disabled description: The underlying account has been disabled type: string enum: - disabled required: - id - name - status payload: type: object properties: tx_id: description: Transfer funding reference id type: string amount: example: '1.23' description: Amount to transfer type: string pattern: ^-?[0-9]+(\.[0-9]+)?$ minLength: 1 maxLength: 64 asset: description: Asset to transfer type: string minLength: 1 maxLength: 16 iiban: description: Destination (exchange) iiban type: string minLength: 14 maxLength: 42 fee_info: nullable: true description: Maximum fee to be used (not needed for fiat) type: object properties: amount: example: '1.23' description: Max fee amount type: string pattern: ^-?[0-9]+(\.[0-9]+)?$ minLength: 1 maxLength: 64 asset: description: The asset as ISO x-iso-4217-a3 type: string minLength: 1 maxLength: 16 included: description: Fee included type: boolean level: description: Fee level for the transaction oneOf: - title: normal type: string enum: - normal - title: fast type: string enum: - fast - title: urgent type: string enum: - urgent quote_id: description: Unique ID for the fee quote type: string quote_amount: nullable: true example: '1.23' description: The amount type: string pattern: ^-?[0-9]+(\.[0-9]+)?$ minLength: 1 maxLength: 64 quote_asset: nullable: true description: The asset name type: string minLength: 1 maxLength: 16 required: - amount - asset - included - level - quote_id quote_amount: nullable: true example: '1.23' description: The amount type: string pattern: ^-?[0-9]+(\.[0-9]+)?$ minLength: 1 maxLength: 64 quote_asset: nullable: true description: The asset name type: string minLength: 1 maxLength: 16 required: - amount - asset - iiban - tx_id required: - payload - type - vault_info oneOf: - title: pending description: >- The task is still waiting for approvals and has not reached a quorum yet type: object properties: state: type: string enum: - pending required: - state - title: approved description: >- The task has reached the quorum, but has not been executed type: object properties: state: type: string enum: - approved required: - state - title: denied description: The task has been rejected and not reached the quorum type: object properties: state: type: string enum: - denied required: - state - title: canceled description: The task was canceled type: object properties: state: type: string enum: - canceled required: - state - title: expired description: The task expired type: object properties: state: type: string enum: - expired required: - state - title: executed description: >- The task has reached the quorum and has been successfully executed type: object properties: state: type: string enum: - executed result: nullable: true type: object properties: ref_id: description: Funding reference ID type: string required: - ref_id errors: nullable: true type: array items: oneOf: - title: unknown_internal description: Unknown internal error type: object properties: type: type: string enum: - unknown_internal description: Unknown internal error required: - type - title: invalid_vault_id description: Invalid vault id type: object properties: type: type: string enum: - invalid_vault_id description: Invalid vault id required: - type - title: invalid_approval_id description: Invalid approval id type: object properties: type: type: string enum: - invalid_approval_id description: Invalid approval id required: - type - title: invalid_transfer_id description: Invalid transfer id type: object properties: type: type: string enum: - invalid_transfer_id description: Invalid transfer id required: - type - title: invalid_asset description: Invalid asset type: object properties: type: type: string enum: - invalid_asset description: Invalid asset required: - type - title: invalid_withdrawal_amount description: Invalid withdrawal amount type: object properties: type: type: string enum: - invalid_withdrawal_amount description: Invalid withdrawal amount required: - type - title: invalid_fee_amount description: Invalid fee amount type: object properties: type: type: string enum: - invalid_fee_amount description: Invalid fee amount required: - type - title: negative_withdrawal_amount description: Negative withdrawal amount type: object properties: type: type: string enum: - negative_withdrawal_amount description: Negative withdrawal amount required: - type - title: vault_not_found description: Vault not found type: object properties: type: type: string enum: - vault_not_found description: Vault not found required: - type required: - state - title: failed description: >- The task has reached the quorum, but has errored during execution type: object properties: state: type: string enum: - failed errors: type: array items: oneOf: - title: unknown_internal description: Unknown internal error type: object properties: type: type: string enum: - unknown_internal description: Unknown internal error required: - type - title: invalid_vault_id description: Invalid vault id type: object properties: type: type: string enum: - invalid_vault_id description: Invalid vault id required: - type - title: invalid_approval_id description: Invalid approval id type: object properties: type: type: string enum: - invalid_approval_id description: Invalid approval id required: - type - title: invalid_transfer_id description: Invalid transfer id type: object properties: type: type: string enum: - invalid_transfer_id description: Invalid transfer id required: - type - title: invalid_asset description: Invalid asset type: object properties: type: type: string enum: - invalid_asset description: Invalid asset required: - type - title: invalid_withdrawal_amount description: Invalid withdrawal amount type: object properties: type: type: string enum: - invalid_withdrawal_amount description: Invalid withdrawal amount required: - type - title: invalid_fee_amount description: Invalid fee amount type: object properties: type: type: string enum: - invalid_fee_amount description: Invalid fee amount required: - type - title: negative_withdrawal_amount description: Negative withdrawal amount type: object properties: type: type: string enum: - negative_withdrawal_amount description: Negative withdrawal amount required: - type - title: vault_not_found description: Vault not found type: object properties: type: type: string enum: - vault_not_found description: Vault not found required: - type required: - errors - state - title: update_permission_users description: Update user permissions properties: type: type: string enum: - update_permission_users operations: type: array items: oneOf: - title: update_role description: Update a role type: object properties: type: type: string enum: - update_role description: Update a role item: type: object properties: user: description: User to be updated type: object properties: iiban: description: The IIBAN of the user. type: string minLength: 14 maxLength: 42 full_name: nullable: true description: The user full name. type: string email: nullable: true description: The e-mail of the user. type: string pattern: ^.+@\S+\.\S+$ minLength: 1 maxLength: 128 role: description: >- Role that the user holds in the organization. oneOf: - title: admin description: Admin type: string enum: - admin - title: initiator description: Initiator type: string enum: - initiator - title: reviewer description: Reviewer type: string enum: - reviewer - title: auditor description: Auditor type: string enum: - auditor required: - iiban - role reason: nullable: true description: User facing Reason type: string maxLength: 1024 role: description: The new role oneOf: - title: admin description: Admin type: string enum: - admin - title: initiator description: Initiator type: string enum: - initiator - title: reviewer description: Reviewer type: string enum: - reviewer - title: auditor description: Auditor type: string enum: - auditor required: - role - user required: - item - type - title: assign_attribute description: Assign an attribute type: object properties: type: type: string enum: - assign_attribute description: Assign an attribute item: description: User operation with extra fields type: object properties: user: description: User to be updated type: object properties: iiban: description: The IIBAN of the user. type: string minLength: 14 maxLength: 42 full_name: nullable: true description: The user full name. type: string email: nullable: true description: The e-mail of the user. type: string pattern: ^.+@\S+\.\S+$ minLength: 1 maxLength: 128 role: description: >- Role that the user holds in the organization. oneOf: - title: admin description: Admin type: string enum: - admin - title: initiator description: Initiator type: string enum: - initiator - title: reviewer description: Reviewer type: string enum: - reviewer - title: auditor description: Auditor type: string enum: - auditor required: - iiban - role reason: nullable: true description: User facing Reason type: string maxLength: 1024 attribute: description: Custody user attribute oneOf: - title: otc_trader description: OtcTrader type: string enum: - otc_trader - title: staker description: Staker type: string enum: - staker required: - attribute - user required: - item - type - title: revoke_attribute description: Revoke an attribute type: object properties: type: type: string enum: - revoke_attribute description: Revoke an attribute item: description: User operation with extra fields type: object properties: user: description: User to be updated type: object properties: iiban: description: The IIBAN of the user. type: string minLength: 14 maxLength: 42 full_name: nullable: true description: The user full name. type: string email: nullable: true description: The e-mail of the user. type: string pattern: ^.+@\S+\.\S+$ minLength: 1 maxLength: 128 role: description: >- Role that the user holds in the organization. oneOf: - title: admin description: Admin type: string enum: - admin - title: initiator description: Initiator type: string enum: - initiator - title: reviewer description: Reviewer type: string enum: - reviewer - title: auditor description: Auditor type: string enum: - auditor required: - iiban - role reason: nullable: true description: User facing Reason type: string maxLength: 1024 attribute: description: Custody user attribute oneOf: - title: otc_trader description: OtcTrader type: string enum: - otc_trader - title: staker description: Staker type: string enum: - staker required: - attribute - user required: - item - type minItems: 1 maxItems: 50 required: - operations - type oneOf: - title: pending description: >- The task is still waiting for approvals and has not reached a quorum yet type: object properties: state: type: string enum: - pending required: - state - title: approved description: >- The task has reached the quorum, but has not been executed type: object properties: state: type: string enum: - approved required: - state - title: denied description: The task has been rejected and not reached the quorum type: object properties: state: type: string enum: - denied required: - state - title: canceled description: The task was canceled type: object properties: state: type: string enum: - canceled required: - state - title: expired description: The task expired type: object properties: state: type: string enum: - expired required: - state - title: executed description: >- The task has reached the quorum and has been successfully executed type: object properties: state: type: string enum: - executed errors: nullable: true type: array items: oneOf: - title: unknown_internal description: Unknown internal error type: object properties: type: type: string enum: - unknown_internal description: Unknown internal error required: - type - title: user_not_found description: User not found type: object properties: type: type: string enum: - user_not_found description: User not found required: - type - title: invalid_role description: Invalid role type: object properties: type: type: string enum: - invalid_role description: Invalid role required: - type - title: auditor_in_vault description: Auditor cannot be member of a vault type: object properties: type: type: string enum: - auditor_in_vault description: Auditor cannot be member of a vault required: - type - title: quorum_locking_operation description: >- The user cannot be removed because it would lock the minimum quorum type: object properties: type: type: string enum: - quorum_locking_operation description: >- The user cannot be removed because it would lock the minimum quorum required: - type required: - state - title: failed description: >- The task has reached the quorum, but has errored during execution type: object properties: state: type: string enum: - failed errors: type: array items: oneOf: - title: unknown_internal description: Unknown internal error type: object properties: type: type: string enum: - unknown_internal description: Unknown internal error required: - type - title: user_not_found description: User not found type: object properties: type: type: string enum: - user_not_found description: User not found required: - type - title: invalid_role description: Invalid role type: object properties: type: type: string enum: - invalid_role description: Invalid role required: - type - title: auditor_in_vault description: Auditor cannot be member of a vault type: object properties: type: type: string enum: - auditor_in_vault description: Auditor cannot be member of a vault required: - type - title: quorum_locking_operation description: >- The user cannot be removed because it would lock the minimum quorum type: object properties: type: type: string enum: - quorum_locking_operation description: >- The user cannot be removed because it would lock the minimum quorum required: - type required: - errors - state - title: create_api_users description: Create new API key users properties: type: type: string enum: - create_api_users operations: type: array items: oneOf: - title: add description: Create an API key user type: object properties: type: type: string enum: - add description: Create an API key user item: type: object properties: attributes: nullable: true type: array items: oneOf: - title: otc_trader description: OtcTrader type: string enum: - otc_trader - title: staker description: Staker type: string enum: - staker role: description: Role of the API key oneOf: - title: admin description: Admin type: string enum: - admin - title: initiator description: Initiator type: string enum: - initiator - title: reviewer description: Reviewer type: string enum: - reviewer - title: auditor description: Auditor type: string enum: - auditor name: description: Name of the API key type: string minLength: 2 maxLength: 32 ip_allowlist: nullable: true description: Optional network IP allow list type: array items: description: >- IPv4/IPv6 or IP Network e.g. 10.0.0.1, 10.0.0.0/8, 2001:db8:85a3::8a2e:370:7334/64 type: string pattern: >- (^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\/(3[0-2]|[0-2]?[0-9]))?$)|(^[a-fA-F\d:]{2,39}(\/(1[0-2][0-8]|[1-9]\d|\d{1}))?$) valid_until: nullable: true title: UnixTimestamp description: Optional validity end timestamp type: string maxLength: 13 vaults: nullable: true description: Vault membership type: array items: example: VN2F7NJJWKJHI2 type: string pattern: ^V[A-Z2-7]{12}[ACEGIKMOQSUWY246]$ minLength: 14 maxLength: 14 required: - name - role required: - item - type minItems: 1 maxItems: 50 required: - operations - type oneOf: - title: pending description: >- The task is still waiting for approvals and has not reached a quorum yet type: object properties: state: type: string enum: - pending required: - state - title: approved description: >- The task has reached the quorum, but has not been executed type: object properties: state: type: string enum: - approved required: - state - title: denied description: The task has been rejected and not reached the quorum type: object properties: state: type: string enum: - denied required: - state - title: canceled description: The task was canceled type: object properties: state: type: string enum: - canceled required: - state - title: expired description: The task expired type: object properties: state: type: string enum: - expired required: - state - title: executed description: >- The task has reached the quorum and has been successfully executed type: object properties: state: type: string enum: - executed result: nullable: true type: object properties: users: description: Created users type: array items: type: object properties: iiban: description: IBAN type: string minLength: 14 maxLength: 42 role: oneOf: - title: admin description: Admin type: string enum: - admin - title: initiator description: Initiator type: string enum: - initiator - title: reviewer description: Reviewer type: string enum: - reviewer - title: auditor description: Auditor type: string enum: - auditor attributes: default: [] type: array items: oneOf: - title: otc_trader description: OtcTrader type: string enum: - otc_trader - title: staker description: Staker type: string enum: - staker required: - iiban - role required: - users errors: nullable: true type: array items: oneOf: - title: unknown_internal description: Unknown internal error type: object properties: type: type: string enum: - unknown_internal description: Unknown internal error required: - type - title: role_not_found description: Role not found type: object properties: type: type: string enum: - role_not_found description: Role not found required: - type - title: org_limit_custody_api_users_exceeded description: >- Limit of custody API key users has been reached for the current organization type: object properties: type: type: string enum: - org_limit_custody_api_users_exceeded description: >- Limit of custody API key users has been reached for the current organization required: - type - title: organization_not_found description: Organization not found type: object properties: type: type: string enum: - organization_not_found description: Organization not found required: - type - title: domain_not_found description: No error information available type: object properties: type: type: string enum: - domain_not_found description: No error information available required: - type - title: invalid_arguments description: Invalid arguments type: object properties: type: type: string enum: - invalid_arguments description: Invalid arguments required: - type - title: master_account_does_not_have_a_full_name description: Master account does not have a full name type: object properties: type: type: string enum: - master_account_does_not_have_a_full_name description: Master account does not have a full name required: - type - title: auditor_in_vault description: Auditor cannot be member of a vault type: object properties: type: type: string enum: - auditor_in_vault description: Auditor cannot be member of a vault required: - type required: - state - title: failed description: >- The task has reached the quorum, but has errored during execution type: object properties: state: type: string enum: - failed errors: type: array items: oneOf: - title: unknown_internal description: Unknown internal error type: object properties: type: type: string enum: - unknown_internal description: Unknown internal error required: - type - title: role_not_found description: Role not found type: object properties: type: type: string enum: - role_not_found description: Role not found required: - type - title: org_limit_custody_api_users_exceeded description: >- Limit of custody API key users has been reached for the current organization type: object properties: type: type: string enum: - org_limit_custody_api_users_exceeded description: >- Limit of custody API key users has been reached for the current organization required: - type - title: organization_not_found description: Organization not found type: object properties: type: type: string enum: - organization_not_found description: Organization not found required: - type - title: domain_not_found description: No error information available type: object properties: type: type: string enum: - domain_not_found description: No error information available required: - type - title: invalid_arguments description: Invalid arguments type: object properties: type: type: string enum: - invalid_arguments description: Invalid arguments required: - type - title: master_account_does_not_have_a_full_name description: Master account does not have a full name type: object properties: type: type: string enum: - master_account_does_not_have_a_full_name description: Master account does not have a full name required: - type - title: auditor_in_vault description: Auditor cannot be member of a vault type: object properties: type: type: string enum: - auditor_in_vault description: Auditor cannot be member of a vault required: - type required: - errors - state - title: update_api_users description: Update API key users properties: type: type: string enum: - update_api_users operations: type: array items: oneOf: - title: update_user description: Update an API key user type: object properties: type: type: string enum: - update_user description: Update an API key user item: type: object properties: ip_allowlist: nullable: true description: Network IP allow list type: array items: description: >- IPv4/IPv6 or IP Network e.g. 10.0.0.1, 10.0.0.0/8, 2001:db8:85a3::8a2e:370:7334/64 type: string pattern: >- (^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\/(3[0-2]|[0-2]?[0-9]))?$)|(^[a-fA-F\d:]{2,39}(\/(1[0-2][0-8]|[1-9]\d|\d{1}))?$) valid_until: nullable: true title: UnixTimestamp description: Validity end timestamp type: string maxLength: 13 user: description: Abridged custody user info object type: object properties: iiban: description: The IIBAN of the user. type: string minLength: 14 maxLength: 42 full_name: nullable: true description: The user full name. type: string email: nullable: true description: The e-mail of the user. type: string pattern: ^.+@\S+\.\S+$ minLength: 1 maxLength: 128 role: description: >- Role that the user holds in the organization. oneOf: - title: admin description: Admin type: string enum: - admin - title: initiator description: Initiator type: string enum: - initiator - title: reviewer description: Reviewer type: string enum: - reviewer - title: auditor description: Auditor type: string enum: - auditor required: - iiban - role required: - user required: - item - type - title: update_role description: Update permissions of a user type: object properties: type: type: string enum: - update_role description: Update permissions of a user item: type: object properties: user: description: User to be updated type: object properties: iiban: description: The IIBAN of the user. type: string minLength: 14 maxLength: 42 full_name: nullable: true description: The user full name. type: string email: nullable: true description: The e-mail of the user. type: string pattern: ^.+@\S+\.\S+$ minLength: 1 maxLength: 128 role: description: >- Role that the user holds in the organization. oneOf: - title: admin description: Admin type: string enum: - admin - title: initiator description: Initiator type: string enum: - initiator - title: reviewer description: Reviewer type: string enum: - reviewer - title: auditor description: Auditor type: string enum: - auditor required: - iiban - role reason: nullable: true description: User facing Reason type: string maxLength: 1024 role: description: The new role oneOf: - title: admin description: Admin type: string enum: - admin - title: initiator description: Initiator type: string enum: - initiator - title: reviewer description: Reviewer type: string enum: - reviewer - title: auditor description: Auditor type: string enum: - auditor required: - role - user required: - item - type - title: assign_attribute description: Add an attribute to a user type: object properties: type: type: string enum: - assign_attribute description: Add an attribute to a user item: description: User operation with extra fields type: object properties: user: description: User to be updated type: object properties: iiban: description: The IIBAN of the user. type: string minLength: 14 maxLength: 42 full_name: nullable: true description: The user full name. type: string email: nullable: true description: The e-mail of the user. type: string pattern: ^.+@\S+\.\S+$ minLength: 1 maxLength: 128 role: description: >- Role that the user holds in the organization. oneOf: - title: admin description: Admin type: string enum: - admin - title: initiator description: Initiator type: string enum: - initiator - title: reviewer description: Reviewer type: string enum: - reviewer - title: auditor description: Auditor type: string enum: - auditor required: - iiban - role reason: nullable: true description: User facing Reason type: string maxLength: 1024 attribute: description: Custody user attribute oneOf: - title: otc_trader description: OtcTrader type: string enum: - otc_trader - title: staker description: Staker type: string enum: - staker required: - attribute - user required: - item - type - title: revoke_attribute description: Remove an attribute of a user type: object properties: type: type: string enum: - revoke_attribute description: Remove an attribute of a user item: description: User operation with extra fields type: object properties: user: description: User to be updated type: object properties: iiban: description: The IIBAN of the user. type: string minLength: 14 maxLength: 42 full_name: nullable: true description: The user full name. type: string email: nullable: true description: The e-mail of the user. type: string pattern: ^.+@\S+\.\S+$ minLength: 1 maxLength: 128 role: description: >- Role that the user holds in the organization. oneOf: - title: admin description: Admin type: string enum: - admin - title: initiator description: Initiator type: string enum: - initiator - title: reviewer description: Reviewer type: string enum: - reviewer - title: auditor description: Auditor type: string enum: - auditor required: - iiban - role reason: nullable: true description: User facing Reason type: string maxLength: 1024 attribute: description: Custody user attribute oneOf: - title: otc_trader description: OtcTrader type: string enum: - otc_trader - title: staker description: Staker type: string enum: - staker required: - attribute - user required: - item - type - title: add_vault description: Add a user to a vault type: object properties: type: type: string enum: - add_vault description: Add a user to a vault item: description: User operation with extra fields type: object properties: user: description: User to be updated type: object properties: iiban: description: The IIBAN of the user. type: string minLength: 14 maxLength: 42 full_name: nullable: true description: The user full name. type: string email: nullable: true description: The e-mail of the user. type: string pattern: ^.+@\S+\.\S+$ minLength: 1 maxLength: 128 role: description: >- Role that the user holds in the organization. oneOf: - title: admin description: Admin type: string enum: - admin - title: initiator description: Initiator type: string enum: - initiator - title: reviewer description: Reviewer type: string enum: - reviewer - title: auditor description: Auditor type: string enum: - auditor required: - iiban - role reason: nullable: true description: User facing Reason type: string maxLength: 1024 vault: description: Vault details type: object properties: id: example: VN2F7NJJWKJHI2 description: Vault id type: string pattern: ^V[A-Z2-7]{12}[ACEGIKMOQSUWY246]$ minLength: 14 maxLength: 14 iiban: nullable: true description: Vault iban type: string minLength: 14 maxLength: 42 name: nullable: true description: Vault name type: string pattern: ^[a-zA-Z0-9\s\/-]+$ minLength: 1 maxLength: 32 required: - id required: - user - vault required: - item - type - title: remove_vault description: Remove a user to a vault type: object properties: type: type: string enum: - remove_vault description: Remove a user to a vault item: description: User operation with extra fields type: object properties: user: description: User to be updated type: object properties: iiban: description: The IIBAN of the user. type: string minLength: 14 maxLength: 42 full_name: nullable: true description: The user full name. type: string email: nullable: true description: The e-mail of the user. type: string pattern: ^.+@\S+\.\S+$ minLength: 1 maxLength: 128 role: description: >- Role that the user holds in the organization. oneOf: - title: admin description: Admin type: string enum: - admin - title: initiator description: Initiator type: string enum: - initiator - title: reviewer description: Reviewer type: string enum: - reviewer - title: auditor description: Auditor type: string enum: - auditor required: - iiban - role reason: nullable: true description: User facing Reason type: string maxLength: 1024 vault: description: Vault details type: object properties: id: example: VN2F7NJJWKJHI2 description: Vault id type: string pattern: ^V[A-Z2-7]{12}[ACEGIKMOQSUWY246]$ minLength: 14 maxLength: 14 iiban: nullable: true description: Vault iban type: string minLength: 14 maxLength: 42 name: nullable: true description: Vault name type: string pattern: ^[a-zA-Z0-9\s\/-]+$ minLength: 1 maxLength: 32 required: - id required: - user - vault required: - item - type minItems: 1 maxItems: 50 required: - operations - type oneOf: - title: pending description: >- The task is still waiting for approvals and has not reached a quorum yet type: object properties: state: type: string enum: - pending required: - state - title: approved description: >- The task has reached the quorum, but has not been executed type: object properties: state: type: string enum: - approved required: - state - title: denied description: The task has been rejected and not reached the quorum type: object properties: state: type: string enum: - denied required: - state - title: canceled description: The task was canceled type: object properties: state: type: string enum: - canceled required: - state - title: expired description: The task expired type: object properties: state: type: string enum: - expired required: - state - title: executed description: >- The task has reached the quorum and has been successfully executed type: object properties: state: type: string enum: - executed errors: nullable: true type: array items: oneOf: - title: unknown_internal description: Unknown internal error type: object properties: type: type: string enum: - unknown_internal description: Unknown internal error required: - type - title: role_not_found description: Role not found type: object properties: type: type: string enum: - role_not_found description: Role not found required: - type required: - state - title: failed description: >- The task has reached the quorum, but has errored during execution type: object properties: state: type: string enum: - failed errors: type: array items: oneOf: - title: unknown_internal description: Unknown internal error type: object properties: type: type: string enum: - unknown_internal description: Unknown internal error required: - type - title: role_not_found description: Role not found type: object properties: type: type: string enum: - role_not_found description: Role not found required: - type required: - errors - state - title: update_vaults_users description: Add/remove users to vaults properties: type: type: string enum: - update_vaults_users operations: type: array items: oneOf: - title: add type: object properties: type: type: string enum: - add item: description: User operation with extra fields type: object properties: user: description: User to be updated type: object properties: iiban: description: The IIBAN of the user. type: string minLength: 14 maxLength: 42 full_name: nullable: true description: The user full name. type: string email: nullable: true description: The e-mail of the user. type: string pattern: ^.+@\S+\.\S+$ minLength: 1 maxLength: 128 role: description: >- Role that the user holds in the organization. oneOf: - title: admin description: Admin type: string enum: - admin - title: initiator description: Initiator type: string enum: - initiator - title: reviewer description: Reviewer type: string enum: - reviewer - title: auditor description: Auditor type: string enum: - auditor required: - iiban - role reason: nullable: true description: User facing Reason type: string maxLength: 1024 vault_id: example: VN2F7NJJWKJHI2 type: string pattern: ^V[A-Z2-7]{12}[ACEGIKMOQSUWY246]$ minLength: 14 maxLength: 14 required: - user - vault_id required: - item - type - title: remove type: object properties: type: type: string enum: - remove item: description: User operation with extra fields type: object properties: user: description: User to be updated type: object properties: iiban: description: The IIBAN of the user. type: string minLength: 14 maxLength: 42 full_name: nullable: true description: The user full name. type: string email: nullable: true description: The e-mail of the user. type: string pattern: ^.+@\S+\.\S+$ minLength: 1 maxLength: 128 role: description: >- Role that the user holds in the organization. oneOf: - title: admin description: Admin type: string enum: - admin - title: initiator description: Initiator type: string enum: - initiator - title: reviewer description: Reviewer type: string enum: - reviewer - title: auditor description: Auditor type: string enum: - auditor required: - iiban - role reason: nullable: true description: User facing Reason type: string maxLength: 1024 vault_id: example: VN2F7NJJWKJHI2 type: string pattern: ^V[A-Z2-7]{12}[ACEGIKMOQSUWY246]$ minLength: 14 maxLength: 14 required: - user - vault_id required: - item - type minItems: 1 maxItems: 50 required: - operations - type oneOf: - title: pending description: >- The task is still waiting for approvals and has not reached a quorum yet type: object properties: state: type: string enum: - pending required: - state - title: approved description: >- The task has reached the quorum, but has not been executed type: object properties: state: type: string enum: - approved required: - state - title: denied description: The task has been rejected and not reached the quorum type: object properties: state: type: string enum: - denied required: - state - title: canceled description: The task was canceled type: object properties: state: type: string enum: - canceled required: - state - title: expired description: The task expired type: object properties: state: type: string enum: - expired required: - state - title: executed description: >- The task has reached the quorum and has been successfully executed type: object properties: state: type: string enum: - executed errors: nullable: true type: array items: oneOf: - title: unknown_internal description: Unknown internal error type: object properties: type: type: string enum: - unknown_internal description: Unknown internal error required: - type - title: vault_not_found description: Vault not found type: object properties: type: type: string enum: - vault_not_found description: Vault not found required: - type - title: invalid_vault_id description: Invalid vault id type: object properties: type: type: string enum: - invalid_vault_id description: Invalid vault id required: - type - title: group_not_found description: Group not found type: object properties: type: type: string enum: - group_not_found description: Group not found required: - type - title: user_not_found description: User not found type: object properties: type: type: string enum: - user_not_found description: User not found required: - type - title: invalid_role description: Invalid role type: object properties: type: type: string enum: - invalid_role description: Invalid role required: - type - title: users_from_different_domains description: >- The requested operations contains users from different domains type: object properties: type: type: string enum: - users_from_different_domains description: >- The requested operations contains users from different domains required: - type - title: auditor_in_vault description: Auditor cannot be member of a vault type: object properties: type: type: string enum: - auditor_in_vault description: Auditor cannot be member of a vault required: - type - title: update_vault_users_multiple_times description: >- Vault user updated multiple times in the bulk operation type: object properties: type: type: string enum: - update_vault_users_multiple_times description: >- Vault user updated multiple times in the bulk operation required: - type - title: permission_denied description: Permission denied type: object properties: type: type: string enum: - permission_denied description: Permission denied required: - type required: - state - title: failed description: >- The task has reached the quorum, but has errored during execution type: object properties: state: type: string enum: - failed errors: type: array items: oneOf: - title: unknown_internal description: Unknown internal error type: object properties: type: type: string enum: - unknown_internal description: Unknown internal error required: - type - title: vault_not_found description: Vault not found type: object properties: type: type: string enum: - vault_not_found description: Vault not found required: - type - title: invalid_vault_id description: Invalid vault id type: object properties: type: type: string enum: - invalid_vault_id description: Invalid vault id required: - type - title: group_not_found description: Group not found type: object properties: type: type: string enum: - group_not_found description: Group not found required: - type - title: user_not_found description: User not found type: object properties: type: type: string enum: - user_not_found description: User not found required: - type - title: invalid_role description: Invalid role type: object properties: type: type: string enum: - invalid_role description: Invalid role required: - type - title: users_from_different_domains description: >- The requested operations contains users from different domains type: object properties: type: type: string enum: - users_from_different_domains description: >- The requested operations contains users from different domains required: - type - title: auditor_in_vault description: Auditor cannot be member of a vault type: object properties: type: type: string enum: - auditor_in_vault description: Auditor cannot be member of a vault required: - type - title: update_vault_users_multiple_times description: >- Vault user updated multiple times in the bulk operation type: object properties: type: type: string enum: - update_vault_users_multiple_times description: >- Vault user updated multiple times in the bulk operation required: - type - title: permission_denied description: Permission denied type: object properties: type: type: string enum: - permission_denied description: Permission denied required: - type required: - errors - state - title: request_allocation description: Add/remove users to vaults properties: type: type: string enum: - request_allocation vault_info: description: Vault information type: object properties: id: example: VN2F7NJJWKJHI2 description: Vault ID type: string pattern: ^V[A-Z2-7]{12}[ACEGIKMOQSUWY246]$ minLength: 14 maxLength: 14 name: description: Vault name type: string pattern: ^[a-zA-Z0-9\s\/-]+$ minLength: 1 maxLength: 32 status: description: Vault status oneOf: - title: pending description: The HSM vault is still initializing type: string enum: - pending - title: created description: The HSM vault has been created type: string enum: - created - title: failed description: The HSM vault creation has failed type: string enum: - failed - title: disabled description: The underlying account has been disabled type: string enum: - disabled required: - id - name - status payload: type: object properties: fee_info: description: Fee information type: object properties: quote_id: example: QTPFPOJ-5XOA3-ST4KFI description: Fee id chosen by the user type: string pattern: ^QT[A-Z2-7]{5}-[A-Z2-7]{5}-[A-Z2-7]{6}$ minLength: 20 maxLength: 20 level: description: Fee level chosen by the user oneOf: - title: normal type: string enum: - normal - title: fast type: string enum: - fast - title: urgent type: string enum: - urgent asset: description: The asset name type: string minLength: 1 maxLength: 16 amount: description: An amount as a string type: string quote_amount: nullable: true example: '1.23' description: The amount type: string pattern: ^-?[0-9]+(\.[0-9]+)?$ minLength: 1 maxLength: 64 quote_asset: nullable: true description: The asset name type: string minLength: 1 maxLength: 16 required: - amount - asset - level - quote_id provider: description: Staking provider type: string bonding_period: nullable: true description: Estimated bonding period type: integer format: int64 unbonding_period: nullable: true description: Estimated unbonding period for deallocation type: integer format: int64 asset: description: The asset name type: string minLength: 1 maxLength: 16 amount: description: An amount as a string type: string quote_amount: nullable: true example: '1.23' description: The amount type: string pattern: ^-?[0-9]+(\.[0-9]+)?$ minLength: 1 maxLength: 64 quote_asset: nullable: true description: The asset name type: string minLength: 1 maxLength: 16 required: - amount - asset - fee_info - provider required: - payload - type - vault_info oneOf: - title: pending description: >- The task is still waiting for approvals and has not reached a quorum yet type: object properties: state: type: string enum: - pending required: - state - title: approved description: >- The task has reached the quorum, but has not been executed type: object properties: state: type: string enum: - approved required: - state - title: denied description: The task has been rejected and not reached the quorum type: object properties: state: type: string enum: - denied required: - state - title: canceled description: The task was canceled type: object properties: state: type: string enum: - canceled required: - state - title: expired description: The task expired type: object properties: state: type: string enum: - expired required: - state - title: executed description: >- The task has reached the quorum and has been successfully executed type: object properties: state: type: string enum: - executed result: nullable: true type: object properties: fee_info: description: The actual fee paid on chain. type: object properties: asset: description: The asset name type: string minLength: 1 maxLength: 16 amount: description: An amount as a string type: string quote_amount: nullable: true example: '1.23' description: The amount type: string pattern: ^-?[0-9]+(\.[0-9]+)?$ minLength: 1 maxLength: 64 quote_asset: nullable: true description: The asset name type: string minLength: 1 maxLength: 16 required: - amount - asset validators: description: Validator nodes that got provisioned type: array items: type: string earn_tx_id: description: Earn transaction id type: string bonding_period: nullable: true description: Bonding period type: integer format: int64 required: - earn_tx_id - fee_info - validators errors: nullable: true type: array items: oneOf: - title: unknown_internal description: Unknown internal error type: object properties: type: type: string enum: - unknown_internal description: Unknown internal error required: - type - title: internal_error description: Custom Error type: object properties: type: type: string enum: - internal_error description: Custom Error required: - type required: - state - title: failed description: >- The task has reached the quorum, but has errored during execution type: object properties: state: type: string enum: - failed errors: type: array items: oneOf: - title: unknown_internal description: Unknown internal error type: object properties: type: type: string enum: - unknown_internal description: Unknown internal error required: - type - title: internal_error description: Custom Error type: object properties: type: type: string enum: - internal_error description: Custom Error required: - type required: - errors - state - title: request_deallocation description: Add/remove users to vaults properties: type: type: string enum: - request_deallocation vault_info: description: Vault information type: object properties: id: example: VN2F7NJJWKJHI2 description: Vault ID type: string pattern: ^V[A-Z2-7]{12}[ACEGIKMOQSUWY246]$ minLength: 14 maxLength: 14 name: description: Vault name type: string pattern: ^[a-zA-Z0-9\s\/-]+$ minLength: 1 maxLength: 32 status: description: Vault status oneOf: - title: pending description: The HSM vault is still initializing type: string enum: - pending - title: created description: The HSM vault has been created type: string enum: - created - title: failed description: The HSM vault creation has failed type: string enum: - failed - title: disabled description: The underlying account has been disabled type: string enum: - disabled required: - id - name - status payload: type: object properties: provider: description: Staking provider type: string unbonding_period: nullable: true description: Estimated unbonding period type: integer format: int64 asset: description: The asset name type: string minLength: 1 maxLength: 16 amount: description: An amount as a string type: string quote_amount: nullable: true example: '1.23' description: The amount type: string pattern: ^-?[0-9]+(\.[0-9]+)?$ minLength: 1 maxLength: 64 quote_asset: nullable: true description: The asset name type: string minLength: 1 maxLength: 16 required: - amount - asset - provider required: - payload - type - vault_info oneOf: - title: pending description: >- The task is still waiting for approvals and has not reached a quorum yet type: object properties: state: type: string enum: - pending required: - state - title: approved description: >- The task has reached the quorum, but has not been executed type: object properties: state: type: string enum: - approved required: - state - title: denied description: The task has been rejected and not reached the quorum type: object properties: state: type: string enum: - denied required: - state - title: canceled description: The task was canceled type: object properties: state: type: string enum: - canceled required: - state - title: expired description: The task expired type: object properties: state: type: string enum: - expired required: - state - title: executed description: >- The task has reached the quorum and has been successfully executed type: object properties: state: type: string enum: - executed result: nullable: true type: object properties: validators: description: Validator nodes that got provisioned type: array items: type: string earn_tx_id: description: Earn transaction id type: string unbonding_period: nullable: true description: Unbonding period type: integer format: int64 required: - earn_tx_id - validators errors: nullable: true type: array items: oneOf: - title: unknown_internal description: Unknown internal error type: object properties: type: type: string enum: - unknown_internal description: Unknown internal error required: - type required: - state - title: failed description: >- The task has reached the quorum, but has errored during execution type: object properties: state: type: string enum: - failed errors: type: array items: oneOf: - title: unknown_internal description: Unknown internal error type: object properties: type: type: string enum: - unknown_internal description: Unknown internal error required: - type required: - errors - state id: example: AN2F7NJJWKJHI2 description: Id of the activity type: string pattern: ^A[A-Z2-7]{12}[ACEGIKMOQSUWY246]$ minLength: 14 maxLength: 14 created_at: title: UnixTimestamp description: Time the activity occurred type: string maxLength: 13 required: - created_at - id - task oneOf: - title: created description: >- Event that is emitted once the initiator has submitted the request type: object properties: type: type: string enum: - created description: >- Event that is emitted once the initiator has submitted the request comment: nullable: true description: Comment for the task creation if available type: string maxLength: 1024 user: description: User associated with the activity type: object properties: full_name: nullable: true description: User full name type: string role: nullable: true description: User role oneOf: - title: admin description: Admin type: string enum: - admin - title: initiator description: Initiator type: string enum: - initiator - title: reviewer description: Reviewer type: string enum: - reviewer - title: auditor description: Auditor type: string enum: - auditor ip_address: nullable: true description: User IP address type: string iiban: nullable: true description: User IIBAN type: string minLength: 14 maxLength: 42 required: - type - user - title: review_approved description: >- Event that is emitted when a user reviewed and approved the request type: object properties: type: type: string enum: - review_approved description: >- Event that is emitted when a user reviewed and approved the request comment: nullable: true description: Review comment type: string maxLength: 1024 user: description: User associated with the activity type: object properties: full_name: nullable: true description: User full name type: string role: nullable: true description: User role oneOf: - title: admin description: Admin type: string enum: - admin - title: initiator description: Initiator type: string enum: - initiator - title: reviewer description: Reviewer type: string enum: - reviewer - title: auditor description: Auditor type: string enum: - auditor ip_address: nullable: true description: User IP address type: string iiban: nullable: true description: User IIBAN type: string minLength: 14 maxLength: 42 required: - type - user - title: review_denied description: >- Event that is emitted when a user reviewed and denied the request type: object properties: type: type: string enum: - review_denied description: >- Event that is emitted when a user reviewed and denied the request comment: nullable: true description: Review comment type: string maxLength: 1024 user: description: User associated with the activity type: object properties: full_name: nullable: true description: User full name type: string role: nullable: true description: User role oneOf: - title: admin description: Admin type: string enum: - admin - title: initiator description: Initiator type: string enum: - initiator - title: reviewer description: Reviewer type: string enum: - reviewer - title: auditor description: Auditor type: string enum: - auditor ip_address: nullable: true description: User IP address type: string iiban: nullable: true description: User IIBAN type: string minLength: 14 maxLength: 42 required: - type - user - title: canceled description: Event that is emitted when a user cancelled the request type: object properties: type: type: string enum: - canceled description: Event that is emitted when a user cancelled the request comment: nullable: true description: Reason for the cancellation type: string maxLength: 1024 user: description: User associated with the activity type: object properties: full_name: nullable: true description: User full name type: string role: nullable: true description: User role oneOf: - title: admin description: Admin type: string enum: - admin - title: initiator description: Initiator type: string enum: - initiator - title: reviewer description: Reviewer type: string enum: - reviewer - title: auditor description: Auditor type: string enum: - auditor ip_address: nullable: true description: User IP address type: string iiban: nullable: true description: User IIBAN type: string minLength: 14 maxLength: 42 required: - type - user - title: executed description: >- Event that is emitted when the request has been successfully executed type: object properties: type: type: string enum: - executed description: >- Event that is emitted when the request has been successfully executed required: - type - title: failed description: >- Event that is emitted when the request has failed during execution type: object properties: type: type: string enum: - failed description: >- Event that is emitted when the request has failed during execution required: - type - title: expired description: >- Event that is emitted when the request has expired and was cancelled. type: object properties: type: type: string enum: - expired description: >- Event that is emitted when the request has expired and was cancelled. required: - type errors: $ref: '#/components/schemas/KWebErrors' start: type: integer format: uint64 minimum: 0 total: type: integer format: uint64 minimum: 0 required: - errors - start - total nonce: description: Nonce used in construction of `API-Sign` header type: integer format: int64 orderDirection: description: | Ordering direction - `asc`: Return items in ascending order (first to last) - `desc`: Return items in descending order (last to first) default: desc type: string enum: - asc - desc KWebErrors: type: array items: description: General API error. type: object properties: severity: description: API error severity. type: string enum: - E - W errorClass: type: string type: type: string errorMessage: nullable: true type: string required: - errorClass - severity - type securitySchemes: API-Key: type: apiKey description: The "API-Key" header should contain your API key. name: API-Key in: header API-Sign: type: apiKey description: >- Authenticated requests should be signed with the "API-Sign" header, using a signature generated with your private key, nonce, encoded payload, and URI path. name: API-Sign in: header ````