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

List organization addresses

Request

List all addresses within the organization

Security
TokenAuth
Query
pageSizeinteger(int32)

The number of results to return per page (default 50, max 1000)

pageTokenstring

The token to retrieve the next page of results

addressstring

The on-chain address to search for

curl -i -X GET \
  'https://docs.ripple.com/_mock/products/palisade/api-docs/palisade-api/palisade-api/v2/addresses?pageSize=0&pageToken=string&address=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

A successful response.

Bodyapplication/json
filterobject(v2FilterResponse)
addressesArray of objects(counterpartyv2Address)
Response
application/json
{
  "filter": {
    "previousPageToken": "cGFnZV9zaXplPTEwJnBhZ2VfdG9rZW49MjA=",
    "nextPageToken": "cGFnZV9zaXplPTEwJnBhZ2VfdG9rZW49MjA=",
    "total": 100
  },
  "addresses": [
    { … }
  ]
}

List counterparty addresses

Request

List all addresses within a counterparty

Security
TokenAuth
Path
counterpartyIdstringrequired

The counterparty ID

Query
pageSizeinteger(int32)

The number of results to return per page (default 50, max 100)

pageTokenstring

The token to retrieve the next page of results

curl -i -X GET \
  'https://docs.ripple.com/_mock/products/palisade/api-docs/palisade-api/palisade-api/v2/counterparties/{counterpartyId}/addresses?pageSize=0&pageToken=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

A successful response.

Bodyapplication/json
filterobject(v2FilterResponse)
addressesArray of objects(counterpartyv2Address)
Response
application/json
{
  "filter": {
    "previousPageToken": "cGFnZV9zaXplPTEwJnBhZ2VfdG9rZW49MjA=",
    "nextPageToken": "cGFnZV9zaXplPTEwJnBhZ2VfdG9rZW49MjA=",
    "total": 100
  },
  "addresses": [
    { … }
  ]
}

Create addresses

Request

Create a new address

Security
TokenAuth
Path
counterpartyIdstringrequired

The counterparty ID

Bodyapplication/jsonrequired
custodianobject(v2Custodian)
termsAndConditionsAcceptedbooleanrequired

Whether the user has accepted the terms and conditions

Example: true
detailsobject(v2AddressDetails)required
details.​typestring(- EXTERNAL: INTERNAL = 2; JR - we don't need to support this initially)required
Value"EXTERNAL"
details.​externalAddressobject(v2ExternalAddress)
curl -i -X POST \
  'https://docs.ripple.com/_mock/products/palisade/api-docs/palisade-api/palisade-api/v2/counterparties/{counterpartyId}/addresses' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "custodian": {
      "name": "Palisade Financial",
      "dId": "did:example:123456789abcdefghi"
    },
    "termsAndConditionsAccepted": true,
    "details": {
      "type": "EXTERNAL",
      "externalAddress": {
        "address": "0x55502b9d5a68b0F8a48384352295BeD968aD8AA4",
        "name": "Treasury",
        "description": "Wallet used to store treasury funds",
        "blockchains": [
          "ETHEREUM"
        ]
      }
    }
  }'

Responses

Bodyapplication/json
addressIdstringrequired

The address ID

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

The counterparty ID

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

The organization ID

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

The ID of the user who created this address

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

The date and time the address was created

Example: "2022-03-29T10:22:22.420Z"
updatedBystringrequired

The ID of the user who updated this address

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

The date and time the address was updated

Example: "2022-03-29T10:22:22.420Z"
custodianobject(v2Custodian)
termsAndConditionsAcceptedbooleanrequired

Whether the user has accepted the terms and conditions

Example: true
detailsobject(v2AddressDetails)required
details.​typestring(- EXTERNAL: INTERNAL = 2; JR - we don't need to support this initially)required
Value"EXTERNAL"
details.​externalAddressobject(v2ExternalAddress)
statusstring(v2AddressStatus)required
Enum"CREATED""ENABLED""REJECTED""DELETED""ERROR""COMPLIANCE_PENDING""COMPLIANCE_COMPLETE""CREATION_APPROVAL_PENDING""CREATION_APPROVAL_COMPLETE""DELETION_APPROVAL_PENDING"
activebooleanrequired

Whether the address is active

Example: true
Response
application/json
{
  "addressId": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "counterpartyId": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "organizationId": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "createdBy": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "createdAt": "2022-03-29T10:22:22.420Z",
  "updatedBy": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "updatedAt": "2022-03-29T10:22:22.420Z",
  "custodian": {
    "name": "Palisade Financial",
    "dId": "did:example:123456789abcdefghi"
  },
  "termsAndConditionsAccepted": true,
  "details": {
    "type": "EXTERNAL",
    "externalAddress": { … }
  },
  "status": "CREATED",
  "active": true
}

Get addresses

Request

Get an address

Security
TokenAuth
Path
counterpartyIdstringrequired

The counterparty ID

addressIdstringrequired

The address ID

curl -i -X GET \
  'https://docs.ripple.com/_mock/products/palisade/api-docs/palisade-api/palisade-api/v2/counterparties/{counterpartyId}/addresses/{addressId}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
addressIdstringrequired

The address ID

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

The counterparty ID

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

The organization ID

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

The ID of the user who created this address

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

The date and time the address was created

Example: "2022-03-29T10:22:22.420Z"
updatedBystringrequired

The ID of the user who updated this address

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

The date and time the address was updated

Example: "2022-03-29T10:22:22.420Z"
custodianobject(v2Custodian)
termsAndConditionsAcceptedbooleanrequired

Whether the user has accepted the terms and conditions

Example: true
detailsobject(v2AddressDetails)required
details.​typestring(- EXTERNAL: INTERNAL = 2; JR - we don't need to support this initially)required
Value"EXTERNAL"
details.​externalAddressobject(v2ExternalAddress)
statusstring(v2AddressStatus)required
Enum"CREATED""ENABLED""REJECTED""DELETED""ERROR""COMPLIANCE_PENDING""COMPLIANCE_COMPLETE""CREATION_APPROVAL_PENDING""CREATION_APPROVAL_COMPLETE""DELETION_APPROVAL_PENDING"
activebooleanrequired

Whether the address is active

Example: true
Response
application/json
{
  "addressId": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "counterpartyId": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "organizationId": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "createdBy": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "createdAt": "2022-03-29T10:22:22.420Z",
  "updatedBy": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "updatedAt": "2022-03-29T10:22:22.420Z",
  "custodian": {
    "name": "Palisade Financial",
    "dId": "did:example:123456789abcdefghi"
  },
  "termsAndConditionsAccepted": true,
  "details": {
    "type": "EXTERNAL",
    "externalAddress": { … }
  },
  "status": "CREATED",
  "active": true
}

Delete addresses

Request

Delete an address

Security
TokenAuth
Path
counterpartyIdstringrequired

The counterparty ID

addressIdstringrequired

The address ID

curl -i -X DELETE \
  'https://docs.ripple.com/_mock/products/palisade/api-docs/palisade-api/palisade-api/v2/counterparties/{counterpartyId}/addresses/{addressId}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

A successful response.

Bodyapplication/json
object(v2DeleteAddressResponse)
Response
application/json
{}

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

Webhooks

Used to manage webhooks

Operations

Registry

Operations

Transactions - Sweep

Operations

Sweep Instances

Operations