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

Search for VASPs

Request

Search for VASPs using the notabene search endpoint

Security
TokenAuth
Query
qstring

string to query

emailDomainstring

filter on email domain

chainalysisNamestring

filter on chainalysis name

hasAdminboolean

filter on hasAdmin (true or false)

badgestring

filter by badge

jurisdictionsstring

filter by jurisdictions (multiple jurisdictions can be provided as a comma-separated list)

fieldsstring

csv of fields to return

pageinteger(int32)

page number

perPageinteger(int32)

records per page

orderstring

field to order by

allboolean

return all records

listingTypestring

Choose how gateway VASPs and non-gateway VASPs are returned. By default, exclude_subsidiaries.

includeUncheckedVaspsboolean

Defaults to false Include VASPs that have not been internally checked

includeActiveSendersOnlyboolean

Defaults to false Include only VASPs that are actively sending transactions

includeActiveReceiversOnlyboolean

Defaults to false Include only VASPs that are actively receiving transactions

regulatoryStatusstring

Include only VASPs matching the specified regulatory status

networkStatusstring

Include only VASPs matching the specified network status

assetstring

Asset symbol, provide when filtering by wallet

reviewedByVaspDidstring

Include reviewed VASPs for the specified DID

showJurisdictionStatusboolean

Include jurisdiction status information

reviewValuestring

Include reviewed VASPs containing the specified value

reviewIncludeInWidgetArray of strings

Include VASPs based on review "included in widget" status

filterByJurisdictionStatusstring

Filter by specified jurisdiction status

curl -i -X GET \
  'https://docs.ripple.com/_mock/products/palisade/api-docs/palisade-api/palisade-api-1/v2/notabene/search?q=string&emailDomain=string&chainalysisName=string&hasAdmin=true&badge=string&jurisdictions=string&fields=string&page=0&perPage=0&order=string&all=true&listingType=string&includeUncheckedVasps=true&includeActiveSendersOnly=true&includeActiveReceiversOnly=true&regulatoryStatus=string&networkStatus=string&asset=string&reviewedByVaspDid=string&showJurisdictionStatus=true&reviewValue=string&reviewIncludeInWidget=string&filterByJurisdictionStatus=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

A successful response.

Bodyapplication/json
vaspsArray of objects(v2VASPInfoSimple)
paginationobject(v2NotabenePagination)
Response
application/json
{
  "vasps": [
    { … }
  ],
  "pagination": {
    "page": 0,
    "perPage": 0,
    "order": "string",
    "total": 0
  }
}

Create customer tokens

Request

Create a new notabene customer token

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

Responses

A successful response.

Bodyapplication/json
accessTokenstringrequired
scopestringrequired
tokenTypestringrequired
Response
application/json
{
  "accessToken": "string",
  "scope": "string",
  "tokenType": "string"
}

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