Request

List requests

get

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

pageinteger · min: 1 · max: 9007199254740991Optional

Which page to fetch

Default: 1

pageSizeinteger · min: 1 · max: 30Optional

Page size to use

Default: 30

typeany ofOptional

Search by request type

or

string · enumOptional

Single type

Possible values:

stateany ofOptional

Search by request state

or

string · enumOptional

Single state

Possible values:

targetIdstringOptional

Search by target ID

createdBystringOptional

Search by request creator (user ID or 'me')

reviewedBystringOptional

Search by user who has already reviewed (user ID or 'me')

pendingBystringOptional

Search by user who has a pending review for the request (user ID or 'me')

sortBystring · enumOptional

Sort by attribute

Default: createdAtPossible values:

sortOrderstring · enumOptional

Sort order

Default: ascPossible values:

fromDatestringOptional

Search by createdAt >= this date (inclusive)

toDatestringOptional

Search by createdAt <= this date (inclusive)

supportstring · enumOptional

Filter requests by support

Possible values:

Responses

200

Successful response

application/json

pagenumberRequired

Current page

nextany ofRequired

Next page or null if there is none

numberOptional

or

nullOptional

prevany ofRequired

Previous page or null if there is none

numberOptional

or

nullOptional

pageSizenumberRequired

Max count of items per page

totalnumberRequired

Total count of items

resultsone of[]Required

Array of results

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

400

Invalid input data

application/json

401

Authorization not provided

application/json

403

Insufficient access

application/json

404

Not found

application/json

500

Internal server error

application/json

get

/requests

HTTPcURLJavaScriptPython

GET /v1/rest/requests HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "page": 1,
  "next": 1,
  "prev": 1,
  "pageSize": 1,
  "total": 1,
  "results": [
    {
      "type": "text",
      "data": {
        "quorum": 1
      },
      "id": "text",
      "legacyId": 1,
      "state": "INITIAL",
      "reviewSteps": [
        {
          "stageName": "text",
          "quorum": 1
        }
      ],
      "currentStepIndex": 1,
      "expiresAt": "text",
      "expiredAt": "text",
      "targetId": "text",
      "note": {
        "title": "text",
        "content": "text"
      },
      "reviews": [
        {
          "stepIndex": 1,
          "userId": "text",
          "groupName": "text",
          "status": "PENDING",
          "createdAt": "text",
          "updatedAt": "text"
        }
      ],
      "createdAt": "text",
      "updatedAt": "text",
      "createdById": "text",
      "inflight": {
        "completionState": "INITIAL",
        "retryAfter": "text"
      }
    }
  ]
}

Get a request by ID

get

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Id of the request

Responses

200

Successful response

application/json

Vault request response data

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

400

Invalid input data

application/json

401

Authorization not provided

application/json

403

Insufficient access

application/json

404

Not found

application/json

500

Internal server error

application/json

get

/requests/{id}

HTTPcURLJavaScriptPython

GET /v1/rest/requests/{id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "type": "text",
  "data": {
    "quorum": 1
  },
  "id": "text",
  "legacyId": 1,
  "state": "INITIAL",
  "reviewSteps": [
    {
      "stageName": "text",
      "quorum": 1
    }
  ],
  "currentStepIndex": 1,
  "expiresAt": "text",
  "expiredAt": "text",
  "targetId": "text",
  "note": {
    "title": "text",
    "content": "text"
  },
  "reviews": [
    {
      "stepIndex": 1,
      "userId": "text",
      "groupName": "text",
      "status": "PENDING",
      "createdAt": "text",
      "updatedAt": "text"
    }
  ],
  "createdAt": "text",
  "updatedAt": "text",
  "createdById": "text",
  "inflight": {
    "completionState": "INITIAL",
    "retryAfter": "text"
  }
}

Get the challenge of the specified request for current user

get

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Id of the request

Responses

200

Successful response

application/json

pubKeystringRequired

Public key of the current user

challengeone ofRequired

Challenge data to sign with the user's private key

or

or

400

Invalid input data

application/json

401

Authorization not provided

application/json

403

Insufficient access

application/json

404

Not found

application/json

500

