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

List approval summaries

Request

Returns the list of approval summaries for the current user

Security
TokenAuth
Query
statusstring

The approval status

Enum"PROCESSING""APPROVED""REJECTED"
curl -i -X GET \
  'https://docs.ripple.com/_mock/products/palisade/api-docs/palisade-api/palisade-api-1/v2/approvals?status=PROCESSING' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/jsonArray [
approvalobject(approvalv2Approval)required
approval.​idstringrequired

The approval ID

Example: "ce4918bf-a199-4ce2-85a3-d0d296855384"
approval.​approvalSetIdstringrequired

The approval set ID

Example: "ce4918bf-a199-4ce2-85a3-d0d296855384"
approval.​userIdstringrequired

The user ID

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

The organization ID

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

The date and time the approval was created

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

The date and time the approval was updated

Example: "2022-03-29T10:22:22.420Z"
approval.​signaturestring(byte)

The signed approval

approval.​reasonsArray of stringsrequired

The reasons for an approval or rejection

Example: ["the transaction was not previously discussed"]
approval.​statusstring(approvalv2ApprovalStatus)required
Enum"PROCESSING""APPROVED""REJECTED"
summaryobject(approvalv2Summary)required
summary.​sourceIdstringrequired

The summary ID

Example: "ce4918bf-a199-4ce2-85a3-d0d296855384"
summary.​sourceTypestring(v2SourceType)required
Enum"TRANSACTION""DEVICE""API_CREDENTIAL""ALLOW_LIST_ENTRY""POLICY""USER""APPROVAL_GROUP""ADDRESS"
summary.​sourceRawstring(byte)required

The raw source containing the item to be approved

summary.​expiresAtstring(date-time)required

The date and time the approval set expires

Example: "2022-03-29T10:22:22.420Z"
summary.​metAtstring(date-time)

The date and time the approval set was met

Example: "2022-03-29T10:22:22.420Z"
summary.​currentApprovedCountinteger(int32)required

The current number of approvals

Example: 1
summary.​requiredApproverCountinteger(int32)required

The required number of approvals

Example: 3
summary.​statusstring(approvalv2ApprovalSetStatus)required
Enum"PENDING""MET""NOT_MET""EXPIRED""FAILED"
summary.​requestedBystring
summary.​actionstring(v2Action)
Enum"CREATE""READ""UPDATE""DELETE""ENABLE""DISABLE"
]
Response
application/json
[
  {
    "approval": { … },
    "summary": { … }
  }
]

Get approval summary

Request

Returns a specific approval summary for the current user

Security
TokenAuth
Path
idstringrequired

The approval summary ID

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

Responses

Bodyapplication/json
approvalobject(approvalv2Approval)required
approval.​idstringrequired

The approval ID

Example: "ce4918bf-a199-4ce2-85a3-d0d296855384"
approval.​approvalSetIdstringrequired

The approval set ID

Example: "ce4918bf-a199-4ce2-85a3-d0d296855384"
approval.​userIdstringrequired

The user ID

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

The organization ID

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

The date and time the approval was created

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

The date and time the approval was updated

Example: "2022-03-29T10:22:22.420Z"
approval.​signaturestring(byte)

The signed approval

approval.​reasonsArray of stringsrequired

The reasons for an approval or rejection

Example: ["the transaction was not previously discussed"]
approval.​statusstring(approvalv2ApprovalStatus)required
Enum"PROCESSING""APPROVED""REJECTED"
summaryobject(approvalv2Summary)required
summary.​sourceIdstringrequired

The summary ID

Example: "ce4918bf-a199-4ce2-85a3-d0d296855384"
summary.​sourceTypestring(v2SourceType)required
Enum"TRANSACTION""DEVICE""API_CREDENTIAL""ALLOW_LIST_ENTRY""POLICY""USER""APPROVAL_GROUP""ADDRESS"
summary.​sourceRawstring(byte)required

The raw source containing the item to be approved

summary.​expiresAtstring(date-time)required

The date and time the approval set expires

Example: "2022-03-29T10:22:22.420Z"
summary.​metAtstring(date-time)

The date and time the approval set was met

Example: "2022-03-29T10:22:22.420Z"
summary.​currentApprovedCountinteger(int32)required

The current number of approvals

Example: 1
summary.​requiredApproverCountinteger(int32)required

The required number of approvals

