List tasks

POST 
/0/private/ListCustodyTasks

Retrieve review tasks that match the specified filter criteria.

Request

application/json

Body

required

nonce int64required

Nonce used in construction of API-Sign header

filters object
Specify a subset of filter items. All filter objects are AND combined. Inside a filter object all properties are OR combined.
oneOf
and
and object[]required
Array [
oneOf
or
or object[]required
Array [
oneOf
id
oneOf
equals
type stringrequired
Possible values: [equals]
values string[]required
Possible values: >= 14 characters and <= 14 characters, Value must match regular expression ^T[A-Z2-7]{12}[ACEGIKMOQSUWY246]$
Exact values to match against
by stringrequired
Possible values: [id]
approval_id
oneOf
equals
type stringrequired
Possible values: [equals]
values string[]required
Exact values to match against
by stringrequired
Possible values: [approval_id]
vault_id
oneOf
equals
type stringrequired
Possible values: [equals]
values string[]required
Possible values: >= 14 characters and <= 14 characters, Value must match regular expression ^V[A-Z2-7]{12}[ACEGIKMOQSUWY246]$
Exact values to match against
by stringrequired
Possible values: [vault_id]
scope
oneOf
equals
type stringrequired
Possible values: [equals]
values object[]required
Exact values to match against
Array [
oneOf
domain
string
Possible values: [domain]
vault
string
Possible values: [vault]
]
by stringrequired
Possible values: [scope]
state
oneOf
equals
type stringrequired
Possible values: [equals]
values object[]required
Exact values to match against
Array [
oneOf
pending
string
Possible values: [pending]
approved
string
Possible values: [approved]
denied
string
Possible values: [denied]
canceled
string
Possible values: [canceled]
expired
string
Possible values: [expired]
executed
string
Possible values: [executed]
failed
string
Possible values: [failed]
]
by stringrequired
Possible values: [state]
action
oneOf
equals
type stringrequired
Possible values: [equals]
values object[]required
Exact values to match against
Array [
oneOf
update_withdrawal_addresses
string
Possible values: [update_withdrawal_addresses]
request_withdrawal
string
Possible values: [request_withdrawal]
create_vault
string
Possible values: [create_vault]
update_group_users
string
Possible values: [update_group_users]
update_role_users
string
Possible values: [update_role_users]
update_vault_users
string
Possible values: [update_vault_users]
update_domain_policies
string
Possible values: [update_domain_policies]
update_vault_policies
string
Possible values: [update_vault_policies]
create_users
string
Possible values: [create_users]
update_vault
string
Possible values: [update_vault]
update_status_users
string
Possible values: [update_status_users]
request_transfer_to_spot
string
Possible values: [request_transfer_to_spot]
create_group
string
Possible values: [create_group]
update_permission_users
string
Possible values: [update_permission_users]
create_api_users
string
Possible values: [create_api_users]
update_api_users
string
Possible values: [update_api_users]
update_vaults_users
string
Possible values: [update_vaults_users]
request_allocation
string
Possible values: [request_allocation]
request_deallocation
string
Possible values: [request_deallocation]
]
by stringrequired
Possible values: [action]
created_at
oneOf
equals
type stringrequired
Possible values: [equals]
values UnixTimestamp (string)[]required
Possible values: <= 13 characters
by stringrequired
Possible values: [created_at]
in
type stringrequired
Possible values: [in]
left UnixTimestamp (string)nullable
Possible values: <= 13 characters
Unix timestamp in seconds
right UnixTimestamp (string)nullable
Possible values: <= 13 characters
Unix timestamp in seconds
by stringrequired
Possible values: [created_at]
updated_at
oneOf
equals
type stringrequired
Possible values: [equals]
values UnixTimestamp (string)[]required
Possible values: <= 13 characters
by stringrequired
Possible values: [updated_at]
in
type stringrequired
Possible values: [in]
left UnixTimestamp (string)nullable
Possible values: <= 13 characters
Unix timestamp in seconds
right UnixTimestamp (string)nullable
Possible values: <= 13 characters
Unix timestamp in seconds
by stringrequired
Possible values: [updated_at]
expires_at
oneOf
equals
type stringrequired
Possible values: [equals]
values UnixTimestamp (string)[]required
Possible values: <= 13 characters
by stringrequired
Possible values: [expires_at]
in
type stringrequired
Possible values: [in]
left UnixTimestamp (string)nullable
Possible values: <= 13 characters
Unix timestamp in seconds
right UnixTimestamp (string)nullable
Possible values: <= 13 characters
Unix timestamp in seconds
by stringrequired
Possible values: [expires_at]
current_user_decision
oneOf
equals
type stringrequired
Possible values: [equals]
values object[]required
Exact values to match against
Array [
oneOf
approved
string
Possible values: [approved]
denied
string
Possible values: [denied]
undecided
string
Possible values: [undecided]
]
by stringrequired
Possible values: [current_user_decision]
]
]
pagination object

