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

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

List connections for the organization

Request

List all wallet connect connections for the organization

Security
TokenAuth
Query
statusstringrequired

The connection status

Enum"CREATED""PROPOSING""PROPOSED""CONNECTED""DISCONNECTED""REJECTED""UNSUPPORTED""EXPIRED""ERROR"
curl -i -X GET \
  'https://docs.ripple.com/_mock/products/palisade/api-docs/palisade-api/palisade-api-1/v2/connections?status=CREATED' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/jsonArray [
idstringrequired

The connection ID

Example: "ce4918bf-a199-4ce2-85a3-d0d296855384"
walletIdstringrequired

The wallet ID that the connection is associated with

Example: "ce4918bf-a199-4ce2-85a3-d0d296855384"
vaultIdstringrequired

The vault ID that the connection is associated with

Example: "ce4918bf-a199-4ce2-85a3-d0d296855384"
organizationIdstringrequired

The organization ID that the connection is associated with

Example: "ce4918bf-a199-4ce2-85a3-d0d296855384"
createdBystringrequired

The user ID that the connection is associated with

Example: "ce4918bf-a199-4ce2-85a3-d0d296855384"
createdAtstring(date-time)required

The date and time the connection was created

Example: "2022-03-29T10:22:22.420Z"
updatedAtstring(date-time)required

The date and time the connection was updated

Example: "2022-03-29T10:22:22.420Z"
statusstring(v2ConnectionStatus)required
Enum"CREATED""PROPOSING""PROPOSED""CONNECTED""DISCONNECTED""REJECTED""UNSUPPORTED""EXPIRED""ERROR"
proposerobject(v2Proposer)
]
Response
application/json
[
  {
    "id": "ce4918bf-a199-4ce2-85a3-d0d296855384",
    "walletId": "ce4918bf-a199-4ce2-85a3-d0d296855384",
    "vaultId": "ce4918bf-a199-4ce2-85a3-d0d296855384",
    "organizationId": "ce4918bf-a199-4ce2-85a3-d0d296855384",
    "createdBy": "ce4918bf-a199-4ce2-85a3-d0d296855384",
    "createdAt": "2022-03-29T10:22:22.420Z",
    "updatedAt": "2022-03-29T10:22:22.420Z",
    "status": "CREATED",
    "proposer": { … }
  }
]

List connections for the wallet

Request

List all wallet connect connections for the wallet

Security
TokenAuth
Path
vaultIdstringrequired

The vault ID that the connection is associated with

walletIdstringrequired

The wallet ID that the connection is associated with

Query
statusstringrequired

The connection status

Enum"CREATED""PROPOSING""PROPOSED""CONNECTED""DISCONNECTED""REJECTED""UNSUPPORTED""EXPIRED""ERROR"
curl -i -X GET \
  'https://docs.ripple.com/_mock/products/palisade/api-docs/palisade-api/palisade-api-1/v2/vaults/{vaultId}/wallets/{walletId}/connections?status=CREATED' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/jsonArray [
idstringrequired

The connection ID

Example: "ce4918bf-a199-4ce2-85a3-d0d296855384"
walletIdstringrequired

The wallet ID that the connection is associated with

Example: "ce4918bf-a199-4ce2-85a3-d0d296855384"
vaultIdstringrequired

The vault ID that the connection is associated with

Example: "ce4918bf-a199-4ce2-85a3-d0d296855384"
organizationIdstringrequired

The organization ID that the connection is associated with

Example: "ce4918bf-a199-4ce2-85a3-d0d296855384"
createdBystringrequired

The user ID that the connection is associated with

Example: "ce4918bf-a199-4ce2-85a3-d0d296855384"
createdAtstring(date-time)required

The date and time the connection was created

Example: "2022-03-29T10:22:22.420Z"
updatedAtstring(date-time)required

The date and time the connection was updated

Example: "2022-03-29T10:22:22.420Z"
statusstring(v2ConnectionStatus)required
Enum"CREATED""PROPOSING""PROPOSED""CONNECTED""DISCONNECTED""REJECTED""UNSUPPORTED""EXPIRED""ERROR"
proposerobject(v2Proposer)
]
Response
application/json
[
  {
    "id": "ce4918bf-a199-4ce2-85a3-d0d296855384",
    "walletId": "ce4918bf-a199-4ce2-85a3-d0d296855384",
    "vaultId": "ce4918bf-a199-4ce2-85a3-d0d296855384",
    "organizationId": "ce4918bf-a199-4ce2-85a3-d0d296855384",
    "createdBy": "ce4918bf-a199-4ce2-85a3-d0d296855384",
    "createdAt": "2022-03-29T10:22:22.420Z",
    "updatedAt": "2022-03-29T10:22:22.420Z",
    "status": "CREATED",
    "proposer": { … }
  }
]

