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/

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

List eligible devices

Request

List eligible devices

Security
TokenAuth
Query
deviceTypestringrequired
Enum"MOBILE""CLOUD"
curl -i -X GET \
  'https://docs.ripple.com/_mock/products/palisade/api-docs/palisade-api/palisade-api/v2/mpc/eligible?deviceType=MOBILE' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/jsonArray [
deviceIdstringrequired
userIdstringrequired
]
Response
application/json
[
  {
    "deviceId": "string",
    "userId": "string"
  }
]

List quorums

Request

List quorums with the client JWT

Security
TokenAuth
curl -i -X GET \
  https://docs.ripple.com/_mock/products/palisade/api-docs/palisade-api/palisade-api/v2/mpc/quorums \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/jsonArray [
idstringrequired
organizationIdstringrequired
createdBystringrequired
createdAtstring(date-time)required
updatedAtstring(date-time)required
descriptionstring
deviceIdsArray of stringsrequired
namestringrequired
operationTimeoutSecondsinteger(int64)required
sessionTimeoutSecondsinteger(int64)required
requiredSignersinteger(int64)required
statestring(v2QuorumState)required
  • QUORUM_STATE_CREATED: Freshly created, but no push notifications sent
  • QUORUM_STATE_PENDING: Push notifications to member devices sent, but not all confirmed
  • QUORUM_STATE_CONFIRMED: All devices have accepted membership
  • QUORUM_STATE_REJECTED: 1+ Devices have rejected membership
  • QUORUM_STATE_FAILED: Generic error state
  • QUORUM_STATE_SUPER: FSM USE ONLY: Super state
  • QUORUM_STATE_INITIAL: FSM USE ONLY: Initial state
  • QUORUM_STATE_MODIFY_MEMBERSHIP: Register new quorum members here
  • QUORUM_STATE_MODIFY_SHARDS: Key shards are being modified
  • QUORUM_STATE_FINALIZE_MODIFICATION: Members finalize the quorum modification, ensuring old shards are deleted etc.
Enum"QUORUM_STATE_CREATED""QUORUM_STATE_PENDING""QUORUM_STATE_CONFIRMED""QUORUM_STATE_REJECTED""QUORUM_STATE_FAILED""QUORUM_STATE_SUPER""QUORUM_STATE_INITIAL""QUORUM_STATE_MODIFY_MEMBERSHIP""QUORUM_STATE_MODIFY_SHARDS""QUORUM_STATE_FINALIZE_MODIFICATION"
typestring(v2QuorumType)required
Enum"QUORUM_TYPE_MOBILE""QUORUM_TYPE_CLOUD""QUORUM_TYPE_MIXED"
backupStrategyIdstring
modificationRequestJsonBase64string
mpcAlgorithmstring(============================== QUORUM ==============================)
Enum"MPC_ALGORITHM_DKLS19""MPC_ALGORITHM_PDKLS23"
]
Response
application/json
[
  {
    "id": "string",
    "organizationId": "string",
    "createdBy": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "description": "string",
    "deviceIds": [ … ],
    "name": "string",
    "operationTimeoutSeconds": 0,
    "sessionTimeoutSeconds": 0,
    "requiredSigners": 0,
    "state": "QUORUM_STATE_CREATED",
    "type": "QUORUM_TYPE_MOBILE",
    "backupStrategyId": "string",
    "modificationRequestJsonBase64": "string",
    "mpcAlgorithm": "MPC_ALGORITHM_DKLS19"
  }
]

Create a new quorum

Request

Create a new quorum

Security
TokenAuth
Bodyapplication/jsonrequired
deviceIdsArray of stringsrequired
namestringrequired
requiredSignersinteger(int64)required
descriptionstring
quorumTypestring(v2QuorumType)required
Enum"QUORUM_TYPE_MOBILE""QUORUM_TYPE_CLOUD""QUORUM_TYPE_MIXED"
backupStrategyIdstring
curl -i -X POST \
  https://docs.ripple.com/_mock/products/palisade/api-docs/palisade-api/palisade-api/v2/mpc/quorums \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "deviceIds": [
      "string"
    ],
    "name": "string",
    "requiredSigners": 0,
    "description": "string",
    "quorumType": "QUORUM_TYPE_MOBILE",
    "backupStrategyId": "string"
  }'