Internal server error

application/json

get

/requests/{id}/challenge

HTTPcURLJavaScriptPython

GET /v1/rest/requests/{id}/challenge HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "pubKey": "text",
  "challenge": {
    "challengeType": "text",
    "wActions": [
      "text"
    ],
    "handshake": "text",
    "handshakeAttestation": {
      "codeHash": "text",
      "attestationPub": "text",
      "certificate": "text",
      "signature": "text"
    },
    "partitionId": "text"
  }
}

Create a Sui transaction request

post

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

Transaction request data

accountIdstring · min: 1Required

Target account id

transactionone ofRequired

or

or

or

Responses

200

Successful response

application/json

Transaction request

typeconst: CREATE_TRANSACTIONRequired

idstringRequired

Request unique identifier

legacyIdnumberRequired

Legacy internal unique identifier (for retro-compatibility)

statestring · enumRequired

Request state

Possible values:

currentStepIndexinteger · max: 9007199254740991Required

Index of the current approval step

expiresAtstringRequired

Request expiration date

expiredAtstringOptional

Deprecated: use expiresAt

targetIdany ofRequired

Optional ID of the target object

stringOptional

or

nullOptional

noteany ofRequired

Optional request note

or

nullOptional

createdAtstringRequired

Creation timestamp

updatedAtstringRequired

Last modification timestamp

createdByIdstringRequired

ID of the user who created the request

400

Invalid input data

application/json

401

Authorization not provided

application/json

403

Insufficient access

application/json

500

Internal server error

application/json

post

/requests/transaction/sui

HTTPcURLJavaScriptPython

POST /v1/rest/requests/transaction/sui HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 190

{
  "accountId": "text",
  "transaction": {
    "amount": "text",
    "currency": "text",
    "maxFee": "text",
    "recipient": "text",
    "type": "text",
    "feeStrategy": {
      "type": "SLOW"
    }
  },
  "note": {
    "title": "text",
    "content": "text"
  }
}

{
  "type": "text",
  "data": {
    "accountId": "text",
    "transaction": {
      "amount": "text",
      "currency": "text",
      "maxFee": "text",
      "recipient": "text",
      "type": "text",
      "feeStrategy": {
        "type": "SLOW"
      }
    }
  },
  "id": "text",
  "legacyId": 1,
  "state": "INITIAL",
  "reviewSteps": [
    {
      "stageName": "text",
      "quorum": 1
    }
  ],
  "currentStepIndex": 1,
  "expiresAt": "text",
  "expiredAt": "text",
  "targetId": "text",
  "note": {
    "title": "text",
    "content": "text"
  },
  "reviews": [
    {
      "stepIndex": 1,
      "userId": "text",
      "groupName": "text",
      "status": "PENDING",
      "createdAt": "text",
      "updatedAt": "text"
    }
  ],
  "createdAt": "text",
  "updatedAt": "text",
  "createdById": "text",
  "inflight": {
    "completionState": "INITIAL",
    "retryAfter": "text"
  }
}

Create an Ethereum transaction request

post

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

Transaction request data

accountIdstring · min: 1Required

Target account id

transactionone ofRequired

or

or

Responses

200

Successful response

application/json

Transaction request

typeconst: CREATE_TRANSACTIONRequired

idstringRequired

Request unique identifier

legacyIdnumberRequired

Legacy internal unique identifier (for retro-compatibility)

statestring · enumRequired

Request state

Possible values:

currentStepIndexinteger · max: 9007199254740991Required

Index of the current approval step

expiresAtstringRequired

Request expiration date

expiredAtstringOptional

Deprecated: use expiresAt

targetIdany ofRequired

Optional ID of the target object

stringOptional

or

nullOptional

noteany ofRequired

Optional request note

or

nullOptional

createdAtstringRequired

Creation timestamp

updatedAtstringRequired

Last modification timestamp

createdByIdstringRequired

ID of the user who created the request

400

Invalid input data

application/json

401

Authorization not provided

application/json

403

Insufficient access

application/json

500

Internal server error

application/json

post

/requests/transaction/ethereum

HTTPcURLJavaScriptPython