Define which items will get returned

limit uint32required

Possible values: >= 1 and <= 1000

Number of records to retrieve

offset uint32required

Result Offset

orderings object[]
Specify how to order the returned items. If a column in the orderings list contains null values, these are always sorted to the end.
Array [
by required
Possible values: [id, vault_id, state, created_at, updated_at, expires_at]
Column to order by
• id: Order by task ID
• vault_id: Order by vault ID
• state: Order by task's current state
• created_at: Order by task creation date
• updated_at: Order by task last updated date
• expires_at: Order by task expiration date
direction orderDirection (string)
Possible values: [asc, desc]
Default value: desc
Ordering direction
• asc: Return items in ascending order (first to last)
• desc: Return items in descending order (last to first)
]

Responses

200

application/json

Schema

Schema

result object[]nullable
Array [
can_review booleanrequired
Whether the current user can review the task
reviewer_statistics objectrequired
Reviewers statistics
current_count uint32required
Current number of total available reviewers
approved uint32required
Number of approved reviews
denied uint32required
Number of denied reviews
undecided uint32required
Number of pending reviews
current_user_decision object required
Task review status
oneOf
approved
string
Possible values: [approved]
denied
string
Possible values: [denied]
undecided
string
Possible values: [undecided]
id stringrequired
Possible values: >= 14 characters and <= 14 characters, Value must match regular expression ^T[A-Z2-7]{12}[ACEGIKMOQSUWY246]$
Task ID
approval_id stringrequired
Approval ID
created_at UnixTimestamp (string)required
Possible values: <= 13 characters
Creation time
updated_at UnixTimestamp (string)required
Possible values: <= 13 characters
Update time
expires_at UnixTimestamp (string)required
Possible values: <= 13 characters
Task expiration time
initiator objectrequired
Task initiator
full_name stringnullable
User full name
role object nullable
User role
oneOf
admin
string
Possible values: [admin]
initiator
string
Possible values: [initiator]
reviewer
string
Possible values: [reviewer]
auditor
string
Possible values: [auditor]
ip_address stringnullable
User IP address
iiban stringnullable
Possible values: >= 14 characters and <= 42 characters
User IIBAN
]
errors object[]required
Array [
severity stringrequired
Possible values: [E, W]
API error severity.
errorClass stringrequired
type stringrequired
errorMessage stringnullable
]
start uint64required
total uint64required

Example (from schema)