Propose a new wallet connect connection

Request

Proposes a new wallet connect connection using the provided URI

Security
TokenAuth
Path
vaultIdstringrequired

The vault ID that the connection is associated with

walletIdstringrequired

The wallet ID that the connection is associated with

Bodyapplication/jsonrequired
uristringrequired

The URI used to create the connection

Example: "wc:7f6e504bfad60b485450578e05678ed3e8e8c4751d3c6160be17160d63ec90f9@2?symKey=587d5484ce2a2a6ee3ba1962fdd7e8588e06200c46823bd18fbd67def96ad303&methods=[wc_ConnectionPropose],[wc_authRequest,wc_authBatchRequest]&relay-protocol=irn&expiryTimestamp=1705667684"
curl -i -X POST \
  'https://docs.ripple.com/_mock/products/palisade/api-docs/palisade-api/palisade-api-1/v2/vaults/{vaultId}/wallets/{walletId}/connections' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "uri": "wc:7f6e504bfad60b485450578e05678ed3e8e8c4751d3c6160be17160d63ec90f9@2?symKey=587d5484ce2a2a6ee3ba1962fdd7e8588e06200c46823bd18fbd67def96ad303&methods=[wc_ConnectionPropose],[wc_authRequest,wc_authBatchRequest]&relay-protocol=irn&expiryTimestamp=1705667684"
  }'

Responses

Bodyapplication/json
idstringrequired

The connection ID

Example: "ce4918bf-a199-4ce2-85a3-d0d296855384"
walletIdstringrequired

The wallet ID that the connection is associated with

Example: "ce4918bf-a199-4ce2-85a3-d0d296855384"
vaultIdstringrequired

The vault ID that the connection is associated with

Example: "ce4918bf-a199-4ce2-85a3-d0d296855384"
organizationIdstringrequired

The organization ID that the connection is associated with

Example: "ce4918bf-a199-4ce2-85a3-d0d296855384"
createdBystringrequired

The user ID that the connection is associated with

Example: "ce4918bf-a199-4ce2-85a3-d0d296855384"
createdAtstring(date-time)required

The date and time the connection was created

Example: "2022-03-29T10:22:22.420Z"
updatedAtstring(date-time)required

The date and time the connection was updated

Example: "2022-03-29T10:22:22.420Z"
statusstring(v2ConnectionStatus)required
Enum"CREATED""PROPOSING""PROPOSED""CONNECTED""DISCONNECTED""REJECTED""UNSUPPORTED""EXPIRED""ERROR"
proposerobject(v2Proposer)
Response
application/json
{
  "id": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "walletId": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "vaultId": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "organizationId": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "createdBy": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "createdAt": "2022-03-29T10:22:22.420Z",
  "updatedAt": "2022-03-29T10:22:22.420Z",
  "status": "CREATED",
  "proposer": {
    "publicKey": "497f83bc461e9ec55be08592cecea561ccd713781954d313976feb2d7d93293a",
    "metadata": { … }
  }
}

Get a wallet connect connection

Request

Get a wallet connect connection by ID

Security
TokenAuth
Path
vaultIdstringrequired

The vault ID that the connection is associated with

walletIdstringrequired

The wallet ID that the connection is associated with

idstringrequired

The connection ID