POST /v1/rest/requests/transaction/ethereum HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 248

{
  "accountId": "text",
  "transaction": {
    "amount": "text",
    "currency": "text",
    "maxFee": "text",
    "recipient": "text",
    "type": "text",
    "contractData": "text",
    "feeStrategy": {
      "type": "SLOW",
      "gasPrice": "text",
      "gasLimit": "text"
    }
  },
  "note": {
    "title": "text",
    "content": "text"
  }
}

{
  "type": "text",
  "data": {
    "accountId": "text",
    "transaction": {
      "amount": "text",
      "currency": "text",
      "maxFee": "text",
      "recipient": "text",
      "type": "text",
      "contractData": "text",
      "feeStrategy": {
        "type": "SLOW",
        "gasPrice": "text",
        "gasLimit": "text"
      }
    }
  },
  "id": "text",
  "legacyId": 1,
  "state": "INITIAL",
  "reviewSteps": [
    {
      "stageName": "text",
      "quorum": 1
    }
  ],
  "currentStepIndex": 1,
  "expiresAt": "text",
  "expiredAt": "text",
  "targetId": "text",
  "note": {
    "title": "text",
    "content": "text"
  },
  "reviews": [
    {
      "stepIndex": 1,
      "userId": "text",
      "groupName": "text",
      "status": "PENDING",
      "createdAt": "text",
      "updatedAt": "text"
    }
  ],
  "createdAt": "text",
  "updatedAt": "text",
  "createdById": "text",
  "inflight": {
    "completionState": "INITIAL",
    "retryAfter": "text"
  }
}

Create a Hedera transaction request

post

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

Transaction request data

accountIdstring · min: 1Required

Target account id

transactionone ofRequired

or

or

Responses

200

Successful response

application/json

Transaction request

typeconst: CREATE_TRANSACTIONRequired

idstringRequired

Request unique identifier

legacyIdnumberRequired

Legacy internal unique identifier (for retro-compatibility)

statestring · enumRequired

Request state

Possible values:

currentStepIndexinteger · max: 9007199254740991Required

Index of the current approval step

expiresAtstringRequired

Request expiration date

expiredAtstringOptional

Deprecated: use expiresAt

targetIdany ofRequired

Optional ID of the target object

stringOptional

or

nullOptional

noteany ofRequired

Optional request note

or

nullOptional

createdAtstringRequired

Creation timestamp

updatedAtstringRequired

Last modification timestamp

createdByIdstringRequired

ID of the user who created the request

400

Invalid input data

application/json

401

Authorization not provided

application/json

403

Insufficient access

application/json

500

Internal server error

application/json

post

/requests/transaction/hedera

HTTPcURLJavaScriptPython

POST /v1/rest/requests/transaction/hedera HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 190

{
  "accountId": "text",
  "transaction": {
    "amount": "text",
    "currency": "text",
    "maxFee": "text",
    "recipient": "text",
    "type": "text",
    "feeStrategy": {
      "type": "SLOW"
    }
  },
  "note": {
    "title": "text",
    "content": "text"
  }
}

{
  "type": "text",
  "data": {
    "accountId": "text",
    "transaction": {
      "amount": "text",
      "currency": "text",
      "maxFee": "text",
      "recipient": "text",
      "type": "text",
      "feeStrategy": {
        "type": "SLOW"
      }
    }
  },
  "id": "text",
  "legacyId": 1,
  "state": "INITIAL",
  "reviewSteps": [
    {
      "stageName": "text",
      "quorum": 1
    }
  ],
  "currentStepIndex": 1,
  "expiresAt": "text",
  "expiredAt": "text",
  "targetId": "text",
  "note": {
    "title": "text",
    "content": "text"
  },
  "reviews": [
    {
      "stepIndex": 1,
      "userId": "text",
      "groupName": "text",
      "status": "PENDING",
      "createdAt": "text",
      "updatedAt": "text"
    }
  ],
  "createdAt": "text",
  "updatedAt": "text",
  "createdById": "text",
  "inflight": {
    "completionState": "INITIAL",
    "retryAfter": "text"
  }
}

Create a Canton transaction request

post

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

Transaction request data