Responses

Bodyapplication/json
idstringrequired
organizationIdstringrequired
createdBystringrequired
createdAtstring(date-time)required
updatedAtstring(date-time)required
descriptionstring
deviceIdsArray of stringsrequired
namestringrequired
operationTimeoutSecondsinteger(int64)required
sessionTimeoutSecondsinteger(int64)required
requiredSignersinteger(int64)required
statestring(v2QuorumState)required
  • QUORUM_STATE_CREATED: Freshly created, but no push notifications sent
  • QUORUM_STATE_PENDING: Push notifications to member devices sent, but not all confirmed
  • QUORUM_STATE_CONFIRMED: All devices have accepted membership
  • QUORUM_STATE_REJECTED: 1+ Devices have rejected membership
  • QUORUM_STATE_FAILED: Generic error state
  • QUORUM_STATE_SUPER: FSM USE ONLY: Super state
  • QUORUM_STATE_INITIAL: FSM USE ONLY: Initial state
  • QUORUM_STATE_MODIFY_MEMBERSHIP: Register new quorum members here
  • QUORUM_STATE_MODIFY_SHARDS: Key shards are being modified
  • QUORUM_STATE_FINALIZE_MODIFICATION: Members finalize the quorum modification, ensuring old shards are deleted etc.
Enum"QUORUM_STATE_CREATED""QUORUM_STATE_PENDING""QUORUM_STATE_CONFIRMED""QUORUM_STATE_REJECTED""QUORUM_STATE_FAILED""QUORUM_STATE_SUPER""QUORUM_STATE_INITIAL""QUORUM_STATE_MODIFY_MEMBERSHIP""QUORUM_STATE_MODIFY_SHARDS""QUORUM_STATE_FINALIZE_MODIFICATION"
typestring(v2QuorumType)required
Enum"QUORUM_TYPE_MOBILE""QUORUM_TYPE_CLOUD""QUORUM_TYPE_MIXED"
backupStrategyIdstring
modificationRequestJsonBase64string
mpcAlgorithmstring(============================== QUORUM ==============================)
Enum"MPC_ALGORITHM_DKLS19""MPC_ALGORITHM_PDKLS23"
Response
application/json
{
  "id": "string",
  "organizationId": "string",
  "createdBy": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "description": "string",
  "deviceIds": [
    "string"
  ],
  "name": "string",
  "operationTimeoutSeconds": 0,
  "sessionTimeoutSeconds": 0,
  "requiredSigners": 0,
  "state": "QUORUM_STATE_CREATED",
  "type": "QUORUM_TYPE_MOBILE",
  "backupStrategyId": "string",
  "modificationRequestJsonBase64": "string",
  "mpcAlgorithm": "MPC_ALGORITHM_DKLS19"
}

List quorums

Request

List quorums with the device JWT

Security
TokenAuth
curl -i -X GET \
  https://docs.ripple.com/_mock/products/palisade/api-docs/palisade-api/palisade-api/v2/mpc/quorums/self \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/jsonArray [
idstringrequired
organizationIdstringrequired
createdBystringrequired
createdAtstring(date-time)required
updatedAtstring(date-time)required
descriptionstring
deviceIdsArray of stringsrequired
namestringrequired
operationTimeoutSecondsinteger(int64)required
sessionTimeoutSecondsinteger(int64)required
requiredSignersinteger(int64)required
statestring(v2QuorumState)required
  • QUORUM_STATE_CREATED: Freshly created, but no push notifications sent
  • QUORUM_STATE_PENDING: Push notifications to member devices sent, but not all confirmed
  • QUORUM_STATE_CONFIRMED: All devices have accepted membership
  • QUORUM_STATE_REJECTED: 1+ Devices have rejected membership
  • QUORUM_STATE_FAILED: Generic error state
  • QUORUM_STATE_SUPER: FSM USE ONLY: Super state
  • QUORUM_STATE_INITIAL: FSM USE ONLY: Initial state
  • QUORUM_STATE_MODIFY_MEMBERSHIP: Register new quorum members here
  • QUORUM_STATE_MODIFY_SHARDS: Key shards are being modified
  • QUORUM_STATE_FINALIZE_MODIFICATION: Members finalize the quorum modification, ensuring old shards are deleted etc.