curl -i -X GET \
  'https://docs.ripple.com/_mock/products/palisade/api-docs/palisade-api/palisade-api-1/v2/vaults/{vaultId}/wallets/{walletId}/connections/{id}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
idstringrequired

The connection ID

Example: "ce4918bf-a199-4ce2-85a3-d0d296855384"
walletIdstringrequired

The wallet ID that the connection is associated with

Example: "ce4918bf-a199-4ce2-85a3-d0d296855384"
vaultIdstringrequired

The vault ID that the connection is associated with

Example: "ce4918bf-a199-4ce2-85a3-d0d296855384"
organizationIdstringrequired

The organization ID that the connection is associated with

Example: "ce4918bf-a199-4ce2-85a3-d0d296855384"
createdBystringrequired

The user ID that the connection is associated with

Example: "ce4918bf-a199-4ce2-85a3-d0d296855384"
createdAtstring(date-time)required

The date and time the connection was created

Example: "2022-03-29T10:22:22.420Z"
updatedAtstring(date-time)required

The date and time the connection was updated

Example: "2022-03-29T10:22:22.420Z"
statusstring(v2ConnectionStatus)required
Enum"CREATED""PROPOSING""PROPOSED""CONNECTED""DISCONNECTED""REJECTED""UNSUPPORTED""EXPIRED""ERROR"
proposerobject(v2Proposer)
Response
application/json
{
  "id": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "walletId": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "vaultId": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "organizationId": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "createdBy": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "createdAt": "2022-03-29T10:22:22.420Z",
  "updatedAt": "2022-03-29T10:22:22.420Z",
  "status": "CREATED",
  "proposer": {
    "publicKey": "497f83bc461e9ec55be08592cecea561ccd713781954d313976feb2d7d93293a",
    "metadata": { … }
  }
}

Accept a wallet connect connection

Request

Accept a wallet connect connection by ID

Security
TokenAuth
Path
vaultIdstringrequired

The vault ID that the connection is associated with

walletIdstringrequired

The wallet ID that the connection is associated with

idstringrequired

The connection ID

curl -i -X PUT \
  'https://docs.ripple.com/_mock/products/palisade/api-docs/palisade-api/palisade-api-1/v2/vaults/{vaultId}/wallets/{walletId}/connections/{id}/accept' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
idstringrequired

The connection ID

Example: "ce4918bf-a199-4ce2-85a3-d0d296855384"
walletIdstringrequired

The wallet ID that the connection is associated with

Example: "ce4918bf-a199-4ce2-85a3-d0d296855384"
vaultIdstringrequired

The vault ID that the connection is associated with

Example: "ce4918bf-a199-4ce2-85a3-d0d296855384"
organizationIdstringrequired

The organization ID that the connection is associated with

Example: "ce4918bf-a199-4ce2-85a3-d0d296855384"
createdBystringrequired

The user ID that the connection is associated with

Example: "ce4918bf-a199-4ce2-85a3-d0d296855384"
createdAtstring(date-time)required

The date and time the connection was created

Example: "2022-03-29T10:22:22.420Z"
updatedAtstring(date-time)required

The date and time the connection was updated

Example: "2022-03-29T10:22:22.420Z"
statusstring(v2ConnectionStatus)required
Enum"CREATED""PROPOSING""PROPOSED""CONNECTED""DISCONNECTED""REJECTED""UNSUPPORTED""EXPIRED""ERROR"
proposerobject(v2Proposer)
Response
application/json
{
  "id": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "walletId": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "vaultId": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "organizationId": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "createdBy": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "createdAt": "2022-03-29T10:22:22.420Z",
  "updatedAt": "2022-03-29T10:22:22.420Z",
  "status": "CREATED",
  "proposer": {
    "publicKey": "497f83bc461e9ec55be08592cecea561ccd713781954d313976feb2d7d93293a",
    "metadata": { … }
  }
}

Disconnects a wallet connect connection

Request

Disconnects a wallet connect connection by ID

Security
TokenAuth
Path
vaultIdstringrequired

The vault ID that the connection is associated with

walletIdstringrequired

The wallet ID that the connection is associated with

