Skip to content

Palisade API (2.0)

The Palisade API enables programmatic interaction with the various features of the Palisade platform

Click here for the API docs
Download OpenAPI description
palisade-api.json
palisade-api.yaml
Languages
Servers
Mock server

https://docs.ripple.com/_mock/products/palisade/api-docs/palisade-api/palisade-api-1/

Sandbox server (uses TESTNET data, private keys and accounts)

https://api.sandbox.palisade.co/

Palisade server (uses MAINNET data, private keys and accounts)

https://api.palisade.co/

Addresses

Used to manage addresses

Operations

Allow Addresses (deprecated)

Used to manage legacy allow addresses

API Credentials

Used to manage credentials

Operations

Approvals

Used to manage approvals

Operations

Approvers

Used to manage approvers

Operations

Audit

Used to manage configuration for audit

Operations

Backup

Used to manage backups

Operations

Balances

Used to view balances

Operations

Compliance

Used to manage compliance

Operations

Counterparties

Used to manage counterparties

Operations

Devices

Used to manage devices

Operations

Information

Used to view information about the platform

Operations

MPC - Memberships

Used to manage MPC memberships

Operations

MPC - Quorums

Used to manage MPC quorums

Operations

MPC - Sessions

Used to manage MPC sessions

Operations

List sessions for device

Request

List sessions for device

Security
TokenAuth
Query
stateFilterstringrequired
  • SESSION_STATE_SUBMITTED: Session has completed & submitted data from this device
  • SESSION_STATE_COMPLETED: Session has completed but this device did not submit data
  • SESSION_STATE_SUPER: FSM USE ONLY: Super state
  • SESSION_STATE_INITIAL: FSM USE ONLY: Initial state
Enum"SESSION_STATE_CREATED""SESSION_STATE_PENDING""SESSION_STATE_SUBMITTED""SESSION_STATE_COMPLETED""SESSION_STATE_TIMED_OUT""SESSION_STATE_FAILED""SESSION_STATE_PROCESSED""SESSION_STATE_SUPER""SESSION_STATE_INITIAL"
curl -i -X GET \
  'https://docs.ripple.com/_mock/products/palisade/api-docs/palisade-api/palisade-api-1/v2/mpc/device/sessions?stateFilter=SESSION_STATE_CREATED' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/jsonArray [
idstringrequired
organizationIdstringrequired
membershipIdstringrequired
sessionSetIdstringrequired
createdBystringrequired
createdAtstring(date-time)required
updatedAtstring(date-time)required
expiresAtstring(date-time)required
typestring(============================== SESSION ==============================)required
Enum"SESSION_TYPE_QUORUM_CREATION""SESSION_TYPE_KEY_CREATION""SESSION_TYPE_TX_SIGN_POOL""SESSION_TYPE_TX_SIGN_REQUEST""SESSION_TYPE_QUORUM_JOIN""SESSION_TYPE_QUORUM_MODIFY""SESSION_TYPE_QUORUM_MODIFY_FINALIZE"
acceptedbooleanrequired
payloadIdstringrequired
devicePayloadstring(TODO: Validate based on contents of 'accept' field: Validate base64 string?)required
notificationPayloadstring(byte)required
notificationTriggerstringrequired
notificationBodystringrequired
statestring(- SESSION_STATE_SUBMITTED: Session has completed & submitted data from this device - SESSION_STATE_COMPLETED: Session has completed but this device did not submit data - SESSION_STATE_SUPER: FSM USE ONLY: Super state - SESSION_STATE_INITIAL: FSM USE ONLY: Initial state)required
Enum"SESSION_STATE_CREATED""SESSION_STATE_PENDING""SESSION_STATE_SUBMITTED""SESSION_STATE_COMPLETED""SESSION_STATE_TIMED_OUT""SESSION_STATE_FAILED""SESSION_STATE_PROCESSED""SESSION_STATE_SUPER""SESSION_STATE_INITIAL"
]
Response
application/json
[
  {
    "id": "string",
    "organizationId": "string",
    "membershipId": "string",
    "sessionSetId": "string",
    "createdBy": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "expiresAt": "2019-08-24T14:15:22Z",
    "type": "SESSION_TYPE_QUORUM_CREATION",
    "accepted": true,
    "payloadId": "string",
    "devicePayload": "string",
    "notificationPayload": "string",
    "notificationTrigger": "string",
    "notificationBody": "string",
    "state": "SESSION_STATE_CREATED"
  }
]

Get session

Request

Get session

Security
TokenAuth
Path
sessionIdstringrequired
curl -i -X GET \
  'https://docs.ripple.com/_mock/products/palisade/api-docs/palisade-api/palisade-api-1/v2/mpc/device/sessions/{sessionId}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