accountIdstring · min: 1Required

Target account id

transactionone ofRequired

or

or

or

or

Responses

200

Successful response

application/json

Transaction request

typeconst: CREATE_TRANSACTIONRequired

idstringRequired

Request unique identifier

legacyIdnumberRequired

Legacy internal unique identifier (for retro-compatibility)

statestring · enumRequired

Request state

Possible values:

currentStepIndexinteger · max: 9007199254740991Required

Index of the current approval step

expiresAtstringRequired

Request expiration date

expiredAtstringOptional

Deprecated: use expiresAt

targetIdany ofRequired

Optional ID of the target object

stringOptional

or

nullOptional

noteany ofRequired

Optional request note

or

nullOptional

createdAtstringRequired

Creation timestamp

updatedAtstringRequired

Last modification timestamp

createdByIdstringRequired

ID of the user who created the request

400

Invalid input data

application/json

401

Authorization not provided

application/json

403

Insufficient access

application/json

500

Internal server error

application/json

post

/requests/transaction/canton

HTTPcURLJavaScriptPython

POST /v1/rest/requests/transaction/canton HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 185

{
  "accountId": "text",
  "transaction": {
    "amount": "text",
    "currency": "text",
    "recipient": "text",
    "executeBeforeSeconds": 1,
    "reason": "text",
    "type": "text"
  },
  "note": {
    "title": "text",
    "content": "text"
  }
}

{
  "type": "text",
  "data": {
    "accountId": "text",
    "transaction": {
      "amount": "text",
      "currency": "text",
      "recipient": "text",
      "executeBeforeSeconds": 1,
      "reason": "text",
      "type": "text"
    }
  },
  "id": "text",
  "legacyId": 1,
  "state": "INITIAL",
  "reviewSteps": [
    {
      "stageName": "text",
      "quorum": 1
    }
  ],
  "currentStepIndex": 1,
  "expiresAt": "text",
  "expiredAt": "text",
  "targetId": "text",
  "note": {
    "title": "text",
    "content": "text"
  },
  "reviews": [
    {
      "stepIndex": 1,
      "userId": "text",
      "groupName": "text",
      "status": "PENDING",
      "createdAt": "text",
      "updatedAt": "text"
    }
  ],
  "createdAt": "text",
  "updatedAt": "text",
  "createdById": "text",
  "inflight": {
    "completionState": "INITIAL",
    "retryAfter": "text"
  }
}

Create an account

post

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

Create account request data (for API admin only)

namestring · min: 1 · max: 40Required

Account name

currencystring · min: 1 · max: 40Required

Will be deprecated soon, use network instead. Currency

Pattern: ^\w+$

indexnumberOptional

Account index

contractAddressany ofRequired

Token issuer

string · min: 1Optional

or

nullOptional

tokenIdentifierany ofRequired

Token identifier

string · min: 1Optional

or

nullOptional

policyIdstring · min: 1Required

Account policy

Responses

200

Successful response

application/json

Vault request response data

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

400

Invalid input data

application/json

401

Authorization not provided

application/json

403

Insufficient access

application/json

500

Internal server error

application/json

post

/requests/create-account

HTTPcURLJavaScriptPython

POST /v1/rest/requests/create-account HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 111

{
  "name": "text",
  "currency": "text",
  "index": 1,
  "contractAddress": "text",
  "tokenIdentifier": "text",
  "policyId": "text"
}

{
  "type": "text",
  "data": {
    "quorum": 1
  },
  "id": "text",
  "legacyId": 1,
  "state": "INITIAL",
  "reviewSteps": [
    {
      "stageName": "text",
      "quorum": 1
    }
  ],
  "currentStepIndex": 1,
  "expiresAt": "text",
  "expiredAt": "text",
  "targetId": "text",
  "note": {
    "title": "text",
    "content": "text"
  },
  "reviews": [
    {
      "stepIndex": 1,
      "userId": "text",
      "groupName": "text",
      "status": "PENDING",
      "createdAt": "text",
      "updatedAt": "text"
    }
  ],
  "createdAt": "text",
  "updatedAt": "text",
  "createdById": "text",
  "inflight": {
    "completionState": "INITIAL",
    "retryAfter": "text"
  }
}