idstringrequired

The connection ID

curl -i -X PUT \
  'https://docs.ripple.com/_mock/products/palisade/api-docs/palisade-api/palisade-api-1/v2/vaults/{vaultId}/wallets/{walletId}/connections/{id}/disconnect' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
idstringrequired

The connection ID

Example: "ce4918bf-a199-4ce2-85a3-d0d296855384"
walletIdstringrequired

The wallet ID that the connection is associated with

Example: "ce4918bf-a199-4ce2-85a3-d0d296855384"
vaultIdstringrequired

The vault ID that the connection is associated with

Example: "ce4918bf-a199-4ce2-85a3-d0d296855384"
organizationIdstringrequired

The organization ID that the connection is associated with

Example: "ce4918bf-a199-4ce2-85a3-d0d296855384"
createdBystringrequired

The user ID that the connection is associated with

Example: "ce4918bf-a199-4ce2-85a3-d0d296855384"
createdAtstring(date-time)required

The date and time the connection was created

Example: "2022-03-29T10:22:22.420Z"
updatedAtstring(date-time)required

The date and time the connection was updated

Example: "2022-03-29T10:22:22.420Z"
statusstring(v2ConnectionStatus)required
Enum"CREATED""PROPOSING""PROPOSED""CONNECTED""DISCONNECTED""REJECTED""UNSUPPORTED""EXPIRED""ERROR"
proposerobject(v2Proposer)
Response
application/json
{
  "id": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "walletId": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "vaultId": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "organizationId": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "createdBy": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "createdAt": "2022-03-29T10:22:22.420Z",
  "updatedAt": "2022-03-29T10:22:22.420Z",
  "status": "CREATED",
  "proposer": {
    "publicKey": "497f83bc461e9ec55be08592cecea561ccd713781954d313976feb2d7d93293a",
    "metadata": { … }
  }
}

Reject a wallet connect connection

Request

Reject a wallet connect connection by ID

Security
TokenAuth
Path
vaultIdstringrequired

The vault ID that the connection is associated with

walletIdstringrequired

The wallet ID that the connection is associated with

idstringrequired

The connection ID

curl -i -X PUT \
  'https://docs.ripple.com/_mock/products/palisade/api-docs/palisade-api/palisade-api-1/v2/vaults/{vaultId}/wallets/{walletId}/connections/{id}/reject' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
idstringrequired

The connection ID

Example: "ce4918bf-a199-4ce2-85a3-d0d296855384"
walletIdstringrequired

The wallet ID that the connection is associated with

Example: "ce4918bf-a199-4ce2-85a3-d0d296855384"
vaultIdstringrequired

The vault ID that the connection is associated with

Example: "ce4918bf-a199-4ce2-85a3-d0d296855384"
organizationIdstringrequired

The organization ID that the connection is associated with

Example: "ce4918bf-a199-4ce2-85a3-d0d296855384"
createdBystringrequired

The user ID that the connection is associated with

Example: "ce4918bf-a199-4ce2-85a3-d0d296855384"
createdAtstring(date-time)required

The date and time the connection was created

Example: "2022-03-29T10:22:22.420Z"
updatedAtstring(date-time)required

The date and time the connection was updated

Example: "2022-03-29T10:22:22.420Z"
statusstring(v2ConnectionStatus)required
Enum"CREATED""PROPOSING""PROPOSED""CONNECTED""DISCONNECTED""REJECTED""UNSUPPORTED""EXPIRED""ERROR"
proposerobject(v2Proposer)
Response
application/json
{
  "id": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "walletId": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "vaultId": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "organizationId": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "createdBy": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "createdAt": "2022-03-29T10:22:22.420Z",
  "updatedAt": "2022-03-29T10:22:22.420Z",
  "status": "CREATED",
  "proposer": {
    "publicKey": "497f83bc461e9ec55be08592cecea561ccd713781954d313976feb2d7d93293a",
    "metadata": { … }
  }
}

Webhooks

Used to manage webhooks

Operations

Registry

Operations

Transactions - Sweep

Operations

Sweep Instances

Operations