Enum"QUORUM_STATE_CREATED""QUORUM_STATE_PENDING""QUORUM_STATE_CONFIRMED""QUORUM_STATE_REJECTED""QUORUM_STATE_FAILED""QUORUM_STATE_SUPER""QUORUM_STATE_INITIAL""QUORUM_STATE_MODIFY_MEMBERSHIP""QUORUM_STATE_MODIFY_SHARDS""QUORUM_STATE_FINALIZE_MODIFICATION"
typestring(v2QuorumType)required
Enum"QUORUM_TYPE_MOBILE""QUORUM_TYPE_CLOUD""QUORUM_TYPE_MIXED"
backupStrategyIdstring
modificationRequestJsonBase64string
mpcAlgorithmstring(============================== QUORUM ==============================)
Enum"MPC_ALGORITHM_DKLS19""MPC_ALGORITHM_PDKLS23"
]
Response
application/json
[
  {
    "id": "string",
    "organizationId": "string",
    "createdBy": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "description": "string",
    "deviceIds": [ … ],
    "name": "string",
    "operationTimeoutSeconds": 0,
    "sessionTimeoutSeconds": 0,
    "requiredSigners": 0,
    "state": "QUORUM_STATE_CREATED",
    "type": "QUORUM_TYPE_MOBILE",
    "backupStrategyId": "string",
    "modificationRequestJsonBase64": "string",
    "mpcAlgorithm": "MPC_ALGORITHM_DKLS19"
  }
]

Get a quorum

Request

Get a quorum

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

Responses

Bodyapplication/json
idstringrequired
organizationIdstringrequired
createdBystringrequired
createdAtstring(date-time)required
updatedAtstring(date-time)required
descriptionstring
deviceIdsArray of stringsrequired
namestringrequired
operationTimeoutSecondsinteger(int64)required
sessionTimeoutSecondsinteger(int64)required
requiredSignersinteger(int64)required
statestring(v2QuorumState)required
  • QUORUM_STATE_CREATED: Freshly created, but no push notifications sent
  • QUORUM_STATE_PENDING: Push notifications to member devices sent, but not all confirmed
  • QUORUM_STATE_CONFIRMED: All devices have accepted membership
  • QUORUM_STATE_REJECTED: 1+ Devices have rejected membership
  • QUORUM_STATE_FAILED: Generic error state
  • QUORUM_STATE_SUPER: FSM USE ONLY: Super state
  • QUORUM_STATE_INITIAL: FSM USE ONLY: Initial state
  • QUORUM_STATE_MODIFY_MEMBERSHIP: Register new quorum members here
  • QUORUM_STATE_MODIFY_SHARDS: Key shards are being modified
  • QUORUM_STATE_FINALIZE_MODIFICATION: Members finalize the quorum modification, ensuring old shards are deleted etc.
Enum"QUORUM_STATE_CREATED""QUORUM_STATE_PENDING""QUORUM_STATE_CONFIRMED""QUORUM_STATE_REJECTED""QUORUM_STATE_FAILED""QUORUM_STATE_SUPER""QUORUM_STATE_INITIAL""QUORUM_STATE_MODIFY_MEMBERSHIP""QUORUM_STATE_MODIFY_SHARDS""QUORUM_STATE_FINALIZE_MODIFICATION"
typestring(v2QuorumType)required
Enum"QUORUM_TYPE_MOBILE""QUORUM_TYPE_CLOUD""QUORUM_TYPE_MIXED"
backupStrategyIdstring
modificationRequestJsonBase64string
mpcAlgorithmstring(============================== QUORUM ==============================)
Enum"MPC_ALGORITHM_DKLS19""MPC_ALGORITHM_PDKLS23"
Response
application/json
{
  "id": "string",
  "organizationId": "string",
  "createdBy": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "description": "string",
  "deviceIds": [
    "string"
  ],
  "name": "string",
  "operationTimeoutSeconds": 0,
  "sessionTimeoutSeconds": 0,
  "requiredSigners": 0,
  "state": "QUORUM_STATE_CREATED",
  "type": "QUORUM_TYPE_MOBILE",
  "backupStrategyId": "string",
  "modificationRequestJsonBase64": "string",
  "mpcAlgorithm": "MPC_ALGORITHM_DKLS19"
}

