Skip to main content

Get task by id

POST 
https://api.kraken.com/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

Body

    nonce int64required

    Nonce used in construction of API-Sign header

Responses​

Schema
    result object nullable

    Mapped action type for returning to clients with dynamic information like VaultInfo

    oneOf
    type stringrequired

    Possible values: [update_group_users]

    operations object[]required

    Possible values: >= 1, <= 50

  • Array [
    • oneOf
    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

    string

    Possible values: [admin]

    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
    state stringrequired

    Possible values: [pending]

    errors object[]required
  • Array [
    • severity stringrequired

    Possible values: [E, W]

    API error severity.

    errorClass stringrequired
    type stringrequired
    errorMessage stringnullable
  • ]

Authorization: API-Key

name: API-Keytype: apiKeydescription: The "API-Key" header should contain your API key.in: header
name: API-Signtype: apiKeydescription: Authenticated requests should be signed with the "API-Sign" header, using a signature generated with your private key, nonce, encoded payload, and URI path.in: header
curl -L 'https://api.kraken.com/0/private/GetCustodyTask' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'API-Key: <API_KEY_VALUE>' \
-H 'API-Sign: <API_KEY_VALUE>' \
-d '{
  "nonce": 0
}'
Request Collapse all
Base URL
https://api.kraken.com
Auth
Parameters
— queryrequired
Body
{
  "nonce": 0
}