Get task by id

POST 
/0/private/GetCustodyTask

Retrieve details for a specific task.

Request

Query Parameters

id stringrequired

Possible values: >= 14 characters and <= 36 characters, Value must match regular expression ^(T[A-Z2-7]{13}|[0-9a-f]{8}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{12})$

Approval or task ID

application/json

Body

nonce int64required

Nonce used in construction of API-Sign header

Responses

200

application/json

Schema

Schema

result object nullable
Mapped action type for returning to clients with dynamic information like VaultInfo
oneOf
update_group_users
type stringrequired
Possible values: [update_group_users]
operations object[]required
Possible values: >= 1, <= 50
Array [
oneOf
add
type stringrequired
Possible values: [add]
item objectrequired
User operation with extra fields
user objectrequired
User to be updated
iiban stringrequired
Possible values: >= 14 characters and <= 42 characters
The IIBAN of the user.
full_name stringnullable
The user full name.
email stringnullable
Possible values: non-empty and <= 128 characters, Value must match regular expression ^.+@\S+\.\S+$
The e-mail of the user.
role object required
Role that the user holds in the organization.
oneOf
admin
string
Possible values: [admin]
initiator
string
Possible values: [initiator]
reviewer
string
Possible values: [reviewer]
auditor
string
Possible values: [auditor]
reason stringnullable
Possible values: <= 1024 characters
User facing Reason
group_id stringrequired
Possible values: >= 14 characters and <= 14 characters, Value must match regular expression ^G[A-Z2-7]{12}[ACEGIKMOQSUWY246]$
remove
type stringrequired
Possible values: [remove]
item objectrequired
User operation with extra fields
user objectrequired
User to be updated
iiban stringrequired
Possible values: >= 14 characters and <= 42 characters
The IIBAN of the user.
full_name stringnullable
The user full name.
email stringnullable
Possible values: non-empty and <= 128 characters, Value must match regular expression ^.+@\S+\.\S+$
The e-mail of the user.
role object required
Role that the user holds in the organization.
oneOf
admin
string
Possible values: [admin]
initiator
string
Possible values: [initiator]
reviewer
string
Possible values: [reviewer]
auditor
string
Possible values: [auditor]
reason stringnullable
Possible values: <= 1024 characters
User facing Reason
group_id stringrequired
Possible values: >= 14 characters and <= 14 characters, Value must match regular expression ^G[A-Z2-7]{12}[ACEGIKMOQSUWY246]$
]
oneOf
pending
state stringrequired
Possible values: [pending]
approved
state stringrequired
Possible values: [approved]
denied
state stringrequired
Possible values: [denied]
canceled
state stringrequired
Possible values: [canceled]
expired
state stringrequired
Possible values: [expired]
executed
state stringrequired
Possible values: [executed]
errors object[]nullable
Array [
oneOf
unknown_internal
type stringrequired
Possible values: [unknown_internal]
Unknown internal error
group_not_found
type stringrequired
Possible values: [group_not_found]
Group not found
invalid_role
type stringrequired
Possible values: [invalid_role]
Invalid role
invalid_user_iiban
type stringrequired
Possible values: [invalid_user_iiban]
Invalid user IIBAN
user_not_found
type stringrequired
Possible values: [user_not_found]
User not found
auditor_cannot_be_vault_member
type stringrequired
Possible values: [auditor_cannot_be_vault_member]
Auditor cannot be member of a vault
quorum_locking_operation
type stringrequired
Possible values: [quorum_locking_operation]
The user cannot be removed because it would lock the minimum quorum
update_group_users_multiple_times
type stringrequired
Possible values: [update_group_users_multiple_times]
Group user updated multiple times in the bulk operation
]
failed
state stringrequired
Possible values: [failed]
errors object[]required
Array [
oneOf
unknown_internal
type stringrequired
Possible values: [unknown_internal]
Unknown internal error
group_not_found
type stringrequired
Possible values: [group_not_found]
Group not found
invalid_role
type stringrequired
Possible values: [invalid_role]
Invalid role
invalid_user_iiban
type stringrequired
Possible values: [invalid_user_iiban]
Invalid user IIBAN
user_not_found
type stringrequired
Possible values: [user_not_found]
User not found
auditor_cannot_be_vault_member
type stringrequired
Possible values: [auditor_cannot_be_vault_member]
Auditor cannot be member of a vault
quorum_locking_operation
type stringrequired
Possible values: [quorum_locking_operation]
The user cannot be removed because it would lock the minimum quorum
update_group_users_multiple_times
type stringrequired
Possible values: [update_group_users_multiple_times]
Group user updated multiple times in the bulk operation
]
update_role_users
type stringrequired
Possible values: [update_role_users]
operations object[]required
Possible values: >= 1, <= 50
Array [
oneOf
update
type stringrequired
Possible values: [update]
Update a role
item objectrequired
user objectrequired
User to be updated
iiban stringrequired
Possible values: >= 14 characters and <= 42 characters
The IIBAN of the user.
full_name stringnullable
The user full name.
email stringnullable
Possible values: non-empty and <= 128 characters, Value must match regular expression ^.+@\S+\.\S+$
The e-mail of the user.
role object required
Role that the user holds in the organization.
oneOf
admin
string
Possible values: [admin]
initiator
string
Possible values: [initiator]
reviewer
string
Possible values: [reviewer]
auditor
string
Possible values: [auditor]
reason stringnullable
Possible values: <= 1024 characters
User facing Reason
role object required
The new role
oneOf
admin
string
Possible values: [admin]
initiator
string
Possible values: [initiator]
reviewer
string
Possible values: [reviewer]
auditor
string
Possible values: [auditor]
]
oneOf
pending
state stringrequired
Possible values: [pending]
approved
state stringrequired
Possible values: [approved]
denied
state stringrequired
Possible values: [denied]
canceled
state stringrequired
Possible values: [canceled]
expired
state stringrequired
Possible values: [expired]
executed
state stringrequired
Possible values: [executed]
errors object[]nullable
Array [
oneOf
unknown_internal
type stringrequired
Possible values: [unknown_internal]
Unknown internal error
update_role_users_multiple_times
type stringrequired
Possible values: [update_role_users_multiple_times]
User role updated multiple times in the bulk operation
user_not_found
type stringrequired
Possible values: [user_not_found]
User not found
invalid_role
type stringrequired
Possible values: [invalid_role]
Invalid role
auditor_in_vault
type stringrequired
Possible values: [auditor_in_vault]
Auditor cannot be member of a vault
quorum_locking_operation
type stringrequired
Possible values: [quorum_locking_operation]
The user cannot be removed because it would lock the minimum quorum
]
failed
state stringrequired
Possible values: [failed]
errors object[]required
Array [
oneOf
unknown_internal
type stringrequired
Possible values: [unknown_internal]
Unknown internal error
update_role_users_multiple_times
type stringrequired
Possible values: [update_role_users_multiple_times]
User role updated multiple times in the bulk operation
user_not_found
type stringrequired
Possible values: [user_not_found]
User not found
invalid_role
type stringrequired
Possible values: [invalid_role]
Invalid role
auditor_in_vault
type stringrequired
Possible values: [auditor_in_vault]
Auditor cannot be member of a vault
quorum_locking_operation
type stringrequired
Possible values: [quorum_locking_operation]
The user cannot be removed because it would lock the minimum quorum
]
update_domain_policies
type stringrequired
Possible values: [update_domain_policies]
operations object[]required
Possible values: >= 1, <= 50
Array [
oneOf
update
type stringrequired
Possible values: [update]
item object required
oneOf
required_approvals
type stringrequired
Possible values: [required_approvals]
Requires a certain number of reviewers for an approval
required uint32required
Possible values: >= 1
Number of required reviewers
available uint32nullable
Number of currently available reviewers
]
oneOf
pending
state stringrequired
Possible values: [pending]
approved
state stringrequired
Possible values: [approved]
denied
state stringrequired
Possible values: [denied]
canceled
state stringrequired
Possible values: [canceled]
expired
state stringrequired
Possible values: [expired]
executed
state stringrequired
Possible values: [executed]
errors object[]nullable
Array [
oneOf
unknown_internal
type stringrequired
Possible values: [unknown_internal]
Unknown internal error
invalid_quorum
type stringrequired
Possible values: [invalid_quorum]
Invalid quorum
domain_policy_not_found
type stringrequired
Possible values: [domain_policy_not_found]
Domain policy not found
domain_policies_not_specified
type stringrequired
Possible values: [domain_policies_not_specified]
Domain polices not specified in the request
invalid_number_of_domain_policy_update_operations
type stringrequired
Possible values: [invalid_number_of_domain_policy_update_operations]
Only one domain policy update is allowed
quorum_locking_operation
type stringrequired
Possible values: [quorum_locking_operation]
The user cannot be removed because it would lock the minimum quorum
]
failed
state stringrequired
Possible values: [failed]
errors object[]required
Array [
oneOf
unknown_internal
type stringrequired
Possible values: [unknown_internal]
Unknown internal error
invalid_quorum
type stringrequired
Possible values: [invalid_quorum]
Invalid quorum
domain_policy_not_found
type stringrequired
Possible values: [domain_policy_not_found]
Domain policy not found
domain_policies_not_specified
type stringrequired
Possible values: [domain_policies_not_specified]
Domain polices not specified in the request
invalid_number_of_domain_policy_update_operations
type stringrequired
Possible values: [invalid_number_of_domain_policy_update_operations]
Only one domain policy update is allowed
quorum_locking_operation
type stringrequired
Possible values: [quorum_locking_operation]
The user cannot be removed because it would lock the minimum quorum
]
create_users
type stringrequired
Possible values: [create_users]
operations object[]required
Possible values: >= 1, <= 50
Array [
oneOf
add
type stringrequired
Possible values: [add]
Invite a user
item objectrequired
attributes object[]nullable
Possible values: <= 50
Array [
oneOf
otc_trader
string
Possible values: [otc_trader]
staker
string
Possible values: [staker]
]
email stringrequired
Possible values: non-empty and <= 128 characters, Value must match regular expression ^.+@\S+\.\S+$
The email address
role object required
oneOf
admin
string
Possible values: [admin]
initiator
string
Possible values: [initiator]
reviewer
string
Possible values: [reviewer]
auditor
string
Possible values: [auditor]
full_name objectrequired
first_name stringrequired
Possible values: non-empty and <= 128 characters
First name
middle_name stringnullable
Possible values: non-empty and <= 128 characters
Optional middle name
last_name stringrequired
Possible values: non-empty and <= 128 characters
Last name
language stringnullable
timezone stringnullable
]
oneOf
pending
state stringrequired
Possible values: [pending]
approved
state stringrequired
Possible values: [approved]
denied
state stringrequired
Possible values: [denied]
canceled
state stringrequired
Possible values: [canceled]
expired
state stringrequired
Possible values: [expired]
executed
state stringrequired
Possible values: [executed]
result objectnullable
users object[]required
Created users
Array [
iiban stringrequired
Possible values: >= 14 characters and <= 42 characters
IBAN
email stringrequired
Possible values: non-empty and <= 128 characters, Value must match regular expression ^.+@\S+\.\S+$
The email address
role object required
oneOf
admin
string
Possible values: [admin]
initiator
string
Possible values: [initiator]
reviewer
string
Possible values: [reviewer]
auditor
string
Possible values: [auditor]
attributes object[]
Array [
oneOf
otc_trader
string
Possible values: [otc_trader]
staker
string
Possible values: [staker]
]
]
errors object[]nullable
Array [
oneOf
unknown_internal
type stringrequired
Possible values: [unknown_internal]
Unknown internal error
role_not_found
type stringrequired
Possible values: [role_not_found]
Role not found
duplicate_email_in_request
type stringrequired
Possible values: [duplicate_email_in_request]
Duplicate email
empty_full_name
type stringrequired
Possible values: [empty_full_name]
Empty full name
max_length_full_name
type stringrequired
Possible values: [max_length_full_name]
Max length full name
missing_domain_info
type stringrequired
Possible values: [missing_domain_info]
Missing domain info
invalid_user_email
type stringrequired
Possible values: [invalid_user_email]
Invalid user email
organization_not_found
type stringrequired
Possible values: [organization_not_found]
Organization not found
master_not_found
type stringrequired
Possible values: [master_not_found]
Master not found
domain_disabled
type stringrequired
Possible values: [domain_disabled]
Domain disabled
master_account_is_not_configured
type stringrequired
Possible values: [master_account_is_not_configured]
Master account is not configured
master_account_does_not_have_a_full_name
type stringrequired
Possible values: [master_account_does_not_have_a_full_name]
Master account does not have a full name
missing_country
type stringrequired
Possible values: [missing_country]
Country not specified
domain_not_found
type stringrequired
Possible values: [domain_not_found]
Invalid domain
invalid_arguments
type stringrequired
Possible values: [invalid_arguments]
Invalid arguments
org_limit_custody_users_exceeded
type stringrequired
Possible values: [org_limit_custody_users_exceeded]
Limit of custody accounts has been reached for the current organization
org_limit_custody_vaults_exceeded
type stringrequired
Possible values: [org_limit_custody_vaults_exceeded]
Limit of custody vaults has been reached for the current organization
]
failed
state stringrequired
Possible values: [failed]
errors object[]required
Array [
oneOf
unknown_internal
type stringrequired
Possible values: [unknown_internal]
Unknown internal error
role_not_found
type stringrequired
Possible values: [role_not_found]
Role not found
duplicate_email_in_request
type stringrequired
Possible values: [duplicate_email_in_request]
Duplicate email
empty_full_name
type stringrequired
Possible values: [empty_full_name]
Empty full name
max_length_full_name
type stringrequired
Possible values: [max_length_full_name]
Max length full name
missing_domain_info
type stringrequired
Possible values: [missing_domain_info]
Missing domain info
invalid_user_email
type stringrequired
Possible values: [invalid_user_email]
Invalid user email
organization_not_found
type stringrequired
Possible values: [organization_not_found]
Organization not found
master_not_found
type stringrequired
Possible values: [master_not_found]
Master not found
domain_disabled
type stringrequired
Possible values: [domain_disabled]
Domain disabled
master_account_is_not_configured
type stringrequired
Possible values: [master_account_is_not_configured]
Master account is not configured
master_account_does_not_have_a_full_name
type stringrequired
Possible values: [master_account_does_not_have_a_full_name]
Master account does not have a full name
missing_country
type stringrequired
Possible values: [missing_country]
Country not specified
domain_not_found
type stringrequired
Possible values: [domain_not_found]
Invalid domain
invalid_arguments
type stringrequired
Possible values: [invalid_arguments]
Invalid arguments
org_limit_custody_users_exceeded
type stringrequired
Possible values: [org_limit_custody_users_exceeded]
Limit of custody accounts has been reached for the current organization
org_limit_custody_vaults_exceeded
type stringrequired
Possible values: [org_limit_custody_vaults_exceeded]
Limit of custody vaults has been reached for the current organization
]
update_status_users
type stringrequired
Possible values: [update_status_users]
operations object[]required
Possible values: >= 1, <= 50
Array [
oneOf
add
type stringrequired
Possible values: [add]
item objectrequired
User operation without any extra fields
user objectrequired
User to be updated
iiban stringrequired
Possible values: >= 14 characters and <= 42 characters
The IIBAN of the user.
full_name stringnullable
The user full name.
email stringnullable
Possible values: non-empty and <= 128 characters, Value must match regular expression ^.+@\S+\.\S+$
The e-mail of the user.
role object required
Role that the user holds in the organization.
oneOf
admin
string
Possible values: [admin]
initiator
string
Possible values: [initiator]
reviewer
string
Possible values: [reviewer]
auditor
string
Possible values: [auditor]
reason stringnullable
Possible values: <= 1024 characters
User facing Reason
remove
type stringrequired
Possible values: [remove]
item objectrequired
User operation without any extra fields
user objectrequired
User to be updated
iiban stringrequired
Possible values: >= 14 characters and <= 42 characters
The IIBAN of the user.
full_name stringnullable
The user full name.
email stringnullable
Possible values: non-empty and <= 128 characters, Value must match regular expression ^.+@\S+\.\S+$
The e-mail of the user.
role object required
Role that the user holds in the organization.
oneOf
admin
string
Possible values: [admin]
initiator
string
Possible values: [initiator]
reviewer
string
Possible values: [reviewer]
auditor
string
Possible values: [auditor]
reason stringnullable
Possible values: <= 1024 characters
User facing Reason
]
oneOf
pending
state stringrequired
Possible values: [pending]
approved
state stringrequired
Possible values: [approved]
denied
state stringrequired
Possible values: [denied]
canceled
state stringrequired
Possible values: [canceled]
expired
state stringrequired
Possible values: [expired]
executed
state stringrequired
Possible values: [executed]
errors object[]nullable
Array [
oneOf
unknown_internal
type stringrequired
Possible values: [unknown_internal]
Unknown internal error
user_is_a_vault_member
type stringrequired
Possible values: [user_is_a_vault_member]
User cannot be disabled because is a vault member
user_is_a_group_member
type stringrequired
Possible values: [user_is_a_group_member]
User cannot be disabled because is a group member
update_status_users_multiple_times
type stringrequired
Possible values: [update_status_users_multiple_times]
User status updated multiple times in the bulk operation
user_not_found
type stringrequired
Possible values: [user_not_found]
User not found
user_already_has_status
type stringrequired
Possible values: [user_already_has_status]
User already has the status
quorum_locking_operation
type stringrequired
Possible values: [quorum_locking_operation]
The user cannot be removed because it would lock the minimum quorum
]
failed
state stringrequired
Possible values: [failed]
errors object[]required
Array [
oneOf
unknown_internal
type stringrequired
Possible values: [unknown_internal]
Unknown internal error
user_is_a_vault_member
type stringrequired
Possible values: [user_is_a_vault_member]
User cannot be disabled because is a vault member
user_is_a_group_member
type stringrequired
Possible values: [user_is_a_group_member]
User cannot be disabled because is a group member
update_status_users_multiple_times
type stringrequired
Possible values: [update_status_users_multiple_times]
User status updated multiple times in the bulk operation
user_not_found
type stringrequired
Possible values: [user_not_found]
User not found
user_already_has_status
type stringrequired
Possible values: [user_already_has_status]
User already has the status
quorum_locking_operation
type stringrequired
Possible values: [quorum_locking_operation]
The user cannot be removed because it would lock the minimum quorum
]
update_withdrawal_addresses
type stringrequired
Possible values: [update_withdrawal_addresses]
vault_info objectrequired
Vault information
id stringrequired
Possible values: >= 14 characters and <= 14 characters, Value must match regular expression ^V[A-Z2-7]{12}[ACEGIKMOQSUWY246]$
Vault ID
name stringrequired
Possible values: non-empty and <= 32 characters, Value must match regular expression ^[a-zA-Z0-9\s\/-]+$
Vault name
status object required
Vault status
oneOf
pending
string
Possible values: [pending]
created
string
Possible values: [created]
failed
string
Possible values: [failed]
disabled
string
Possible values: [disabled]
operations object[]required
Possible values: >= 1, <= 50
Array [
oneOf
add
type stringrequired
Possible values: [add]
item objectrequired
asset stringrequired
Possible values: non-empty and <= 16 characters
The name of the asset that the address identifies
address_name stringrequired
Possible values: >= 2 characters and <= 100 characters
Name of the address
method stringrequired
The withdrawal method allowed for this address
info objectrequired
Additional info associated with the withdrawal address. Some fields will only be available for certain withdrawal methods.
address stringnullable
beneficiary objectnullable
recipient stringrequired
Possible values: >= 2 characters and <= 100 characters
Recipient
type stringnullable
Type
name stringnullable
Possible values: >= 2 characters and <= 100 characters
Name
last_name stringnullable
Last name
country stringnullable
Possible values: >= 2 characters and <= 100 characters
Country
province stringnullable
Possible values: >= 2 characters and <= 100 characters
Province
address_1 stringnullable
Possible values: <= 100 characters
Address line 1
address_2 stringnullable
Possible values: <= 100 characters
Address line 2
city stringnullable
Possible values: >= 2 characters and <= 100 characters
City
postal_code stringnullable
Possible values: >= 2 characters and <= 100 characters
Postal Code
vasp_name stringnullable
Possible values: >= 2 characters and <= 100 characters
VASP name
description stringnullable
Possible values: <= 1024 characters
Optional description
remove
type stringrequired
Possible values: [remove]
item objectrequired
reason stringnullable
Possible values: <= 1024 characters
Optional reason for the address removal
asset stringrequired
Possible values: non-empty and <= 16 characters
The name of the asset that the address identifies
address_name stringrequired
Possible values: >= 2 characters and <= 100 characters
Name of the address
method stringrequired
The withdrawal method allowed for this address
info objectrequired
Additional info associated with the withdrawal address. Some fields will only be available for certain withdrawal methods.
address stringnullable
beneficiary objectnullable
recipient stringrequired
Possible values: >= 2 characters and <= 100 characters
Recipient
type stringnullable
Type
name stringnullable
Possible values: >= 2 characters and <= 100 characters
Name
last_name stringnullable
Last name
country stringnullable
Possible values: >= 2 characters and <= 100 characters
Country
province stringnullable
Possible values: >= 2 characters and <= 100 characters
Province
address_1 stringnullable
Possible values: <= 100 characters
Address line 1
address_2 stringnullable
Possible values: <= 100 characters
Address line 2
city stringnullable
Possible values: >= 2 characters and <= 100 characters
City
postal_code stringnullable
Possible values: >= 2 characters and <= 100 characters
Postal Code
vasp_name stringnullable
Possible values: >= 2 characters and <= 100 characters
VASP name
description stringnullable
Possible values: <= 1024 characters
Optional description
]
oneOf
pending
state stringrequired
Possible values: [pending]
approved
state stringrequired
Possible values: [approved]
denied
state stringrequired
Possible values: [denied]
canceled
state stringrequired
Possible values: [canceled]
expired
state stringrequired
Possible values: [expired]
executed
state stringrequired
Possible values: [executed]
errors object[]nullable
Array [
oneOf
unknown_internal
type stringrequired
Possible values: [unknown_internal]
Unknown internal error
invalid_vault_id
type stringrequired
Possible values: [invalid_vault_id]
Invalid vault id
vault_not_found
type stringrequired
Possible values: [vault_not_found]
Vault not found
permission_denied
type stringrequired
Possible values: [permission_denied]
Permission denied
]
failed
state stringrequired
Possible values: [failed]
errors object[]required
Array [
oneOf
unknown_internal
type stringrequired
Possible values: [unknown_internal]
Unknown internal error
invalid_vault_id
type stringrequired
Possible values: [invalid_vault_id]
Invalid vault id
vault_not_found
type stringrequired
Possible values: [vault_not_found]
Vault not found
permission_denied
type stringrequired
Possible values: [permission_denied]
Permission denied
]
update_vault_users
type stringrequired
Possible values: [update_vault_users]
vault_info objectrequired
Vault information
id stringrequired
Possible values: >= 14 characters and <= 14 characters, Value must match regular expression ^V[A-Z2-7]{12}[ACEGIKMOQSUWY246]$
Vault ID
name stringrequired
Possible values: non-empty and <= 32 characters, Value must match regular expression ^[a-zA-Z0-9\s\/-]+$
Vault name
status object required
Vault status
oneOf
pending
string
Possible values: [pending]
created
string
Possible values: [created]
failed
string
Possible values: [failed]
disabled
string
Possible values: [disabled]
operations object[]required
Possible values: >= 1, <= 50
Array [
oneOf
add
type stringrequired
Possible values: [add]
item objectrequired
User operation without any extra fields
user objectrequired
User to be updated
iiban stringrequired
Possible values: >= 14 characters and <= 42 characters
The IIBAN of the user.
full_name stringnullable
The user full name.
email stringnullable
Possible values: non-empty and <= 128 characters, Value must match regular expression ^.+@\S+\.\S+$
The e-mail of the user.
role object required
Role that the user holds in the organization.
oneOf
admin
string
Possible values: [admin]
initiator
string
Possible values: [initiator]
reviewer
string
Possible values: [reviewer]
auditor
string
Possible values: [auditor]
reason stringnullable
Possible values: <= 1024 characters
User facing Reason
remove
type stringrequired
Possible values: [remove]
item objectrequired
User operation without any extra fields
user objectrequired
User to be updated
iiban stringrequired
Possible values: >= 14 characters and <= 42 characters
The IIBAN of the user.
full_name stringnullable
The user full name.
email stringnullable
Possible values: non-empty and <= 128 characters, Value must match regular expression ^.+@\S+\.\S+$
The e-mail of the user.
role object required
Role that the user holds in the organization.
oneOf
admin
string
Possible values: [admin]
initiator
string
Possible values: [initiator]
reviewer
string
Possible values: [reviewer]
auditor
string
Possible values: [auditor]
reason stringnullable
Possible values: <= 1024 characters
User facing Reason
]
oneOf
pending
state stringrequired
Possible values: [pending]
approved
state stringrequired
Possible values: [approved]
denied
state stringrequired
Possible values: [denied]
canceled
state stringrequired
Possible values: [canceled]
expired
state stringrequired
Possible values: [expired]
executed
state stringrequired
Possible values: [executed]
errors object[]nullable
Array [
oneOf
unknown_internal
type stringrequired
Possible values: [unknown_internal]
Unknown internal error
vault_not_found
type stringrequired
Possible values: [vault_not_found]
Vault not found
invalid_vault_id
type stringrequired
Possible values: [invalid_vault_id]
Invalid vault id
group_not_found
type stringrequired
Possible values: [group_not_found]
Group not found
user_not_found
type stringrequired
Possible values: [user_not_found]
User not found
invalid_role
type stringrequired
Possible values: [invalid_role]
Invalid role
users_from_different_domains
type stringrequired
Possible values: [users_from_different_domains]
The requested operations contains users from different domains
auditor_in_vault
type stringrequired
Possible values: [auditor_in_vault]
Auditor cannot be member of a vault
update_vault_users_multiple_times
type stringrequired
Possible values: [update_vault_users_multiple_times]
Vault user updated multiple times in the bulk operation
permission_denied
type stringrequired
Possible values: [permission_denied]
Permission denied
]
failed
state stringrequired
Possible values: [failed]
errors object[]required
Array [
oneOf
unknown_internal
type stringrequired
Possible values: [unknown_internal]
Unknown internal error
vault_not_found
type stringrequired
Possible values: [vault_not_found]
Vault not found
invalid_vault_id
type stringrequired
Possible values: [invalid_vault_id]
Invalid vault id
group_not_found
type stringrequired
Possible values: [group_not_found]
Group not found
user_not_found
type stringrequired
Possible values: [user_not_found]
User not found
invalid_role
type stringrequired
Possible values: [invalid_role]
Invalid role
users_from_different_domains
type stringrequired
Possible values: [users_from_different_domains]
The requested operations contains users from different domains
auditor_in_vault
type stringrequired
Possible values: [auditor_in_vault]
Auditor cannot be member of a vault
update_vault_users_multiple_times
type stringrequired
Possible values: [update_vault_users_multiple_times]
Vault user updated multiple times in the bulk operation
permission_denied
type stringrequired
Possible values: [permission_denied]
Permission denied
]
update_vault_policies
type stringrequired
Possible values: [update_vault_policies]
vault_info objectrequired
Vault information
id stringrequired
Possible values: >= 14 characters and <= 14 characters, Value must match regular expression ^V[A-Z2-7]{12}[ACEGIKMOQSUWY246]$
Vault ID
name stringrequired
Possible values: non-empty and <= 32 characters, Value must match regular expression ^[a-zA-Z0-9\s\/-]+$
Vault name
status object required
Vault status
oneOf
pending
string
Possible values: [pending]
created
string
Possible values: [created]
failed
string
Possible values: [failed]
disabled
string
Possible values: [disabled]
operations object[]required
Possible values: >= 1, <= 50
Array [
oneOf
update
type stringrequired
Possible values: [update]
item object required
oneOf
max_transaction_amount
type stringrequired
Possible values: [max_transaction_amount]
Limits the maximum transaction amount for a transaction
amount stringrequired
Possible values: non-empty and <= 64 characters, Value must match regular expression ^-?[0-9]+(\.[0-9]+)?$
Maximum transaction amount
required_approvals
type stringrequired
Possible values: [required_approvals]
Requires a certain number of reviewers for an approval
required uint32required
Possible values: >= 1
Number of required reviewers
available uint32nullable
Number of currently available reviewers
otc_max_transaction_amount
type stringrequired
Possible values: [otc_max_transaction_amount]
Limits the maximum amount for an OTC transaction
amount stringrequired
Possible values: non-empty and <= 64 characters, Value must match regular expression ^-?[0-9]+(\.[0-9]+)?$
Maximum transaction amount
otc_enabled
type stringrequired
Possible values: [otc_enabled]
Enable/disable the vault OTC capabilities
enable booleanrequired
staking_enabled
type stringrequired
Possible values: [staking_enabled]
Enable/disable the vault staking capabilities
enable booleanrequired
staking_max_transaction_amount
type stringrequired
Possible values: [staking_max_transaction_amount]
Limits the maximum amount for a staking transaction
amount stringrequired
Possible values: non-empty and <= 64 characters, Value must match regular expression ^-?[0-9]+(\.[0-9]+)?$
Maximum transaction amount
]
oneOf
pending
state stringrequired
Possible values: [pending]
approved
state stringrequired
Possible values: [approved]
denied
state stringrequired
Possible values: [denied]
canceled
state stringrequired
Possible values: [canceled]
expired
state stringrequired
Possible values: [expired]
executed
state stringrequired
Possible values: [executed]
errors object[]nullable
Array [
oneOf
unknown_internal
type stringrequired
Possible values: [unknown_internal]
Unknown internal error
invalid_quorum
type stringrequired
Possible values: [invalid_quorum]
Invalid quorum
max_withdrawal_amount
type stringrequired
Possible values: [max_withdrawal_amount]
Invalid maximum withdrawal amount
max_otc_withdrawal_amount
type stringrequired
Possible values: [max_otc_withdrawal_amount]
Invalid maximum OTC withdrawal amount
max_staking_withdrawal_amount
type stringrequired
Possible values: [max_staking_withdrawal_amount]
Invalid maximum staking withdrawal amount
vault_policy_not_found
type stringrequired
Possible values: [vault_policy_not_found]
Vault policy not found
invalid_number_of_vault_policy_update_operations
type stringrequired
Possible values: [invalid_number_of_vault_policy_update_operations]
Only one vault policy update is allowed
quorum_locking_operation
type stringrequired
Possible values: [quorum_locking_operation]
The user cannot be removed because it would lock the minimum quorum
staking_not_enabled
type stringrequired
Possible values: [staking_not_enabled]
Staking is not enabled
]
failed
state stringrequired
Possible values: [failed]
errors object[]required
Array [
oneOf
unknown_internal
type stringrequired
Possible values: [unknown_internal]
Unknown internal error
invalid_quorum
type stringrequired
Possible values: [invalid_quorum]
Invalid quorum
max_withdrawal_amount
type stringrequired
Possible values: [max_withdrawal_amount]
Invalid maximum withdrawal amount
max_otc_withdrawal_amount
type stringrequired
Possible values: [max_otc_withdrawal_amount]
Invalid maximum OTC withdrawal amount
max_staking_withdrawal_amount
type stringrequired
Possible values: [max_staking_withdrawal_amount]
Invalid maximum staking withdrawal amount
vault_policy_not_found
type stringrequired
Possible values: [vault_policy_not_found]
Vault policy not found
invalid_number_of_vault_policy_update_operations
type stringrequired
Possible values: [invalid_number_of_vault_policy_update_operations]
Only one vault policy update is allowed
quorum_locking_operation
type stringrequired
Possible values: [quorum_locking_operation]
The user cannot be removed because it would lock the minimum quorum
staking_not_enabled
type stringrequired
Possible values: [staking_not_enabled]
Staking is not enabled
]
request_withdrawal
type stringrequired
Possible values: [request_withdrawal]
vault_info objectrequired
Vault information
id stringrequired
Possible values: >= 14 characters and <= 14 characters, Value must match regular expression ^V[A-Z2-7]{12}[ACEGIKMOQSUWY246]$
Vault ID
name stringrequired
Possible values: non-empty and <= 32 characters, Value must match regular expression ^[a-zA-Z0-9\s\/-]+$
Vault name
status object required
Vault status
oneOf
pending
string
Possible values: [pending]
created
string
Possible values: [created]
failed
string
Possible values: [failed]
disabled
string
Possible values: [disabled]
payload objectrequired
amount stringrequired
Possible values: non-empty and <= 64 characters, Value must match regular expression ^-?[0-9]+(\.[0-9]+)?$
The amount
comment stringnullable
Possible values: <= 1024 characters
User facing Comment
address objectrequired
asset stringrequired
Possible values: non-empty and <= 16 characters
The name of the asset that the address identifies
address_name stringrequired
Possible values: >= 2 characters and <= 100 characters
Name of the address
info objectrequired
Additional info associated with the withdrawal address.
address stringnullable
beneficiary objectnullable
recipient stringrequired
Possible values: >= 2 characters and <= 100 characters
Recipient
type stringnullable
Type
name stringnullable
Possible values: >= 2 characters and <= 100 characters
Name
last_name stringnullable
Possible values: >= 2 characters and <= 100 characters
Last name
country stringnullable
Possible values: >= 2 characters and <= 100 characters
Country
province stringnullable
Possible values: >= 2 characters and <= 100 characters
Province
address_1 stringnullable
Possible values: <= 100 characters
Address line 1
address_2 stringnullable
Possible values: <= 100 characters
Address line 2
city stringnullable
Possible values: >= 2 characters and <= 100 characters
City
postal_code stringnullable
Possible values: >= 2 characters and <= 100 characters
Postal Code
vasp_name stringnullable
Possible values: >= 2 characters and <= 100 characters
VASP name
description stringnullable
Possible values: <= 1024 characters
Optional address description
fee_info objectrequired
amount stringrequired
Possible values: non-empty and <= 64 characters, Value must match regular expression ^-?[0-9]+(\.[0-9]+)?$
Max fee amount
asset stringrequired
Possible values: non-empty and <= 16 characters
The asset as ISO x-iso-4217-a3
included booleanrequired
Fee included
level object required
Fee level for the transaction
oneOf
normal
string
Possible values: [normal]
fast
string
Possible values: [fast]
urgent
string
Possible values: [urgent]
quote_id stringrequired
Unique ID for the fee quote
quote_amount stringnullable
Possible values: non-empty and <= 64 characters, Value must match regular expression ^-?[0-9]+(\.[0-9]+)?$
The amount
quote_asset stringnullable
Possible values: non-empty and <= 16 characters
The asset name
quote_amount stringnullable
Possible values: non-empty and <= 64 characters, Value must match regular expression ^-?[0-9]+(\.[0-9]+)?$
The amount
quote_asset stringnullable
Possible values: non-empty and <= 16 characters
The asset name
oneOf
pending
state stringrequired
Possible values: [pending]
approved
state stringrequired
Possible values: [approved]
denied
state stringrequired
Possible values: [denied]
canceled
state stringrequired
Possible values: [canceled]
expired
state stringrequired
Possible values: [expired]
executed
state stringrequired
Possible values: [executed]
result objectnullable
ref_id stringrequired
Funding reference ID
errors object[]nullable
Array [
oneOf
unknown_internal
type stringrequired
Possible values: [unknown_internal]
Unknown internal error
vault_not_found
type stringrequired
Possible values: [vault_not_found]
Vault not found
invalid_vault_id
type stringrequired
Possible values: [invalid_vault_id]
Invalid vault id
max_withdrawal_amount_exceeded
type stringrequired
Possible values: [max_withdrawal_amount_exceeded]
Maximum withdrawal amount exceeded
invalid_withdrawal_amount
type stringrequired
Possible values: [invalid_withdrawal_amount]
Invalid withdrawal amount
invalid_fee_amount
type stringrequired
Possible values: [invalid_fee_amount]
Invalid fee amount
invalid_total_amount
type stringrequired
Possible values: [invalid_total_amount]
Invalid total amount
invalid_quote_id
type stringrequired
Possible values: [invalid_quote_id]
Invalid quote id
invalid_asset
type stringrequired
Possible values: [invalid_asset]
Invalid asset
negative_withdrawal_amount
type stringrequired
Possible values: [negative_withdrawal_amount]
Negative withdrawal amount
quote_id_expired
type stringrequired
Possible values: [quote_id_expired]
Quote ID expired
quote_id_not_found
type stringrequired
Possible values: [quote_id_not_found]
Quote ID not found
permission_denied
type stringrequired
Possible values: [permission_denied]
Permission denied
]
failed
state stringrequired
Possible values: [failed]
errors object[]required
Array [
oneOf
unknown_internal
type stringrequired
Possible values: [unknown_internal]
Unknown internal error
vault_not_found
type stringrequired
Possible values: [vault_not_found]
Vault not found
invalid_vault_id
type stringrequired
Possible values: [invalid_vault_id]
Invalid vault id
max_withdrawal_amount_exceeded
type stringrequired
Possible values: [max_withdrawal_amount_exceeded]
Maximum withdrawal amount exceeded
invalid_withdrawal_amount
type stringrequired
Possible values: [invalid_withdrawal_amount]
Invalid withdrawal amount
invalid_fee_amount
type stringrequired
Possible values: [invalid_fee_amount]
Invalid fee amount
invalid_total_amount
type stringrequired
Possible values: [invalid_total_amount]
Invalid total amount
invalid_quote_id
type stringrequired
Possible values: [invalid_quote_id]
Invalid quote id
invalid_asset
type stringrequired
Possible values: [invalid_asset]
Invalid asset
negative_withdrawal_amount
type stringrequired
Possible values: [negative_withdrawal_amount]
Negative withdrawal amount
quote_id_expired
type stringrequired
Possible values: [quote_id_expired]
Quote ID expired
quote_id_not_found
type stringrequired
Possible values: [quote_id_not_found]
Quote ID not found
permission_denied
type stringrequired
Possible values: [permission_denied]
Permission denied
]
update_vault
type stringrequired
Possible values: [update_vault]
vault_info objectrequired
Vault information
id stringrequired
Possible values: >= 14 characters and <= 14 characters, Value must match regular expression ^V[A-Z2-7]{12}[ACEGIKMOQSUWY246]$
Vault ID
name stringrequired
Possible values: non-empty and <= 32 characters, Value must match regular expression ^[a-zA-Z0-9\s\/-]+$
Vault name
status object required
Vault status
oneOf
pending
string
Possible values: [pending]
created
string
Possible values: [created]
failed
string
Possible values: [failed]
disabled
string
Possible values: [disabled]
payload objectrequired
name stringnullable
Possible values: non-empty and <= 32 characters, Value must match regular expression ^[a-zA-Z0-9\s\/-]+$
New vault name
description stringnullable
Possible values: <= 1024 characters
New description of the vault
oneOf
pending
state stringrequired
Possible values: [pending]
approved
state stringrequired
Possible values: [approved]
denied
state stringrequired
Possible values: [denied]
canceled
state stringrequired
Possible values: [canceled]
expired
state stringrequired
Possible values: [expired]
executed
state stringrequired
Possible values: [executed]
errors object[]nullable
Array [
oneOf
unknown_internal
type stringrequired
Possible values: [unknown_internal]
Unknown internal error
invalid_vault_id
type stringrequired
Possible values: [invalid_vault_id]
Invalid vault id
vault_not_found
type stringrequired
Possible values: [vault_not_found]
Vault not found
]
failed
state stringrequired
Possible values: [failed]
errors object[]required
Array [
oneOf
unknown_internal
type stringrequired
Possible values: [unknown_internal]
Unknown internal error
invalid_vault_id
type stringrequired
Possible values: [invalid_vault_id]
Invalid vault id
vault_not_found
type stringrequired
Possible values: [vault_not_found]
Vault not found
]
create_vault
type stringrequired
Possible values: [create_vault]
payload objectrequired
Vault creation task parameters
users object[]required
Users info of the users to be added to the vault
Array [
iiban stringrequired
Possible values: >= 14 characters and <= 42 characters
The IIBAN of the user.
full_name stringnullable
The user full name.
email stringnullable
Possible values: non-empty and <= 128 characters, Value must match regular expression ^.+@\S+\.\S+$
The e-mail of the user.
role object required
Role that the user holds in the organization.
oneOf
admin
string
Possible values: [admin]
initiator
string
Possible values: [initiator]
reviewer
string
Possible values: [reviewer]
auditor
string
Possible values: [auditor]
]
policies object[]required
Policies attached to the vault
Array [
oneOf
max_transaction_amount
type stringrequired
Possible values: [max_transaction_amount]
Limits the maximum transaction amount for a transaction
amount stringrequired
Possible values: non-empty and <= 64 characters, Value must match regular expression ^-?[0-9]+(\.[0-9]+)?$
Maximum transaction amount
required_approvals
type stringrequired
Possible values: [required_approvals]
Requires a certain number of reviewers for an approval
required uint32required
Possible values: >= 1
Number of required reviewers
available uint32nullable
Number of currently available reviewers
otc_max_transaction_amount
type stringrequired
Possible values: [otc_max_transaction_amount]
Limits the maximum amount for an OTC transaction
amount stringrequired
Possible values: non-empty and <= 64 characters, Value must match regular expression ^-?[0-9]+(\.[0-9]+)?$
Maximum transaction amount
otc_enabled
type stringrequired
Possible values: [otc_enabled]
Enable/disable the vault OTC capabilities
enable booleanrequired
staking_enabled
type stringrequired
Possible values: [staking_enabled]
Enable/disable the vault staking capabilities
enable booleanrequired
staking_max_transaction_amount
type stringrequired
Possible values: [staking_max_transaction_amount]
Limits the maximum amount for a staking transaction
amount stringrequired
Possible values: non-empty and <= 64 characters, Value must match regular expression ^-?[0-9]+(\.[0-9]+)?$
Maximum transaction amount
]
withdrawal_addresses object[]nullable
Withdrawal addresses to be added to the vault
Array [
asset stringrequired
Possible values: non-empty and <= 16 characters
The name of the asset that the address identifies
address_name stringrequired
Possible values: >= 2 characters and <= 100 characters
Name of the address
method stringrequired
The withdrawal method allowed for this address
info objectrequired
Additional info associated with the withdrawal address. Some fields will only be available for certain withdrawal methods.
address stringnullable
beneficiary objectnullable
recipient stringrequired
Possible values: >= 2 characters and <= 100 characters
Recipient
type stringnullable
Type
name stringnullable
Possible values: >= 2 characters and <= 100 characters
Name
last_name stringnullable
Last name
country stringnullable
Possible values: >= 2 characters and <= 100 characters
Country
province stringnullable
Possible values: >= 2 characters and <= 100 characters
Province
address_1 stringnullable
Possible values: <= 100 characters
Address line 1
address_2 stringnullable
Possible values: <= 100 characters
Address line 2
city stringnullable
Possible values: >= 2 characters and <= 100 characters
City
postal_code stringnullable
Possible values: >= 2 characters and <= 100 characters
Postal Code
vasp_name stringnullable
Possible values: >= 2 characters and <= 100 characters
VASP name
description stringnullable
Possible values: <= 1024 characters
Optional description
]
name stringrequired
Possible values: non-empty and <= 32 characters, Value must match regular expression ^[a-zA-Z0-9\s\/-]+$
Vault name
description stringnullable
Possible values: <= 1024 characters
A description of the vault
oneOf
pending
state stringrequired
Possible values: [pending]
approved
state stringrequired
Possible values: [approved]
denied
state stringrequired
Possible values: [denied]
canceled
state stringrequired
Possible values: [canceled]
expired
state stringrequired
Possible values: [expired]
executed
state stringrequired
Possible values: [executed]
result objectnullable
id stringrequired
Possible values: >= 14 characters and <= 14 characters, Value must match regular expression ^V[A-Z2-7]{12}[ACEGIKMOQSUWY246]$
ID of the created vault
errors object[]nullable
Array [
oneOf
unknown_internal
type stringrequired
Possible values: [unknown_internal]
Unknown internal error
invalid_quorum
type stringrequired
Possible values: [invalid_quorum]
Invalid quorum
vault_quorum_not_reached
type stringrequired
Possible values: [vault_quorum_not_reached]
Vault quorum hasn't been reached
duplicate_vault_name
type stringrequired
Possible values: [duplicate_vault_name]
A vault with this name already exists
organization_not_found
type stringrequired
Possible values: [organization_not_found]
Specified organization not found
max_withdrawal_amount
type stringrequired
Possible values: [max_withdrawal_amount]
Invalid maximum withdrawal amount
max_otc_withdrawal_amount
type stringrequired
Possible values: [max_otc_withdrawal_amount]
Invalid maximum OTC withdrawal amount
max_staking_withdrawal_amount
type stringrequired
Possible values: [max_staking_withdrawal_amount]
Invalid maximum staking withdrawal amount
max_withdrawal_amount_not_found
type stringrequired
Possible values: [max_withdrawal_amount_not_found]
Maximum withdrawal amount not found
vault_gateway
type stringrequired
Possible values: [vault_gateway]
Creation of the vault failed in CSFG
org_limit_custody_vaults_exceeded
type stringrequired
Possible values: [org_limit_custody_vaults_exceeded]
Limit of custody vaults has been reached for the current organization
]
failed
state stringrequired
Possible values: [failed]
errors object[]required
Array [
oneOf
unknown_internal
type stringrequired
Possible values: [unknown_internal]
Unknown internal error
invalid_quorum
type stringrequired
Possible values: [invalid_quorum]
Invalid quorum
vault_quorum_not_reached
type stringrequired
Possible values: [vault_quorum_not_reached]
Vault quorum hasn't been reached
duplicate_vault_name
type stringrequired
Possible values: [duplicate_vault_name]
A vault with this name already exists
organization_not_found
type stringrequired
Possible values: [organization_not_found]
Specified organization not found
max_withdrawal_amount
type stringrequired
Possible values: [max_withdrawal_amount]
Invalid maximum withdrawal amount
max_otc_withdrawal_amount
type stringrequired
Possible values: [max_otc_withdrawal_amount]
Invalid maximum OTC withdrawal amount
max_staking_withdrawal_amount
type stringrequired
Possible values: [max_staking_withdrawal_amount]
Invalid maximum staking withdrawal amount
max_withdrawal_amount_not_found
type stringrequired
Possible values: [max_withdrawal_amount_not_found]
Maximum withdrawal amount not found
vault_gateway
type stringrequired
Possible values: [vault_gateway]
Creation of the vault failed in CSFG
org_limit_custody_vaults_exceeded
type stringrequired
Possible values: [org_limit_custody_vaults_exceeded]
Limit of custody vaults has been reached for the current organization
]
create_group
type stringrequired
Possible values: [create_group]
payload objectrequired
Group creation task parameters
users object[]required
Users info of the users to be added to the group
Array [
iiban stringrequired
Possible values: >= 14 characters and <= 42 characters
The IIBAN of the user.
full_name stringnullable
The user full name.
email stringnullable
Possible values: non-empty and <= 128 characters, Value must match regular expression ^.+@\S+\.\S+$
The e-mail of the user.
role object required
Role that the user holds in the organization.
oneOf
admin
string
Possible values: [admin]
initiator
string
Possible values: [initiator]
reviewer
string
Possible values: [reviewer]
auditor
string
Possible values: [auditor]
]
name stringrequired
Possible values: non-empty and <= 32 characters, Value must match regular expression ^[a-zA-Z0-9\s\/-]+$
The group name.
description stringnullable
Possible values: <= 1024 characters
A description of the group.
oneOf
pending
state stringrequired
Possible values: [pending]
approved
state stringrequired
Possible values: [approved]
denied
state stringrequired
Possible values: [denied]
canceled
state stringrequired
Possible values: [canceled]
expired
state stringrequired
Possible values: [expired]
executed
state stringrequired
Possible values: [executed]
result objectnullable
id stringrequired
Possible values: >= 14 characters and <= 14 characters, Value must match regular expression ^G[A-Z2-7]{12}[ACEGIKMOQSUWY246]$
ID of the created group
errors object[]nullable
Array [
oneOf
unknown_internal
type stringrequired
Possible values: [unknown_internal]
Unknown internal error
auditor_in_vault
type stringrequired
Possible values: [auditor_in_vault]
Auditor cannot be member of a vault
group_user_disabled
type stringrequired
Possible values: [group_user_disabled]
Group user disabled
non_existent_group_user
type stringrequired
Possible values: [non_existent_group_user]
Group user does not exist
group_user_domain_mismatch
type stringrequired
Possible values: [group_user_domain_mismatch]
Group user from a different domain
]
failed
state stringrequired
Possible values: [failed]
errors object[]required
Array [
oneOf
unknown_internal
type stringrequired
Possible values: [unknown_internal]
Unknown internal error
auditor_in_vault
type stringrequired
Possible values: [auditor_in_vault]
Auditor cannot be member of a vault
group_user_disabled
type stringrequired
Possible values: [group_user_disabled]
Group user disabled
non_existent_group_user
type stringrequired
Possible values: [non_existent_group_user]
Group user does not exist
group_user_domain_mismatch
type stringrequired
Possible values: [group_user_domain_mismatch]
Group user from a different domain
]
request_transfer_to_spot
type stringrequired
Possible values: [request_transfer_to_spot]
vault_info objectrequired
Vault information
id stringrequired
Possible values: >= 14 characters and <= 14 characters, Value must match regular expression ^V[A-Z2-7]{12}[ACEGIKMOQSUWY246]$
Vault ID
name stringrequired
Possible values: non-empty and <= 32 characters, Value must match regular expression ^[a-zA-Z0-9\s\/-]+$
Vault name
status object required
Vault status
oneOf
pending
string
Possible values: [pending]
created
string
Possible values: [created]
failed
string
Possible values: [failed]
disabled
string
Possible values: [disabled]
payload objectrequired
tx_id stringrequired
Transfer funding reference id
amount stringrequired
Possible values: non-empty and <= 64 characters, Value must match regular expression ^-?[0-9]+(\.[0-9]+)?$
Amount to transfer
asset stringrequired
Possible values: non-empty and <= 16 characters
Asset to transfer
iiban stringrequired
Possible values: >= 14 characters and <= 42 characters
Destination (exchange) iiban
fee_info objectnullable
Maximum fee to be used (not needed for fiat)
amount stringrequired
Possible values: non-empty and <= 64 characters, Value must match regular expression ^-?[0-9]+(\.[0-9]+)?$
Max fee amount
asset stringrequired
Possible values: non-empty and <= 16 characters
The asset as ISO x-iso-4217-a3
included booleanrequired
Fee included
level object required
Fee level for the transaction
oneOf
normal
string
Possible values: [normal]
fast
string
Possible values: [fast]
urgent
string
Possible values: [urgent]
quote_id stringrequired
Unique ID for the fee quote
quote_amount stringnullable
Possible values: non-empty and <= 64 characters, Value must match regular expression ^-?[0-9]+(\.[0-9]+)?$
The amount
quote_asset stringnullable
Possible values: non-empty and <= 16 characters
The asset name
quote_amount stringnullable
Possible values: non-empty and <= 64 characters, Value must match regular expression ^-?[0-9]+(\.[0-9]+)?$
The amount
quote_asset stringnullable
Possible values: non-empty and <= 16 characters
The asset name
oneOf
pending
state stringrequired
Possible values: [pending]
approved
state stringrequired
Possible values: [approved]
denied
state stringrequired
Possible values: [denied]
canceled
state stringrequired
Possible values: [canceled]
expired
state stringrequired
Possible values: [expired]
executed
state stringrequired
Possible values: [executed]
result objectnullable
ref_id stringrequired
Funding reference ID
errors object[]nullable
Array [
oneOf
unknown_internal
type stringrequired
Possible values: [unknown_internal]
Unknown internal error
invalid_vault_id
type stringrequired
Possible values: [invalid_vault_id]
Invalid vault id
invalid_approval_id
type stringrequired
Possible values: [invalid_approval_id]
Invalid approval id
invalid_transfer_id
type stringrequired
Possible values: [invalid_transfer_id]
Invalid transfer id
invalid_asset
type stringrequired
Possible values: [invalid_asset]
Invalid asset
invalid_withdrawal_amount
type stringrequired
Possible values: [invalid_withdrawal_amount]
Invalid withdrawal amount
invalid_fee_amount
type stringrequired
Possible values: [invalid_fee_amount]
Invalid fee amount
negative_withdrawal_amount
type stringrequired
Possible values: [negative_withdrawal_amount]
Negative withdrawal amount
vault_not_found
type stringrequired
Possible values: [vault_not_found]
Vault not found
]
failed
state stringrequired
Possible values: [failed]
errors object[]required
Array [
oneOf
unknown_internal
type stringrequired
Possible values: [unknown_internal]
Unknown internal error
invalid_vault_id
type stringrequired
Possible values: [invalid_vault_id]
Invalid vault id
invalid_approval_id
type stringrequired
Possible values: [invalid_approval_id]
Invalid approval id
invalid_transfer_id
type stringrequired
Possible values: [invalid_transfer_id]
Invalid transfer id
invalid_asset
type stringrequired
Possible values: [invalid_asset]
Invalid asset
invalid_withdrawal_amount
type stringrequired
Possible values: [invalid_withdrawal_amount]
Invalid withdrawal amount
invalid_fee_amount
type stringrequired
Possible values: [invalid_fee_amount]
Invalid fee amount
negative_withdrawal_amount
type stringrequired
Possible values: [negative_withdrawal_amount]
Negative withdrawal amount
vault_not_found
type stringrequired
Possible values: [vault_not_found]
Vault not found
]
update_permission_users
type stringrequired
Possible values: [update_permission_users]
operations object[]required
Possible values: >= 1, <= 50
Array [
oneOf
update_role
type stringrequired
Possible values: [update_role]
Update a role
item objectrequired
user objectrequired
User to be updated
iiban stringrequired
Possible values: >= 14 characters and <= 42 characters
The IIBAN of the user.
full_name stringnullable
The user full name.
email stringnullable
Possible values: non-empty and <= 128 characters, Value must match regular expression ^.+@\S+\.\S+$
The e-mail of the user.
role object required
Role that the user holds in the organization.
oneOf
admin
string
Possible values: [admin]
initiator
string
Possible values: [initiator]
reviewer
string
Possible values: [reviewer]
auditor
string
Possible values: [auditor]
reason stringnullable
Possible values: <= 1024 characters
User facing Reason
role object required
The new role
oneOf
admin
string
Possible values: [admin]
initiator
string
Possible values: [initiator]
reviewer
string
Possible values: [reviewer]
auditor
string
Possible values: [auditor]
assign_attribute
type stringrequired
Possible values: [assign_attribute]
Assign an attribute
item objectrequired
User operation with extra fields
user objectrequired
User to be updated
iiban stringrequired
Possible values: >= 14 characters and <= 42 characters
The IIBAN of the user.
full_name stringnullable
The user full name.
email stringnullable
Possible values: non-empty and <= 128 characters, Value must match regular expression ^.+@\S+\.\S+$
The e-mail of the user.
role object required
Role that the user holds in the organization.
oneOf
admin
string
Possible values: [admin]
initiator
string
Possible values: [initiator]
reviewer
string
Possible values: [reviewer]
auditor
string
Possible values: [auditor]
reason stringnullable
Possible values: <= 1024 characters
User facing Reason
attribute object required
Custody user attribute
oneOf
otc_trader
string
Possible values: [otc_trader]
staker
string
Possible values: [staker]
revoke_attribute
type stringrequired
Possible values: [revoke_attribute]
Revoke an attribute
item objectrequired
User operation with extra fields
user objectrequired
User to be updated
iiban stringrequired
Possible values: >= 14 characters and <= 42 characters
The IIBAN of the user.
full_name stringnullable
The user full name.
email stringnullable
Possible values: non-empty and <= 128 characters, Value must match regular expression ^.+@\S+\.\S+$
The e-mail of the user.
role object required
Role that the user holds in the organization.
oneOf
admin
string
Possible values: [admin]
initiator
string
Possible values: [initiator]
reviewer
string
Possible values: [reviewer]
auditor
string
Possible values: [auditor]
reason stringnullable
Possible values: <= 1024 characters
User facing Reason
attribute object required
Custody user attribute
oneOf
otc_trader
string
Possible values: [otc_trader]
staker
string
Possible values: [staker]
]
oneOf
pending
state stringrequired
Possible values: [pending]
approved
state stringrequired
Possible values: [approved]
denied
state stringrequired
Possible values: [denied]
canceled
state stringrequired
Possible values: [canceled]
expired
state stringrequired
Possible values: [expired]
executed
state stringrequired
Possible values: [executed]
errors object[]nullable
Array [
oneOf
unknown_internal
type stringrequired
Possible values: [unknown_internal]
Unknown internal error
user_not_found
type stringrequired
Possible values: [user_not_found]
User not found
invalid_role
type stringrequired
Possible values: [invalid_role]
Invalid role
auditor_in_vault
type stringrequired
Possible values: [auditor_in_vault]
Auditor cannot be member of a vault
quorum_locking_operation
type stringrequired
Possible values: [quorum_locking_operation]
The user cannot be removed because it would lock the minimum quorum
]
failed
state stringrequired
Possible values: [failed]
errors object[]required
Array [
oneOf
unknown_internal
type stringrequired
Possible values: [unknown_internal]
Unknown internal error
user_not_found
type stringrequired
Possible values: [user_not_found]
User not found
invalid_role
type stringrequired
Possible values: [invalid_role]
Invalid role
auditor_in_vault
type stringrequired
Possible values: [auditor_in_vault]
Auditor cannot be member of a vault
quorum_locking_operation
type stringrequired
Possible values: [quorum_locking_operation]
The user cannot be removed because it would lock the minimum quorum
]
create_api_users
type stringrequired
Possible values: [create_api_users]
operations object[]required
Possible values: >= 1, <= 50
Array [
oneOf
add
type stringrequired
Possible values: [add]
Create an API key user
item objectrequired
attributes object[]nullable
Array [
oneOf
otc_trader
string
Possible values: [otc_trader]
staker
string
Possible values: [staker]
]
role object required
Role of the API key
oneOf
admin
string
Possible values: [admin]
initiator
string
Possible values: [initiator]
reviewer
string
Possible values: [reviewer]
auditor
string
Possible values: [auditor]
name stringrequired
Possible values: >= 2 characters and <= 32 characters
Name of the API key
ip_allowlist string[]nullable
Possible values: Value must match regular expression ^((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}))?$)
Optional network IP allow list
valid_until UnixTimestamp (string)nullable
Possible values: <= 13 characters
Optional validity end timestamp
vaults string[]nullable
Possible values: >= 14 characters and <= 14 characters, Value must match regular expression ^V[A-Z2-7]{12}[ACEGIKMOQSUWY246]$
Vault membership
]
oneOf
pending
state stringrequired
Possible values: [pending]
approved
state stringrequired
Possible values: [approved]
denied
state stringrequired
Possible values: [denied]
canceled
state stringrequired
Possible values: [canceled]
expired
state stringrequired
Possible values: [expired]
executed
state stringrequired
Possible values: [executed]
result objectnullable
users object[]required
Created users
Array [
iiban stringrequired
Possible values: >= 14 characters and <= 42 characters
IBAN
role object required
oneOf
admin
string
Possible values: [admin]
initiator
string
Possible values: [initiator]
reviewer
string
Possible values: [reviewer]
auditor
string
Possible values: [auditor]
attributes object[]
Array [
oneOf
otc_trader
string
Possible values: [otc_trader]
staker
string
Possible values: [staker]
]
]
errors object[]nullable
Array [
oneOf
unknown_internal
type stringrequired
Possible values: [unknown_internal]
Unknown internal error
role_not_found
type stringrequired
Possible values: [role_not_found]
Role not found
org_limit_custody_api_users_exceeded
type stringrequired
Possible values: [org_limit_custody_api_users_exceeded]
Limit of custody API key users has been reached for the current organization
organization_not_found
type stringrequired
Possible values: [organization_not_found]
Organization not found
domain_not_found
type stringrequired
Possible values: [domain_not_found]
No error information available
invalid_arguments
type stringrequired
Possible values: [invalid_arguments]
Invalid arguments
master_account_does_not_have_a_full_name
type stringrequired
Possible values: [master_account_does_not_have_a_full_name]
Master account does not have a full name
auditor_in_vault
type stringrequired
Possible values: [auditor_in_vault]
Auditor cannot be member of a vault
]
failed
state stringrequired
Possible values: [failed]
errors object[]required
Array [
oneOf
unknown_internal
type stringrequired
Possible values: [unknown_internal]
Unknown internal error
role_not_found
type stringrequired
Possible values: [role_not_found]
Role not found
org_limit_custody_api_users_exceeded
type stringrequired
Possible values: [org_limit_custody_api_users_exceeded]
Limit of custody API key users has been reached for the current organization
organization_not_found
type stringrequired
Possible values: [organization_not_found]
Organization not found
domain_not_found
type stringrequired
Possible values: [domain_not_found]
No error information available
invalid_arguments
type stringrequired
Possible values: [invalid_arguments]
Invalid arguments
master_account_does_not_have_a_full_name
type stringrequired
Possible values: [master_account_does_not_have_a_full_name]
Master account does not have a full name
auditor_in_vault
type stringrequired
Possible values: [auditor_in_vault]
Auditor cannot be member of a vault
]
update_api_users
type stringrequired
Possible values: [update_api_users]
operations object[]required
Possible values: >= 1, <= 50
Array [
oneOf
update_user
type stringrequired
Possible values: [update_user]
Update an API key user
item objectrequired
ip_allowlist string[]nullable
Possible values: Value must match regular expression ^((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}))?$)
Network IP allow list
valid_until UnixTimestamp (string)nullable
Possible values: <= 13 characters
Validity end timestamp
user objectrequired
Abridged custody user info object
iiban stringrequired
Possible values: >= 14 characters and <= 42 characters
The IIBAN of the user.
full_name stringnullable
The user full name.
email stringnullable
Possible values: non-empty and <= 128 characters, Value must match regular expression ^.+@\S+\.\S+$
The e-mail of the user.
role object required
Role that the user holds in the organization.
oneOf
admin
string
Possible values: [admin]
initiator
string
Possible values: [initiator]
reviewer
string
Possible values: [reviewer]
auditor
string
Possible values: [auditor]
update_role
type stringrequired
Possible values: [update_role]
Update permissions of a user
item objectrequired
user objectrequired
User to be updated
iiban stringrequired
Possible values: >= 14 characters and <= 42 characters
The IIBAN of the user.
full_name stringnullable
The user full name.
email stringnullable
Possible values: non-empty and <= 128 characters, Value must match regular expression ^.+@\S+\.\S+$
The e-mail of the user.
role object required
Role that the user holds in the organization.
oneOf
admin
string
Possible values: [admin]
initiator
string
Possible values: [initiator]
reviewer
string
Possible values: [reviewer]
auditor
string
Possible values: [auditor]
reason stringnullable
Possible values: <= 1024 characters
User facing Reason
role object required
The new role
oneOf
admin
string
Possible values: [admin]
initiator
string
Possible values: [initiator]
reviewer
string
Possible values: [reviewer]
auditor
string
Possible values: [auditor]
assign_attribute
type stringrequired
Possible values: [assign_attribute]
Add an attribute to a user
item objectrequired
User operation with extra fields
user objectrequired
User to be updated
iiban stringrequired
Possible values: >= 14 characters and <= 42 characters
The IIBAN of the user.
full_name stringnullable
The user full name.
email stringnullable
Possible values: non-empty and <= 128 characters, Value must match regular expression ^.+@\S+\.\S+$
The e-mail of the user.
role object required
Role that the user holds in the organization.
oneOf
admin
string
Possible values: [admin]
initiator
string
Possible values: [initiator]
reviewer
string
Possible values: [reviewer]
auditor
string
Possible values: [auditor]
reason stringnullable
Possible values: <= 1024 characters
User facing Reason
attribute object required
Custody user attribute
oneOf
otc_trader
string
Possible values: [otc_trader]
staker
string
Possible values: [staker]
revoke_attribute
type stringrequired
Possible values: [revoke_attribute]
Remove an attribute of a user
item objectrequired
User operation with extra fields
user objectrequired
User to be updated
iiban stringrequired
Possible values: >= 14 characters and <= 42 characters
The IIBAN of the user.
full_name stringnullable
The user full name.
email stringnullable
Possible values: non-empty and <= 128 characters, Value must match regular expression ^.+@\S+\.\S+$
The e-mail of the user.
role object required
Role that the user holds in the organization.
oneOf
admin
string
Possible values: [admin]
initiator
string
Possible values: [initiator]
reviewer
string
Possible values: [reviewer]
auditor
string
Possible values: [auditor]
reason stringnullable
Possible values: <= 1024 characters
User facing Reason
attribute object required
Custody user attribute
oneOf
otc_trader
string
Possible values: [otc_trader]
staker
string
Possible values: [staker]
add_vault
type stringrequired
Possible values: [add_vault]
Add a user to a vault
item objectrequired
User operation with extra fields
user objectrequired
User to be updated
iiban stringrequired
Possible values: >= 14 characters and <= 42 characters
The IIBAN of the user.
full_name stringnullable
The user full name.
email stringnullable
Possible values: non-empty and <= 128 characters, Value must match regular expression ^.+@\S+\.\S+$
The e-mail of the user.
role object required
Role that the user holds in the organization.
oneOf
admin
string
Possible values: [admin]
initiator
string
Possible values: [initiator]
reviewer
string
Possible values: [reviewer]
auditor
string
Possible values: [auditor]
reason stringnullable
Possible values: <= 1024 characters
User facing Reason
vault objectrequired
Vault details
id stringrequired
Possible values: >= 14 characters and <= 14 characters, Value must match regular expression ^V[A-Z2-7]{12}[ACEGIKMOQSUWY246]$
Vault id
iiban stringnullable
Possible values: >= 14 characters and <= 42 characters
Vault iban
name stringnullable
Possible values: non-empty and <= 32 characters, Value must match regular expression ^[a-zA-Z0-9\s\/-]+$
Vault name
remove_vault
type stringrequired
Possible values: [remove_vault]
Remove a user to a vault
item objectrequired
User operation with extra fields
user objectrequired
User to be updated
iiban stringrequired
Possible values: >= 14 characters and <= 42 characters
The IIBAN of the user.
full_name stringnullable
The user full name.
email stringnullable
Possible values: non-empty and <= 128 characters, Value must match regular expression ^.+@\S+\.\S+$
The e-mail of the user.
role object required
Role that the user holds in the organization.
oneOf
admin
string
Possible values: [admin]
initiator
string
Possible values: [initiator]
reviewer
string
Possible values: [reviewer]
auditor
string
Possible values: [auditor]
reason stringnullable
Possible values: <= 1024 characters
User facing Reason
vault objectrequired
Vault details
id stringrequired
Possible values: >= 14 characters and <= 14 characters, Value must match regular expression ^V[A-Z2-7]{12}[ACEGIKMOQSUWY246]$
Vault id
iiban stringnullable
Possible values: >= 14 characters and <= 42 characters
Vault iban
name stringnullable
Possible values: non-empty and <= 32 characters, Value must match regular expression ^[a-zA-Z0-9\s\/-]+$
Vault name
]
oneOf
pending
state stringrequired
Possible values: [pending]
approved
state stringrequired
Possible values: [approved]
denied
state stringrequired
Possible values: [denied]
canceled
state stringrequired
Possible values: [canceled]
expired
state stringrequired
Possible values: [expired]
executed
state stringrequired
Possible values: [executed]
errors object[]nullable
Array [
oneOf
unknown_internal
type stringrequired
Possible values: [unknown_internal]
Unknown internal error
role_not_found
type stringrequired
Possible values: [role_not_found]
Role not found
]
failed
state stringrequired
Possible values: [failed]
errors object[]required
Array [
oneOf
unknown_internal
type stringrequired
Possible values: [unknown_internal]
Unknown internal error
role_not_found
type stringrequired
Possible values: [role_not_found]
Role not found
]
update_vaults_users
type stringrequired
Possible values: [update_vaults_users]
operations object[]required
Possible values: >= 1, <= 50
Array [
oneOf
add
type stringrequired
Possible values: [add]
item objectrequired
User operation with extra fields
user objectrequired
User to be updated
iiban stringrequired
Possible values: >= 14 characters and <= 42 characters
The IIBAN of the user.
full_name stringnullable
The user full name.
email stringnullable
Possible values: non-empty and <= 128 characters, Value must match regular expression ^.+@\S+\.\S+$
The e-mail of the user.
role object required
Role that the user holds in the organization.
oneOf
admin
string
Possible values: [admin]
initiator
string
Possible values: [initiator]
reviewer
string
Possible values: [reviewer]
auditor
string
Possible values: [auditor]
reason stringnullable
Possible values: <= 1024 characters
User facing Reason
vault_id stringrequired
Possible values: >= 14 characters and <= 14 characters, Value must match regular expression ^V[A-Z2-7]{12}[ACEGIKMOQSUWY246]$
remove
type stringrequired
Possible values: [remove]
item objectrequired
User operation with extra fields
user objectrequired
User to be updated
iiban stringrequired
Possible values: >= 14 characters and <= 42 characters
The IIBAN of the user.
full_name stringnullable
The user full name.
email stringnullable
Possible values: non-empty and <= 128 characters, Value must match regular expression ^.+@\S+\.\S+$
The e-mail of the user.
role object required
Role that the user holds in the organization.
oneOf
admin
string
Possible values: [admin]
initiator
string
Possible values: [initiator]
reviewer
string
Possible values: [reviewer]
auditor
string
Possible values: [auditor]
reason stringnullable
Possible values: <= 1024 characters
User facing Reason
vault_id stringrequired
Possible values: >= 14 characters and <= 14 characters, Value must match regular expression ^V[A-Z2-7]{12}[ACEGIKMOQSUWY246]$
]
oneOf
pending
state stringrequired
Possible values: [pending]
approved
state stringrequired
Possible values: [approved]
denied
state stringrequired
Possible values: [denied]
canceled
state stringrequired
Possible values: [canceled]
expired
state stringrequired
Possible values: [expired]
executed
state stringrequired
Possible values: [executed]
errors object[]nullable
Array [
oneOf
unknown_internal
type stringrequired
Possible values: [unknown_internal]
Unknown internal error
vault_not_found
type stringrequired
Possible values: [vault_not_found]
Vault not found
invalid_vault_id
type stringrequired
Possible values: [invalid_vault_id]
Invalid vault id
group_not_found
type stringrequired
Possible values: [group_not_found]
Group not found
user_not_found
type stringrequired
Possible values: [user_not_found]
User not found
invalid_role
type stringrequired
Possible values: [invalid_role]
Invalid role
users_from_different_domains
type stringrequired
Possible values: [users_from_different_domains]
The requested operations contains users from different domains
auditor_in_vault
type stringrequired
Possible values: [auditor_in_vault]
Auditor cannot be member of a vault
update_vault_users_multiple_times
type stringrequired
Possible values: [update_vault_users_multiple_times]
Vault user updated multiple times in the bulk operation
permission_denied
type stringrequired
Possible values: [permission_denied]
Permission denied
]
failed
state stringrequired
Possible values: [failed]
errors object[]required
Array [
oneOf
unknown_internal
type stringrequired
Possible values: [unknown_internal]
Unknown internal error
vault_not_found
type stringrequired
Possible values: [vault_not_found]
Vault not found
invalid_vault_id
type stringrequired
Possible values: [invalid_vault_id]
Invalid vault id
group_not_found
type stringrequired
Possible values: [group_not_found]
Group not found
user_not_found
type stringrequired
Possible values: [user_not_found]
User not found
invalid_role
type stringrequired
Possible values: [invalid_role]
Invalid role
users_from_different_domains
type stringrequired
Possible values: [users_from_different_domains]
The requested operations contains users from different domains
auditor_in_vault
type stringrequired
Possible values: [auditor_in_vault]
Auditor cannot be member of a vault
update_vault_users_multiple_times
type stringrequired
Possible values: [update_vault_users_multiple_times]
Vault user updated multiple times in the bulk operation
permission_denied
type stringrequired
Possible values: [permission_denied]
Permission denied
]
request_allocation
type stringrequired
Possible values: [request_allocation]
vault_info objectrequired
Vault information
id stringrequired
Possible values: >= 14 characters and <= 14 characters, Value must match regular expression ^V[A-Z2-7]{12}[ACEGIKMOQSUWY246]$
Vault ID
name stringrequired
Possible values: non-empty and <= 32 characters, Value must match regular expression ^[a-zA-Z0-9\s\/-]+$
Vault name
status object required
Vault status
oneOf
pending
string
Possible values: [pending]
created
string
Possible values: [created]
failed
string
Possible values: [failed]
disabled
string
Possible values: [disabled]
payload objectrequired
fee_info objectrequired
Fee information
quote_id stringrequired
Possible values: >= 20 characters and <= 20 characters, Value must match regular expression ^QT[A-Z2-7]{5}-[A-Z2-7]{5}-[A-Z2-7]{6}$
Fee id chosen by the user
level object required
Fee level chosen by the user
oneOf
normal
string
Possible values: [normal]
fast
string
Possible values: [fast]
urgent
string
Possible values: [urgent]
asset stringrequired
Possible values: non-empty and <= 16 characters
The asset name
amount stringrequired
An amount as a string
quote_amount stringnullable
Possible values: non-empty and <= 64 characters, Value must match regular expression ^-?[0-9]+(\.[0-9]+)?$
The amount
quote_asset stringnullable
Possible values: non-empty and <= 16 characters
The asset name
provider stringrequired
Staking provider
bonding_period int64nullable
Estimated bonding period
unbonding_period int64nullable
Estimated unbonding period for deallocation
asset stringrequired
Possible values: non-empty and <= 16 characters
The asset name
amount stringrequired
An amount as a string
quote_amount stringnullable
Possible values: non-empty and <= 64 characters, Value must match regular expression ^-?[0-9]+(\.[0-9]+)?$
The amount
quote_asset stringnullable
Possible values: non-empty and <= 16 characters
The asset name
oneOf
pending
state stringrequired
Possible values: [pending]
approved
state stringrequired
Possible values: [approved]
denied
state stringrequired
Possible values: [denied]
canceled
state stringrequired
Possible values: [canceled]
expired
state stringrequired
Possible values: [expired]
executed
state stringrequired
Possible values: [executed]
result objectnullable
fee_info objectrequired
The actual fee paid on chain.
asset stringrequired
Possible values: non-empty and <= 16 characters
The asset name
amount stringrequired
An amount as a string
quote_amount stringnullable
Possible values: non-empty and <= 64 characters, Value must match regular expression ^-?[0-9]+(\.[0-9]+)?$
The amount
quote_asset stringnullable
Possible values: non-empty and <= 16 characters
The asset name
validators string[]required
Validator nodes that got provisioned
earn_tx_id stringrequired
Earn transaction id
bonding_period int64nullable
Bonding period
errors object[]nullable
Array [
oneOf
unknown_internal
type stringrequired
Possible values: [unknown_internal]
Unknown internal error
internal_error
type stringrequired
Possible values: [internal_error]
Custom Error
]
failed
state stringrequired
Possible values: [failed]
errors object[]required
Array [
oneOf
unknown_internal
type stringrequired
Possible values: [unknown_internal]
Unknown internal error
internal_error
type stringrequired
Possible values: [internal_error]
Custom Error
]
request_deallocation
type stringrequired
Possible values: [request_deallocation]
vault_info objectrequired
Vault information
id stringrequired
Possible values: >= 14 characters and <= 14 characters, Value must match regular expression ^V[A-Z2-7]{12}[ACEGIKMOQSUWY246]$
Vault ID
name stringrequired
Possible values: non-empty and <= 32 characters, Value must match regular expression ^[a-zA-Z0-9\s\/-]+$
Vault name
status object required
Vault status
oneOf
pending
string
Possible values: [pending]
created
string
Possible values: [created]
failed
string
Possible values: [failed]
disabled
string
Possible values: [disabled]
payload objectrequired
provider stringrequired
Staking provider
unbonding_period int64nullable
Estimated unbonding period
asset stringrequired
Possible values: non-empty and <= 16 characters
The asset name
amount stringrequired
An amount as a string
quote_amount stringnullable
Possible values: non-empty and <= 64 characters, Value must match regular expression ^-?[0-9]+(\.[0-9]+)?$
The amount
quote_asset stringnullable
Possible values: non-empty and <= 16 characters
The asset name
oneOf
pending
state stringrequired
Possible values: [pending]
approved
state stringrequired
Possible values: [approved]
denied
state stringrequired
Possible values: [denied]
canceled
state stringrequired
Possible values: [canceled]
expired
state stringrequired
Possible values: [expired]
executed
state stringrequired
Possible values: [executed]
result objectnullable
validators string[]required
Validator nodes that got provisioned
earn_tx_id stringrequired
Earn transaction id
unbonding_period int64nullable
Unbonding period
errors object[]nullable
Array [
oneOf
unknown_internal
type stringrequired
Possible values: [unknown_internal]
Unknown internal error
]
failed
state stringrequired
Possible values: [failed]
errors object[]required
Array [
oneOf
unknown_internal
type stringrequired
Possible values: [unknown_internal]
Unknown internal error
]
errors object[]required
Array [
severity stringrequired
Possible values: [E, W]
API error severity.
errorClass stringrequired
type stringrequired
errorMessage stringnullable
]

Example (from schema)

{
  "errors": [
    {
      "severity": "E",
      "errorClass": "string",
      "type": "string",
      "errorMessage": "string"
    }
  ]
}

Loading...