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

MPC - Sessions

Used to manage MPC sessions

Operations

Organizations

Used to manage organizations

Operations

Get organization

Request

Get an organization

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

Responses

Bodyapplication/json
idstringrequired

The organization ID

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

The organization name

Example: "Palisade"
createdBystringrequired

The ID of the user who created this organization

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

The date and time the organization was created

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

The ID of the user who updated this organization

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

The date and time the organization was updated

Example: "2022-03-29T10:22:22.420Z"
settingsobject(v2OrganizationSettings)required
settings.​organizationTypestring(v2OrganizationType)required
Enum"CUSTODIAL""NON_CUSTODIAL"
settings.​enabledComplianceIntegrationsArray of strings(v2ComplianceIntegration)required
Items Enum"COMPLY""ELLIPTIC""NOTABENE"
settings.​enabledKeystoresArray of strings(v2Keystore)required
Items Enum"HSM""MPC"
settings.​regionstringrequired

The region in which the organization data is stored

Example: "France"
settings.​enabledbooleanrequired

Whether the organization is enabled

Example: true
settings.​logostring
settings.​legalNamestringrequired

The full legal name of the organization

Example: "Palisade Financial"
settings.​vaspNamestringrequired

The Virtual Asset Service Provider

Example: "Palisade Financial"
settings.​vaspDidstringrequired

The Virtual Asset Service Providers' Decentralized Identifier

Example: "did:example:123456789abcdefghi"
settings.​allowRawSigningboolean

Whether the organization can create raw signed transactions (PALISADE_RAW). Defaults based on organization_type: false for CUSTODIAL, true for NON_CUSTODIAL.

Example: false
settings.​allowNonVettedAssetsboolean

Whether the organization can transact with non-vetted assets. Defaults based on organization_type: false for CUSTODIAL, true for NON_CUSTODIAL.

Example: false
settings.​allowConnectionsboolean

Whether the organization can use WalletConnect/Web3 connections (WEB3_RAW, WEB3_SIGN). Defaults based on organization_type: false for CUSTODIAL, true for NON_CUSTODIAL.

Example: false
settings.​allowFreezeboolean

Whether Palisade can freeze/unfreeze transactions. Defaults based on organization_type: true for CUSTODIAL, false for NON_CUSTODIAL.

Example: true
addressobject(commonv2Address)required
address.​address1stringrequired

The first line of the address

Example: "Flat B"
address.​address2string

The second line of the address

Example: "10 Mayo Road"
address.​citystringrequired

The city of the address

Example: "London"
address.​statestringrequired

The state of the address

Example: "Greater London"
address.​postCodestringrequired

The postal code of the address

Example: "W1 1AA"
address.​countrystringrequired

The country of the address

Example: "United Kingdom"
Response
application/json
{
  "id": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "name": "Palisade",
  "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",
  "settings": {
    "organizationType": "CUSTODIAL",
    "enabledComplianceIntegrations": [ … ],
    "enabledKeystores": [ … ],
    "region": "France",
    "enabled": true,
    "logo": "string",
    "legalName": "Palisade Financial",
    "vaspName": "Palisade Financial",
    "vaspDid": "did:example:123456789abcdefghi",
    "allowRawSigning": false,
    "allowNonVettedAssets": false,
    "allowConnections": false,
    "allowFreeze": true
  },
  "address": {
    "address1": "Flat B",
    "address2": "10 Mayo Road",
    "city": "London",
    "state": "Greater London",
    "postCode": "W1 1AA",
    "country": "United Kingdom"
  }
}

List authentication methods

Request

List an organizations authentication methods

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

Responses

Bodyapplication/jsonArray [
idstringrequired

The ID of the authentication method

Example: "con_PCUH08Sxb4Sxg22Q"
namestringrequired

The name of the authentication method

Example: "customer-ui-password"
strategystringrequired

The strategy of the authentication method

Example: "auth0"
defaultbooleanrequired

Whether this is the default authentication method for the organization

Example: true
idpSettingsobject(v2OrganizationAuthMethodIdpSettings)required
idpSettings.​enabledbooleanrequired

Whether IDP is enabled for this authentication method

Example: true
]
Response
application/json
[
  {
    "id": "con_PCUH08Sxb4Sxg22Q",
    "name": "customer-ui-password",
    "strategy": "auth0",
    "default": true,
    "idpSettings": { … }
  }
]

Get an authentication method

Request

Get a specific organization authentication method

Security
TokenAuth
Path
idstringrequired

The auth method ID

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

Responses

Bodyapplication/json
idstringrequired

The ID of the authentication method

Example: "con_PCUH08Sxb4Sxg22Q"
namestringrequired

The name of the authentication method

Example: "customer-ui-password"
strategystringrequired

The strategy of the authentication method

Example: "auth0"
defaultbooleanrequired

Whether this is the default authentication method for the organization

Example: true
idpSettingsobject(v2OrganizationAuthMethodIdpSettings)required
idpSettings.​enabledbooleanrequired

Whether IDP is enabled for this authentication method

Example: true
Response
application/json
{
  "id": "con_PCUH08Sxb4Sxg22Q",
  "name": "customer-ui-password",
  "strategy": "auth0",
  "default": true,
  "idpSettings": {
    "enabled": true
  }
}

Delete an authentication method

Request

Delete a specific organization authentication method

Security
TokenAuth
Path
idstringrequired

The auth method ID

curl -i -X DELETE \
  'https://docs.ripple.com/_mock/products/palisade/api-docs/palisade-api/palisade-api/v2/organizations/auth-methods/{id}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

A successful response.

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

Set default authentication method

Request

Set the default authentication method for an organization

Security
TokenAuth
Path
idstringrequired

The auth method ID

curl -i -X PUT \
  'https://docs.ripple.com/_mock/products/palisade/api-docs/palisade-api/palisade-api/v2/organizations/auth-methods/{id}/default' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
idstringrequired

The ID of the authentication method

Example: "con_PCUH08Sxb4Sxg22Q"
namestringrequired

The name of the authentication method

Example: "customer-ui-password"
strategystringrequired

The strategy of the authentication method

Example: "auth0"
defaultbooleanrequired

Whether this is the default authentication method for the organization

Example: true
idpSettingsobject(v2OrganizationAuthMethodIdpSettings)required
idpSettings.​enabledbooleanrequired

Whether IDP is enabled for this authentication method

Example: true
Response
application/json
{
  "id": "con_PCUH08Sxb4Sxg22Q",
  "name": "customer-ui-password",
  "strategy": "auth0",
  "default": true,
  "idpSettings": {
    "enabled": true
  }
}

Update authentication method IDP settings

Request

Update the IDP settings for an authentication method

Security
TokenAuth
Path
idstringrequired

The auth method ID

Bodyapplication/jsonrequired
enabledbooleanrequired

Whether IDP is enabled for this authentication method

Example: true
curl -i -X PUT \
  'https://docs.ripple.com/_mock/products/palisade/api-docs/palisade-api/palisade-api/v2/organizations/auth-methods/{id}/idp' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "enabled": true
  }'

Responses

Bodyapplication/json
enabledbooleanrequired

Whether IDP is enabled for this authentication method

Example: true
Response
application/json
{
  "enabled": true
}

Generate a self service SSO ticket

Request

Generate a self service ticket to setup SSO

Security
TokenAuth
curl -i -X POST \
  https://docs.ripple.com/_mock/products/palisade/api-docs/palisade-api/palisade-api/v2/organizations/self-service-sso-ticket \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

A successful response.

Bodyapplication/json
ticketstring
Response
application/json
{
  "ticket": "string"
}

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