{
  "result": [
    {
      "id": "TDO2CDW6GMSZHC",
      "approval_id": "550e8400-e29b-41d4-a716-446655440000",
      "type": "update_domain_policies",
      "state": "pending",
      "operations": [
        {
          "type": "update",
          "item": {
            "type": "required_approvals",
            "required": 3
          }
        }
      ],
      "created_at": "1710877454",
      "updated_at": "1710877454",
      "expires_at": "1710877454",
      "initiator": {
        "full_name": "Alice Wonderland",
        "role": "reviewer",
        "ip_address": "2.3.4.5",
        "iiban": "AA88 N84G AET3 RAOA"
      },
      "can_review": false,
      "reviewer_statistics": {
        "current_count": 2,
        "approved": 3,
        "denied": 0,
        "undecided": 2
      },
      "current_user_decision": "approved"
    },
    {
      "id": "TDO2CDW6GMSZHC",
      "approval_id": "550e8400-e29b-41d4-a716-446655440000",
      "type": "update_vault_policies",
      "state": "pending",
      "vault_info": {
        "id": "VW44KPQC4C62K6",
        "name": "My Vault",
        "status": "created"
      },
      "operations": [
        {
          "type": "update",
          "item": {
            "type": "max_transaction_amount",
            "amount": "1000.0000"
          }
        },
        {
          "type": "update",
          "item": {
            "type": "required_approvals",
            "required": 3
          }
        }
      ],
      "created_at": "1710877454",
      "updated_at": "1710877454",
      "expires_at": "1710877454",
      "initiator": {
        "full_name": "Alice Wonderland",
        "role": "reviewer",
        "ip_address": "2.3.4.5",
        "iiban": "AA88 N84G AET3 RAOA"
      },
      "can_review": false,
      "reviewer_statistics": {
        "current_count": 2,
        "approved": 3,
        "denied": 0,
        "undecided": 2
      },
      "current_user_decision": "approved"
    },
    {
      "id": "TDO2CDW6GMSZHC",
      "approval_id": "550e8400-e29b-41d4-a716-446655440000",
      "type": "create_vault",
      "state": "pending",
      "payload": {
        "name": "My Vault 1",
        "description": "My vault description",
        "policies": [
          {
            "type": "max_transaction_amount",
            "amount": "1000.0000"
          },
          {
            "type": "required_approvals",
            "required": 3
          }
        ],
        "withdrawal_addresses": [
          {
            "asset": "BTC",
            "address_name": "My address",
            "method": "Bitcoin (Custody)",
            "info": {
              "address": "2N3oefVeg6stiTb5Kh3ozCSkaqmx91FDbsm"
            },
            "description": "My description"
          }
        ],
        "users": [
          {
            "iiban": "AA88 N84G AET3 RAOA",
            "full_name": "John Doe",
            "email": "myemail@email.com",
            "role": "admin"
          }
        ]
      },
      "created_at": "1710877454",
      "updated_at": "1710877454",
      "expires_at": "1710877454",
      "initiator": {
        "full_name": "Alice Wonderland",
        "role": "reviewer",
        "ip_address": "2.3.4.5",
        "iiban": "AA88 N84G AET3 RAOA"
      },
      "can_review": false,
      "reviewer_statistics": {
        "current_count": 2,
        "approved": 3,
        "denied": 0,
        "undecided": 2
      },
      "current_user_decision": "approved"
    },
    {
      "id": "TDO2CDW6GMSZHC",
      "approval_id": "550e8400-e29b-41d4-a716-446655440000",
      "type": "update_withdrawal_addresses",
      "state": "pending",
      "vault_info": {
        "id": "VW44KPQC4C62K6",
        "name": "My Vault",
        "status": "created"
      },
      "operations": [
        {
          "type": "add",
          "item": {
            "asset": "BTC",
            "address_name": "My BTC address",
            "method": "Bitcoin",
            "info": {
              "address": "3J98t1WpEZ73CNmQviecrnyiWrnqRhWNLy"
            },
            "description": "Withdrawal address description"
          }
        }
      ],
      "created_at": "1710877454",
      "updated_at": "1710877454",
      "expires_at": "1710877454",
      "initiator": {
        "full_name": "Alice Wonderland",
        "role": "reviewer",
        "ip_address": "2.3.4.5",
        "iiban": "AA88 N84G AET3 RAOA"
      },
      "can_review": false,
      "reviewer_statistics": {
        "current_count": 2,
        "approved": 3,
        "denied": 0,
        "undecided": 2
      },
      "current_user_decision": "approved"
    },
    {
      "id": "TDO2CDW6GMSZHC",
      "approval_id": "550e8400-e29b-41d4-a716-446655440000",
      "type": "create_users",
      "state": "pending",
      "operations": [
        {
          "type": "add",
          "item": {
            "email": "myemail@email.com",
            "role": "admin",
            "full_name": {
              "first_name": "John",
              "middle_name": "J.",
              "last_name": "Doe"
            },
            "language": "US-en",
            "timezone": "UTC",
            "attributes": [
              "otc_trader"
            ]
          }
        }
      ],
      "created_at": "1710877454",
      "updated_at": "1710877454",
      "expires_at": "1710877454",
      "initiator": {
        "full_name": "Alice Wonderland",
        "role": "reviewer",
        "ip_address": "2.3.4.5",
        "iiban": "AA88 N84G AET3 RAOA"
      },
      "can_review": false,
      "reviewer_statistics": {
        "current_count": 2,
        "approved": 3,
        "denied": 0,
        "undecided": 2
      },
      "current_user_decision": "approved"
    },
    {
      "id": "TDO2CDW6GMSZHC",
      "approval_id": "550e8400-e29b-41d4-a716-446655440000",
      "type": "request_withdrawal",
      "state": "pending",
      "vault_info": {
        "id": "VW44KPQC4C62K6",
        "name": "My Vault",
        "status": "created"
      },
      "payload": {
        "amount": "1234.00000000",
        "comment": "My comment",
        "address": {
          "asset": "BTC",
          "address_name": "My BTC address",
          "info": {
            "address": "2N19AcihQ1a4MxQW658UFHTioUNnMkiHPkw",
            "beneficiary": {
              "recipient": "Bill",
              "name": "John"
            }
          },
          "description": "My description"
        },
        "fee_info": {
          "amount": "0.12300000",
          "asset": "ETH",
          "included": false,
          "level": "normal",
          "quote_id": "QELGZOTIN5HYWY",
          "quote_amount": "1.12300000",
          "quote_asset": "USD"
        },
        "quote_amount": "1.12300000",
        "quote_asset": "USD"
      },
      "created_at": "1710877454",
      "updated_at": "1710877454",
      "expires_at": "1710877454",
      "initiator": {
        "full_name": "Alice Wonderland",
        "role": "reviewer",
        "ip_address": "2.3.4.5",
        "iiban": "AA88 N84G AET3 RAOA"
      },
      "can_review": false,
      "reviewer_statistics": {
        "current_count": 2,
        "approved": 3,
        "denied": 0,
        "undecided": 2
      },
      "current_user_decision": "approved"
    },
    {
      "id": "TDO2CDW6GMSZHC",
      "approval_id": "550e8400-e29b-41d4-a716-446655440000",
      "type": "update_group_users",
      "state": "pending",
      "operations": [
        {
          "type": "add",
          "item": {
            "user": {
              "iiban": "AA88 N84G AET3 RAOA",
              "full_name": "John Doe",
              "email": "myemail@email.com",
              "role": "admin"
            },
            "reason": "My reason",
            "group_id": "GN2F7NJJWKJHI2"
          }
        }
      ],
      "created_at": "1710877454",
      "updated_at": "1710877454",
      "expires_at": "1710877454",
      "initiator": {
        "full_name": "Alice Wonderland",
        "role": "reviewer",
        "ip_address": "2.3.4.5",
        "iiban": "AA88 N84G AET3 RAOA"
      },
      "can_review": false,
      "reviewer_statistics": {
        "current_count": 2,
        "approved": 3,
        "denied": 0,
        "undecided": 2
      },
      "current_user_decision": "approved"
    }
  ],
  "errors": [
    {
      "severity": "E",
      "errorClass": "string",
      "type": "string",
      "errorMessage": "string"
    }
  ],
  "start": 0,
  "total": 0
}

Loading...