idstringrequired
organizationIdstringrequired
membershipIdstringrequired
sessionSetIdstringrequired
createdBystringrequired
createdAtstring(date-time)required
updatedAtstring(date-time)required
expiresAtstring(date-time)required
typestring(============================== SESSION ==============================)required
Enum"SESSION_TYPE_QUORUM_CREATION""SESSION_TYPE_KEY_CREATION""SESSION_TYPE_TX_SIGN_POOL""SESSION_TYPE_TX_SIGN_REQUEST""SESSION_TYPE_QUORUM_JOIN""SESSION_TYPE_QUORUM_MODIFY""SESSION_TYPE_QUORUM_MODIFY_FINALIZE"
acceptedbooleanrequired
payloadIdstringrequired
devicePayloadstring(TODO: Validate based on contents of 'accept' field: Validate base64 string?)required
notificationPayloadstring(byte)required
notificationTriggerstringrequired
notificationBodystringrequired
statestring(- SESSION_STATE_SUBMITTED: Session has completed & submitted data from this device - SESSION_STATE_COMPLETED: Session has completed but this device did not submit data - SESSION_STATE_SUPER: FSM USE ONLY: Super state - SESSION_STATE_INITIAL: FSM USE ONLY: Initial state)required
Enum"SESSION_STATE_CREATED""SESSION_STATE_PENDING""SESSION_STATE_SUBMITTED""SESSION_STATE_COMPLETED""SESSION_STATE_TIMED_OUT""SESSION_STATE_FAILED""SESSION_STATE_PROCESSED""SESSION_STATE_SUPER""SESSION_STATE_INITIAL"
Response
application/json
{
  "id": "string",
  "organizationId": "string",
  "membershipId": "string",
  "sessionSetId": "string",
  "createdBy": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "expiresAt": "2019-08-24T14:15:22Z",
  "type": "SESSION_TYPE_QUORUM_CREATION",
  "accepted": true,
  "payloadId": "string",
  "devicePayload": "string",
  "notificationPayload": "string",
  "notificationTrigger": "string",
  "notificationBody": "string",
  "state": "SESSION_STATE_CREATED"
}

Get device session data

Request

Get device session data

Security
TokenAuth
Path
sessionIdstringrequired
curl -i -X GET \
  'https://docs.ripple.com/_mock/products/palisade/api-docs/palisade-api/palisade-api-1/v2/mpc/device/sessions/{sessionId}/data' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

A successful response.

Bodyapplication/json
dataobject
Response
application/json
{
  "data": {
    "property1": "string",
    "property2": "string"
  }
}

Submit session

Request

Submit session

Security
TokenAuth
Path
sessionIdstringrequired
Bodyapplication/jsonrequired
acceptedbooleanrequired
devicePayloadstring(Quorum Initialisation: This is the device's public key Key Creation: This is the new wallet's public key Transaction signing: This is the transaction signature)

TODO: Validate based on contents of 'accept' field: Validate base64 string?

curl -i -X PATCH \
  'https://docs.ripple.com/_mock/products/palisade/api-docs/palisade-api/palisade-api-1/v2/mpc/device/{sessionId}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "accepted": true,
    "devicePayload": "string"
  }'

Responses

Bodyapplication/json
idstringrequired
organizationIdstringrequired
membershipIdstringrequired
sessionSetIdstringrequired
createdBystringrequired
createdAtstring(date-time)required
updatedAtstring(date-time)required
expiresAtstring(date-time)required
typestring(============================== SESSION ==============================)required
Enum"SESSION_TYPE_QUORUM_CREATION""SESSION_TYPE_KEY_CREATION""SESSION_TYPE_TX_SIGN_POOL""SESSION_TYPE_TX_SIGN_REQUEST""SESSION_TYPE_QUORUM_JOIN""SESSION_TYPE_QUORUM_MODIFY""SESSION_TYPE_QUORUM_MODIFY_FINALIZE"
acceptedbooleanrequired
payloadIdstringrequired
devicePayloadstring(TODO: Validate based on contents of 'accept' field: Validate base64 string?)required
notificationPayloadstring(byte)required
notificationTriggerstringrequired
notificationBodystringrequired
statestring(- SESSION_STATE_SUBMITTED: Session has completed & submitted data from this device - SESSION_STATE_COMPLETED: Session has completed but this device did not submit data - SESSION_STATE_SUPER: FSM USE ONLY: Super state - SESSION_STATE_INITIAL: FSM USE ONLY: Initial state)required
Enum"SESSION_STATE_CREATED""SESSION_STATE_PENDING""SESSION_STATE_SUBMITTED""SESSION_STATE_COMPLETED""SESSION_STATE_TIMED_OUT""SESSION_STATE_FAILED""SESSION_STATE_PROCESSED""SESSION_STATE_SUPER""SESSION_STATE_INITIAL"
Response
application/json
{
  "id": "string",
  "organizationId": "string",
  "membershipId": "string",
  "sessionSetId": "string",
  "createdBy": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "expiresAt": "2019-08-24T14:15:22Z",
  "type": "SESSION_TYPE_QUORUM_CREATION",
  "accepted": true,
  "payloadId": "string",
  "devicePayload": "string",
  "notificationPayload": "string",
  "notificationTrigger": "string",
  "notificationBody": "string",
  "state": "SESSION_STATE_CREATED"
}