Delete a quorum

Request

Delete a quorum

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

Responses

Bodyapplication/json
idstringrequired
organizationIdstringrequired
createdBystringrequired
createdAtstring(date-time)required
updatedAtstring(date-time)required
descriptionstring
deviceIdsArray of stringsrequired
namestringrequired
operationTimeoutSecondsinteger(int64)required
sessionTimeoutSecondsinteger(int64)required
requiredSignersinteger(int64)required
statestring(v2QuorumState)required
  • QUORUM_STATE_CREATED: Freshly created, but no push notifications sent
  • QUORUM_STATE_PENDING: Push notifications to member devices sent, but not all confirmed
  • QUORUM_STATE_CONFIRMED: All devices have accepted membership
  • QUORUM_STATE_REJECTED: 1+ Devices have rejected membership
  • QUORUM_STATE_FAILED: Generic error state
  • QUORUM_STATE_SUPER: FSM USE ONLY: Super state
  • QUORUM_STATE_INITIAL: FSM USE ONLY: Initial state
  • QUORUM_STATE_MODIFY_MEMBERSHIP: Register new quorum members here
  • QUORUM_STATE_MODIFY_SHARDS: Key shards are being modified
  • QUORUM_STATE_FINALIZE_MODIFICATION: Members finalize the quorum modification, ensuring old shards are deleted etc.
Enum"QUORUM_STATE_CREATED""QUORUM_STATE_PENDING""QUORUM_STATE_CONFIRMED""QUORUM_STATE_REJECTED""QUORUM_STATE_FAILED""QUORUM_STATE_SUPER""QUORUM_STATE_INITIAL""QUORUM_STATE_MODIFY_MEMBERSHIP""QUORUM_STATE_MODIFY_SHARDS""QUORUM_STATE_FINALIZE_MODIFICATION"
typestring(v2QuorumType)required
Enum"QUORUM_TYPE_MOBILE""QUORUM_TYPE_CLOUD""QUORUM_TYPE_MIXED"
backupStrategyIdstring
modificationRequestJsonBase64string
mpcAlgorithmstring(============================== QUORUM ==============================)
Enum"MPC_ALGORITHM_DKLS19""MPC_ALGORITHM_PDKLS23"
Response
application/json
{
  "id": "string",
  "organizationId": "string",
  "createdBy": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "description": "string",
  "deviceIds": [
    "string"
  ],
  "name": "string",
  "operationTimeoutSeconds": 0,
  "sessionTimeoutSeconds": 0,
  "requiredSigners": 0,
  "state": "QUORUM_STATE_CREATED",
  "type": "QUORUM_TYPE_MOBILE",
  "backupStrategyId": "string",
  "modificationRequestJsonBase64": "string",
  "mpcAlgorithm": "MPC_ALGORITHM_DKLS19"
}

Modify an existing quorum

Request

Modify an existing quorum

Security
TokenAuth
Path
quorumIdstringrequired
Bodyapplication/jsonrequired
deviceIdsArray of stringsrequired
curl -i -X PATCH \
  'https://docs.ripple.com/_mock/products/palisade/api-docs/palisade-api/palisade-api/v2/mpc/quorums/{quorumId}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "deviceIds": [
      "string"
    ]
  }'

Responses