Sign digests

post

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

accountIdstring · min: 1Required

Target account id

Responses

200

Successful response

application/json

Vault request response data

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

400

Invalid input data

application/json

401

Authorization not provided

application/json

403

Insufficient access

application/json

500

Internal server error

application/json

post

/requests/sign-digests

HTTPcURLJavaScriptPython

POST /v1/rest/requests/sign-digests HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 74

{
  "accountId": "text",
  "digests": [
    {
      "digest": "text",
      "derivationPath": "text"
    }
  ]
}

{
  "type": "text",
  "data": {
    "quorum": 1
  },
  "id": "text",
  "legacyId": 1,
  "state": "INITIAL",
  "reviewSteps": [
    {
      "stageName": "text",
      "quorum": 1
    }
  ],
  "currentStepIndex": 1,
  "expiresAt": "text",
  "expiredAt": "text",
  "targetId": "text",
  "note": {
    "title": "text",
    "content": "text"
  },
  "reviews": [
    {
      "stepIndex": 1,
      "userId": "text",
      "groupName": "text",
      "status": "PENDING",
      "createdAt": "text",
      "updatedAt": "text"
    }
  ],
  "createdAt": "text",
  "updatedAt": "text",
  "createdById": "text",
  "inflight": {
    "completionState": "INITIAL",
    "retryAfter": "text"
  }
}

Approve a request from the current user

post

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

ID of the request to approve

Body

application/json

dataone ofRequired

or

Responses

200

Successful response

application/json

Vault request response data

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

400

Invalid input data

application/json

401

Authorization not provided

application/json

403

Insufficient access

application/json

500

Internal server error

application/json

post

/requests/{id}/approve

HTTPcURLJavaScriptPython

POST /v1/rest/requests/{id}/approve HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 51

{
  "data": {
    "challengeType": "PSD",
    "signature": "text"
  }
}

{
  "type": "text",
  "data": {
    "quorum": 1
  },
  "id": "text",
  "legacyId": 1,
  "state": "INITIAL",
  "reviewSteps": [
    {
      "stageName": "text",
      "quorum": 1
    }
  ],
  "currentStepIndex": 1,
  "expiresAt": "text",
  "expiredAt": "text",
  "targetId": "text",
  "note": {
    "title": "text",
    "content": "text"
  },
  "reviews": [
    {
      "stepIndex": 1,
      "userId": "text",
      "groupName": "text",
      "status": "PENDING",
      "createdAt": "text",
      "updatedAt": "text"
    }
  ],
  "createdAt": "text",
  "updatedAt": "text",
  "createdById": "text",
  "inflight": {
    "completionState": "INITIAL",
    "retryAfter": "text"
  }
}

Reject a request from the current user

post

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

ID of the request to reject

Body

application/json

dataany ofRequired

Response to the challenge

or

nullOptional

Responses

200

Successful response

application/json

Vault request response data

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

400

Invalid input data

application/json

401

Authorization not provided

application/json

403

Insufficient access

application/json

500

Internal server error

application/json

post

/requests/{id}/reject

HTTPcURLJavaScriptPython

POST /v1/rest/requests/{id}/reject HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 52

{
  "data": {
    "signature": "text",
    "challengeType": "text"
  }
}

{
  "type": "text",
  "data": {
    "quorum": 1
  },
  "id": "text",
  "legacyId": 1,
  "state": "INITIAL",
  "reviewSteps": [
    {
      "stageName": "text",
      "quorum": 1
    }
  ],
  "currentStepIndex": 1,
  "expiresAt": "text",
  "expiredAt": "text",
  "targetId": "text",
  "note": {
    "title": "text",
    "content": "text"
  },
  "reviews": [
    {
      "stepIndex": 1,
      "userId": "text",
      "groupName": "text",
      "status": "PENDING",
      "createdAt": "text",
      "updatedAt": "text"
    }
  ],
  "createdAt": "text",
  "updatedAt": "text",
  "createdById": "text",
  "inflight": {
    "completionState": "INITIAL",
    "retryAfter": "text"
  }
}