List session sets

Request

List session sets

Security
TokenAuth
Path
quorumIdstringrequired
curl -i -X GET \
  'https://docs.ripple.com/_mock/products/palisade/api-docs/palisade-api/palisade-api-1/v2/mpc/sessions/{quorumId}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/jsonArray [
idstringrequired
organizationIdstringrequired
quorumIdstringrequired
createdBystringrequired
createdAtstring(date-time)required
updatedAtstring(date-time)required
expiresAtstring(date-time)required
typestring(v2SessionSetType)required
Enum"SESSION_SET_TYPE_QUORUM_CREATION""SESSION_SET_TYPE_KEY_CREATION""SESSION_SET_TYPE_TX_SIGN_POOL""SESSION_SET_TYPE_TX_SIGN_REQUEST""SESSION_SET_TYPE_QUORUM_JOIN""SESSION_SET_TYPE_QUORUM_MODIFY""SESSION_SET_TYPE_QUORUM_MODIFY_FINALIZE"
payloadIdstringrequired
payloadRawstring(TODO: Validate base64 string?)required
statestring(============================== SESSION SET ==============================)required
  • SESSION_SET_STATE_SUPER: FSM USE ONLY: Super state
  • SESSION_SET_STATE_INITIAL: FSM USE ONLY: Initial state
Enum"SESSION_SET_STATE_CREATED""SESSION_SET_STATE_IN_PROGRESS""SESSION_SET_STATE_COMPLETE""SESSION_SET_STATE_TIMED_OUT""SESSION_SET_STATE_FAILED""SESSION_SET_STATE_SUPER""SESSION_SET_STATE_INITIAL"
]
Response
application/json
[
  {
    "id": "string",
    "organizationId": "string",
    "quorumId": "string",
    "createdBy": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "expiresAt": "2019-08-24T14:15:22Z",
    "type": "SESSION_SET_TYPE_QUORUM_CREATION",
    "payloadId": "string",
    "payloadRaw": "string",
    "state": "SESSION_SET_STATE_CREATED"
  }
]

Poll session set status

Request

Poll session set status

Security
TokenAuth
Path
sessionSetIdstringrequired
curl -i -X GET \
  'https://docs.ripple.com/_mock/products/palisade/api-docs/palisade-api/palisade-api-1/v2/mpc/sessions/{sessionSetId}/status' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
expectedCountinteger(int64)required
submittedCountinteger(int64)required
acceptedCountinteger(int64)required
statestring(============================== SESSION SET ==============================)required
  • SESSION_SET_STATE_SUPER: FSM USE ONLY: Super state
  • SESSION_SET_STATE_INITIAL: FSM USE ONLY: Initial state
Enum"SESSION_SET_STATE_CREATED""SESSION_SET_STATE_IN_PROGRESS""SESSION_SET_STATE_COMPLETE""SESSION_SET_STATE_TIMED_OUT""SESSION_SET_STATE_FAILED""SESSION_SET_STATE_SUPER""SESSION_SET_STATE_INITIAL"
Response
application/json
{
  "expectedCount": 0,
  "submittedCount": 0,
  "acceptedCount": 0,
  "state": "SESSION_SET_STATE_CREATED"
}

Organizations

Used to manage organizations

Operations

Policies

Used to manage connections policies

Operations

Rates

Used to retrieve rates

Operations

Sweep Configurations

Used to manage sweep configurations

Operations

Tags

Used to manage organization tags

Operations

Transactions

Used to manage transactions

Operations

Transactions - XRP

Used to manage XRP specific transactions

Operations

Users

Used to manage users

Operations

Vaults

Used to manage vaults

Operations

Vault Tags

Used to manage vault tags

Operations

Wallets

Used to manage wallets

Operations

Wallet Tags

Used to manage wallet tags

Operations

Wallet Connect

Used to manage connections

Operations

Webhooks

Used to manage webhooks

Operations

Registry

Operations

Transactions - Sweep

Operations

Sweep Instances

Operations