Bodyapplication/json
idstringrequired
organizationIdstringrequired
createdBystringrequired
createdAtstring(date-time)required
updatedAtstring(date-time)required
descriptionstring
deviceIdsArray of stringsrequired
namestringrequired
operationTimeoutSecondsinteger(int64)required
sessionTimeoutSecondsinteger(int64)required
requiredSignersinteger(int64)required
statestring(v2QuorumState)required
  • QUORUM_STATE_CREATED: Freshly created, but no push notifications sent
  • QUORUM_STATE_PENDING: Push notifications to member devices sent, but not all confirmed
  • QUORUM_STATE_CONFIRMED: All devices have accepted membership
  • QUORUM_STATE_REJECTED: 1+ Devices have rejected membership
  • QUORUM_STATE_FAILED: Generic error state
  • QUORUM_STATE_SUPER: FSM USE ONLY: Super state
  • QUORUM_STATE_INITIAL: FSM USE ONLY: Initial state
  • QUORUM_STATE_MODIFY_MEMBERSHIP: Register new quorum members here
  • QUORUM_STATE_MODIFY_SHARDS: Key shards are being modified
  • QUORUM_STATE_FINALIZE_MODIFICATION: Members finalize the quorum modification, ensuring old shards are deleted etc.
Enum"QUORUM_STATE_CREATED""QUORUM_STATE_PENDING""QUORUM_STATE_CONFIRMED""QUORUM_STATE_REJECTED""QUORUM_STATE_FAILED""QUORUM_STATE_SUPER""QUORUM_STATE_INITIAL""QUORUM_STATE_MODIFY_MEMBERSHIP""QUORUM_STATE_MODIFY_SHARDS""QUORUM_STATE_FINALIZE_MODIFICATION"
typestring(v2QuorumType)required
Enum"QUORUM_TYPE_MOBILE""QUORUM_TYPE_CLOUD""QUORUM_TYPE_MIXED"
backupStrategyIdstring
modificationRequestJsonBase64string
mpcAlgorithmstring(============================== QUORUM ==============================)
Enum"MPC_ALGORITHM_DKLS19""MPC_ALGORITHM_PDKLS23"
Response
application/json
{
  "id": "string",
  "organizationId": "string",
  "createdBy": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "description": "string",
  "deviceIds": [
    "string"
  ],
  "name": "string",
  "operationTimeoutSeconds": 0,
  "sessionTimeoutSeconds": 0,
  "requiredSigners": 0,
  "state": "QUORUM_STATE_CREATED",
  "type": "QUORUM_TYPE_MOBILE",
  "backupStrategyId": "string",
  "modificationRequestJsonBase64": "string",
  "mpcAlgorithm": "MPC_ALGORITHM_DKLS19"
}

Poll quorum status

Request

Poll quorum status

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

Responses

Bodyapplication/json
expectedMemberCountinteger(int64)required
acceptedMemberCountinteger(int64)required
rejectedMemberCountinteger(int64)required
statestring(v2QuorumState)required
  • QUORUM_STATE_CREATED: Freshly created, but no push notifications sent
  • QUORUM_STATE_PENDING: Push notifications to member devices sent, but not all confirmed
  • QUORUM_STATE_CONFIRMED: All devices have accepted membership
  • QUORUM_STATE_REJECTED: 1+ Devices have rejected membership
  • QUORUM_STATE_FAILED: Generic error state
  • QUORUM_STATE_SUPER: FSM USE ONLY: Super state
  • QUORUM_STATE_INITIAL: FSM USE ONLY: Initial state
  • QUORUM_STATE_MODIFY_MEMBERSHIP: Register new quorum members here
  • QUORUM_STATE_MODIFY_SHARDS: Key shards are being modified
  • QUORUM_STATE_FINALIZE_MODIFICATION: Members finalize the quorum modification, ensuring old shards are deleted etc.
Enum"QUORUM_STATE_CREATED""QUORUM_STATE_PENDING""QUORUM_STATE_CONFIRMED""QUORUM_STATE_REJECTED""QUORUM_STATE_FAILED""QUORUM_STATE_SUPER""QUORUM_STATE_INITIAL""QUORUM_STATE_MODIFY_MEMBERSHIP""QUORUM_STATE_MODIFY_SHARDS""QUORUM_STATE_FINALIZE_MODIFICATION"
Response
application/json
{
  "expectedMemberCount": 0,
  "acceptedMemberCount": 0,
  "rejectedMemberCount": 0,
  "state": "QUORUM_STATE_CREATED"
}

MPC - Sessions

Used to manage MPC sessions

Operations

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