Example: 3
summary.​statusstring(approvalv2ApprovalSetStatus)required
Enum"PENDING""MET""NOT_MET""EXPIRED""FAILED"
summary.​requestedBystring
summary.​actionstring(v2Action)
Enum"CREATE""READ""UPDATE""DELETE""ENABLE""DISABLE"
Response
application/json
{
  "approval": {
    "id": "ce4918bf-a199-4ce2-85a3-d0d296855384",
    "approvalSetId": "ce4918bf-a199-4ce2-85a3-d0d296855384",
    "userId": "ce4918bf-a199-4ce2-85a3-d0d296855384",
    "organizationId": "ce4918bf-a199-4ce2-85a3-d0d296855384",
    "createdAt": "2022-03-29T10:22:22.420Z",
    "updatedAt": "2022-03-29T10:22:22.420Z",
    "signature": "string",
    "reasons": [ … ],
    "status": "PROCESSING"
  },
  "summary": {
    "sourceId": "ce4918bf-a199-4ce2-85a3-d0d296855384",
    "sourceType": "TRANSACTION",
    "sourceRaw": "string",
    "expiresAt": "2022-03-29T10:22:22.420Z",
    "metAt": "2022-03-29T10:22:22.420Z",
    "currentApprovedCount": 1,
    "requiredApproverCount": 3,
    "status": "PENDING",
    "requestedBy": "string",
    "action": "CREATE"
  }
}

Update approval summary

Request

Update the approval summary to either approve or reject the request

Security
TokenAuth
Path
idstringrequired

The approval ID

Bodyapplication/jsonrequired
signaturestring(byte)

The approval signature

reasonsArray of stringsrequired

The reasons for an approval or rejection

Example: ["the transaction was not previously discussed"]
statusstring(approvalv2ApprovalStatus)required
Enum"PROCESSING""APPROVED""REJECTED"
curl -i -X PUT \
  'https://docs.ripple.com/_mock/products/palisade/api-docs/palisade-api/palisade-api-1/v2/approvals/{id}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "signature": "string",
    "reasons": [
      "the transaction was not previously discussed"
    ],
    "status": "PROCESSING"
  }'

Responses

Bodyapplication/json
approvalobject(approvalv2Approval)required
approval.​idstringrequired

The approval ID

Example: "ce4918bf-a199-4ce2-85a3-d0d296855384"
approval.​approvalSetIdstringrequired

The approval set ID

Example: "ce4918bf-a199-4ce2-85a3-d0d296855384"
approval.​userIdstringrequired

The user ID

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

The organization ID

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

The date and time the approval was created

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

The date and time the approval was updated

Example: "2022-03-29T10:22:22.420Z"
approval.​signaturestring(byte)

The signed approval

approval.​reasonsArray of stringsrequired

The reasons for an approval or rejection

Example: ["the transaction was not previously discussed"]
approval.​statusstring(approvalv2ApprovalStatus)required
Enum"PROCESSING""APPROVED""REJECTED"
summaryobject(approvalv2Summary)required
summary.​sourceIdstringrequired

The summary ID

Example: "ce4918bf-a199-4ce2-85a3-d0d296855384"
summary.​sourceTypestring(v2SourceType)required
Enum"TRANSACTION""DEVICE""API_CREDENTIAL""ALLOW_LIST_ENTRY""POLICY""USER""APPROVAL_GROUP""ADDRESS"
summary.​sourceRawstring(byte)required

The raw source containing the item to be approved

summary.​expiresAtstring(date-time)required

The date and time the approval set expires

Example: "2022-03-29T10:22:22.420Z"
summary.​metAtstring(date-time)

The date and time the approval set was met

Example: "2022-03-29T10:22:22.420Z"
summary.​currentApprovedCountinteger(int32)required

The current number of approvals

Example: 1
summary.​requiredApproverCountinteger(int32)required

The required number of approvals

Example: 3
summary.​statusstring(approvalv2ApprovalSetStatus)required
Enum"PENDING""MET""NOT_MET""EXPIRED""FAILED"
summary.​requestedBystring
summary.​actionstring(v2Action)
Enum"CREATE""READ""UPDATE""DELETE""ENABLE""DISABLE"
Response
application/json
{
  "approval": {
    "id": "ce4918bf-a199-4ce2-85a3-d0d296855384",
    "approvalSetId": "ce4918bf-a199-4ce2-85a3-d0d296855384",
    "userId": "ce4918bf-a199-4ce2-85a3-d0d296855384",
    "organizationId": "ce4918bf-a199-4ce2-85a3-d0d296855384",
    "createdAt": "2022-03-29T10:22:22.420Z",
    "updatedAt": "2022-03-29T10:22:22.420Z",
    "signature": "string",
    "reasons": [ … ],
    "status": "PROCESSING"
  },
  "summary": {
    "sourceId": "ce4918bf-a199-4ce2-85a3-d0d296855384",
    "sourceType": "TRANSACTION",
    "sourceRaw": "string",
    "expiresAt": "2022-03-29T10:22:22.420Z",
    "metAt": "2022-03-29T10:22:22.420Z",
    "currentApprovedCount": 1,
    "requiredApproverCount": 3,
    "status": "PENDING",
    "requestedBy": "string",
    "action": "CREATE"
  }
}

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

Webhooks

Used to manage webhooks

Operations

Registry

Operations

Transactions - Sweep

Operations

Sweep Instances

Operations