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

List all devices

Request

List all devices associated with a user or organization

Security
TokenAuth
Query
deviceTypestringrequired

The device type

Enum"MOBILE""CLOUD"
deviceOwnerstring

The device owner

Enum"THIS_ORGANIZATION""TRUSTED_ORGANIZATION"
curl -i -X GET \
  'https://docs.ripple.com/_mock/products/palisade/api-docs/palisade-api/palisade-api/v2/devices?deviceType=MOBILE&deviceOwner=THIS_ORGANIZATION' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/jsonArray [
idstringrequired

The device ID

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

The organization ID

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

The user ID that created the device

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

The date and time the device was created

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

The date and time the device was paired

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

The date and time the device was updated

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

The client ID

Example: "muDigc2N34HnKJh28l9pK6d0lBOFAe"
displayNamestringrequired

The name of the device

Example: "Treasury vault"
approvalStatusstring(devicev2ApprovalStatus)required
Enum"PENDING""APPROVED""REJECTED"
enabledStatusstring(v2EnabledStatus)required
Enum"ENABLED_STATUS_PENDING""ENABLED""DISABLED"
publicKeyHashstringrequired

The hash of the devices public key

Example: "muDigc2N34HnKJh28l9pK6d0lBOFAe"
deletedbooleanrequired

Whether the device has been deleted

Example: "false"
deviceTypestring(v2DeviceType)required
Enum"MOBILE""CLOUD"
playerIdinteger(int64)

The player ID

Example: 123456
versionstring

The version of the device

Example: "1.0.0"
]
Response
application/json
[
  {
    "id": "ce4918bf-a199-4ce2-85a3-d0d296855384",
    "organizationId": "ce4918bf-a199-4ce2-85a3-d0d296855384",
    "createdBy": "ce4918bf-a199-4ce2-85a3-d0d296855384",
    "createdAt": "2022-03-29T10:22:22.420Z",
    "pairedAt": "2022-03-29T10:22:22.420Z",
    "updatedAt": "2022-03-29T10:22:22.420Z",
    "clientId": "muDigc2N34HnKJh28l9pK6d0lBOFAe",
    "displayName": "Treasury vault",
    "approvalStatus": "PENDING",
    "enabledStatus": "ENABLED_STATUS_PENDING",
    "publicKeyHash": "muDigc2N34HnKJh28l9pK6d0lBOFAe",
    "deleted": "false",
    "deviceType": "MOBILE",
    "playerId": 123456,
    "version": "1.0.0"
  }
]

Create a new device

Request

Create a new device in your organization ready to pair with a physical device

Security
TokenAuth
Bodyapplication/jsonrequired
displayNamestringrequired

The name of the device

Example: "Treasury vault"
deviceTypestring(v2DeviceType)required
Enum"MOBILE""CLOUD"
curl -i -X POST \
  https://docs.ripple.com/_mock/products/palisade/api-docs/palisade-api/palisade-api/v2/devices \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "displayName": "Treasury vault",
    "deviceType": "MOBILE"
  }'

Responses

Bodyapplication/json
idstringrequired

The device ID

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

The organization ID

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

The user ID that created the device

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

The date and time the device was created

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

The date and time the device was paired

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

The date and time the device was updated

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

The client ID

Example: "muDigc2N34HnKJh28l9pK6d0lBOFAe"
displayNamestringrequired

The name of the device

Example: "Treasury vault"
approvalStatusstring(devicev2ApprovalStatus)required
Enum"PENDING""APPROVED""REJECTED"
enabledStatusstring(v2EnabledStatus)required
Enum"ENABLED_STATUS_PENDING""ENABLED""DISABLED"
publicKeyHashstringrequired

The hash of the devices public key

Example: "muDigc2N34HnKJh28l9pK6d0lBOFAe"
deletedbooleanrequired

Whether the device has been deleted

Example: "false"
deviceTypestring(v2DeviceType)required
Enum"MOBILE""CLOUD"
playerIdinteger(int64)

The player ID

Example: 123456
versionstring

The version of the device

Example: "1.0.0"
Response
application/json
{
  "id": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "organizationId": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "createdBy": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "createdAt": "2022-03-29T10:22:22.420Z",
  "pairedAt": "2022-03-29T10:22:22.420Z",
  "updatedAt": "2022-03-29T10:22:22.420Z",
  "clientId": "muDigc2N34HnKJh28l9pK6d0lBOFAe",
  "displayName": "Treasury vault",
  "approvalStatus": "PENDING",
  "enabledStatus": "ENABLED_STATUS_PENDING",
  "publicKeyHash": "muDigc2N34HnKJh28l9pK6d0lBOFAe",
  "deleted": "false",
  "deviceType": "MOBILE",
  "playerId": 123456,
  "version": "1.0.0"
}

Get device credentials

Request

Get device credentials for the device specified in the JWT

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

Responses

A successful response.

Bodyapplication/json
mqCredentialsobject(v2MQCredentials)
Response
application/json
{
  "mqCredentials": {
    "host": "string",
    "username": "string",
    "password": "string"
  }
}

Add device metadata

Request

Add key/value metadata to the device specified in the JWT

Security
TokenAuth
Bodyapplication/jsonrequired
keystring
valuestring
curl -i -X POST \
  https://docs.ripple.com/_mock/products/palisade/api-docs/palisade-api/palisade-api/v2/devices/metadata \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "key": "string",
    "value": "string"
  }'

Responses

A successful response.

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

Pair a device with an organization

Request

Pair the device specified in the JWT

Security
TokenAuth
Bodyapplication/jsonrequired
credentialstringrequired
curl -i -X POST \
  https://docs.ripple.com/_mock/products/palisade/api-docs/palisade-api/palisade-api/v2/devices/pair-with-credential \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "credential": "string"
  }'

Responses

Bodyapplication/json
idstringrequired

The device ID

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

The organization ID

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

The user ID that created the device

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

The date and time the device was created

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

The date and time the device was paired

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

The date and time the device was updated

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

The client ID

Example: "muDigc2N34HnKJh28l9pK6d0lBOFAe"
displayNamestringrequired

The name of the device

Example: "Treasury vault"
approvalStatusstring(devicev2ApprovalStatus)required
Enum"PENDING""APPROVED""REJECTED"
enabledStatusstring(v2EnabledStatus)required
Enum"ENABLED_STATUS_PENDING""ENABLED""DISABLED"
publicKeyHashstringrequired

The hash of the devices public key

Example: "muDigc2N34HnKJh28l9pK6d0lBOFAe"
deletedbooleanrequired

Whether the device has been deleted

Example: "false"
deviceTypestring(v2DeviceType)required
Enum"MOBILE""CLOUD"
playerIdinteger(int64)

The player ID

Example: 123456
versionstring

The version of the device

Example: "1.0.0"
Response
application/json
{
  "id": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "organizationId": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "createdBy": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "createdAt": "2022-03-29T10:22:22.420Z",
  "pairedAt": "2022-03-29T10:22:22.420Z",
  "updatedAt": "2022-03-29T10:22:22.420Z",
  "clientId": "muDigc2N34HnKJh28l9pK6d0lBOFAe",
  "displayName": "Treasury vault",
  "approvalStatus": "PENDING",
  "enabledStatus": "ENABLED_STATUS_PENDING",
  "publicKeyHash": "muDigc2N34HnKJh28l9pK6d0lBOFAe",
  "deleted": "false",
  "deviceType": "MOBILE",
  "playerId": 123456,
  "version": "1.0.0"
}

Get push notification token

Request

Get a new push notification token for the device specified in the JWT

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

Responses

A successful response.

Bodyapplication/json
tokenstring
Response
application/json
{
  "token": "string"
}

Get device

Request

Get the device specified in the JWT

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

Responses

Bodyapplication/json
idstringrequired

The device ID

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

The organization ID

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

The user ID that created the device

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

The date and time the device was created

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

The date and time the device was paired

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

The date and time the device was updated

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

The client ID

Example: "muDigc2N34HnKJh28l9pK6d0lBOFAe"
displayNamestringrequired

The name of the device

Example: "Treasury vault"
approvalStatusstring(devicev2ApprovalStatus)required
Enum"PENDING""APPROVED""REJECTED"
enabledStatusstring(v2EnabledStatus)required
Enum"ENABLED_STATUS_PENDING""ENABLED""DISABLED"
publicKeyHashstringrequired

The hash of the devices public key

Example: "muDigc2N34HnKJh28l9pK6d0lBOFAe"
deletedbooleanrequired

Whether the device has been deleted

Example: "false"
deviceTypestring(v2DeviceType)required
Enum"MOBILE""CLOUD"
playerIdinteger(int64)

The player ID

Example: 123456
versionstring

The version of the device

Example: "1.0.0"
Response
application/json
{
  "id": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "organizationId": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "createdBy": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "createdAt": "2022-03-29T10:22:22.420Z",
  "pairedAt": "2022-03-29T10:22:22.420Z",
  "updatedAt": "2022-03-29T10:22:22.420Z",
  "clientId": "muDigc2N34HnKJh28l9pK6d0lBOFAe",
  "displayName": "Treasury vault",
  "approvalStatus": "PENDING",
  "enabledStatus": "ENABLED_STATUS_PENDING",
  "publicKeyHash": "muDigc2N34HnKJh28l9pK6d0lBOFAe",
  "deleted": "false",
  "deviceType": "MOBILE",
  "playerId": 123456,
  "version": "1.0.0"
}

Set device version

Request

Set the version of the device specified in the JWT

Security
TokenAuth
Bodyapplication/jsonrequired
versionstring
curl -i -X POST \
  https://docs.ripple.com/_mock/products/palisade/api-docs/palisade-api/palisade-api/v2/devices/version \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "version": "string"
  }'

Responses

A successful response.

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

Get a device

Request

Get a specific device by ID

Security
TokenAuth
Path
idstringrequired

The device ID

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

Responses

Bodyapplication/json
idstringrequired

The device ID

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

The organization ID

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

The user ID that created the device

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

The date and time the device was created

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

The date and time the device was paired

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

The date and time the device was updated

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

The client ID

Example: "muDigc2N34HnKJh28l9pK6d0lBOFAe"
displayNamestringrequired

The name of the device

Example: "Treasury vault"
approvalStatusstring(devicev2ApprovalStatus)required
Enum"PENDING""APPROVED""REJECTED"
enabledStatusstring(v2EnabledStatus)required
Enum"ENABLED_STATUS_PENDING""ENABLED""DISABLED"
publicKeyHashstringrequired

The hash of the devices public key

Example: "muDigc2N34HnKJh28l9pK6d0lBOFAe"
deletedbooleanrequired

Whether the device has been deleted

Example: "false"
deviceTypestring(v2DeviceType)required
Enum"MOBILE""CLOUD"
playerIdinteger(int64)

The player ID

Example: 123456
versionstring

The version of the device

Example: "1.0.0"
Response
application/json
{
  "id": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "organizationId": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "createdBy": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "createdAt": "2022-03-29T10:22:22.420Z",
  "pairedAt": "2022-03-29T10:22:22.420Z",
  "updatedAt": "2022-03-29T10:22:22.420Z",
  "clientId": "muDigc2N34HnKJh28l9pK6d0lBOFAe",
  "displayName": "Treasury vault",
  "approvalStatus": "PENDING",
  "enabledStatus": "ENABLED_STATUS_PENDING",
  "publicKeyHash": "muDigc2N34HnKJh28l9pK6d0lBOFAe",
  "deleted": "false",
  "deviceType": "MOBILE",
  "playerId": 123456,
  "version": "1.0.0"
}

Delete a device

Request

Delete a specific device by ID. This action can only be performed for unapproved devices at this time.

Security
TokenAuth
Path
idstringrequired

The device ID

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

Responses

Bodyapplication/json
idstringrequired

The device ID

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

The organization ID

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

The user ID that created the device

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

The date and time the device was created

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

The date and time the device was paired

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

The date and time the device was updated

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

The client ID

Example: "muDigc2N34HnKJh28l9pK6d0lBOFAe"
displayNamestringrequired

The name of the device

Example: "Treasury vault"
approvalStatusstring(devicev2ApprovalStatus)required
Enum"PENDING""APPROVED""REJECTED"
enabledStatusstring(v2EnabledStatus)required
Enum"ENABLED_STATUS_PENDING""ENABLED""DISABLED"
publicKeyHashstringrequired

The hash of the devices public key

Example: "muDigc2N34HnKJh28l9pK6d0lBOFAe"
deletedbooleanrequired

Whether the device has been deleted

Example: "false"
deviceTypestring(v2DeviceType)required
Enum"MOBILE""CLOUD"
playerIdinteger(int64)

The player ID

Example: 123456
versionstring

The version of the device

Example: "1.0.0"
Response
application/json
{
  "id": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "organizationId": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "createdBy": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "createdAt": "2022-03-29T10:22:22.420Z",
  "pairedAt": "2022-03-29T10:22:22.420Z",
  "updatedAt": "2022-03-29T10:22:22.420Z",
  "clientId": "muDigc2N34HnKJh28l9pK6d0lBOFAe",
  "displayName": "Treasury vault",
  "approvalStatus": "PENDING",
  "enabledStatus": "ENABLED_STATUS_PENDING",
  "publicKeyHash": "muDigc2N34HnKJh28l9pK6d0lBOFAe",
  "deleted": "false",
  "deviceType": "MOBILE",
  "playerId": 123456,
  "version": "1.0.0"
}

Update device approval status

Request

Update the approval status of a device by ID

Security
TokenAuth
Path
idstringrequired

The device ID

Bodyapplication/jsonrequired
approvalStatusstring(devicev2ApprovalStatus)required
Enum"PENDING""APPROVED""REJECTED"
curl -i -X PUT \
  'https://docs.ripple.com/_mock/products/palisade/api-docs/palisade-api/palisade-api/v2/devices/{id}/approval-status' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "approvalStatus": "PENDING"
  }'

Responses

Bodyapplication/json
idstringrequired

The device ID

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

The organization ID

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

The user ID that created the device

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

The date and time the device was created

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

The date and time the device was paired

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

The date and time the device was updated

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

The client ID

Example: "muDigc2N34HnKJh28l9pK6d0lBOFAe"
displayNamestringrequired

The name of the device

Example: "Treasury vault"
approvalStatusstring(devicev2ApprovalStatus)required
Enum"PENDING""APPROVED""REJECTED"
enabledStatusstring(v2EnabledStatus)required
Enum"ENABLED_STATUS_PENDING""ENABLED""DISABLED"
publicKeyHashstringrequired

The hash of the devices public key

Example: "muDigc2N34HnKJh28l9pK6d0lBOFAe"
deletedbooleanrequired

Whether the device has been deleted

Example: "false"
deviceTypestring(v2DeviceType)required
Enum"MOBILE""CLOUD"
playerIdinteger(int64)

The player ID

Example: 123456
versionstring

The version of the device

Example: "1.0.0"
Response
application/json
{
  "id": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "organizationId": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "createdBy": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "createdAt": "2022-03-29T10:22:22.420Z",
  "pairedAt": "2022-03-29T10:22:22.420Z",
  "updatedAt": "2022-03-29T10:22:22.420Z",
  "clientId": "muDigc2N34HnKJh28l9pK6d0lBOFAe",
  "displayName": "Treasury vault",
  "approvalStatus": "PENDING",
  "enabledStatus": "ENABLED_STATUS_PENDING",
  "publicKeyHash": "muDigc2N34HnKJh28l9pK6d0lBOFAe",
  "deleted": "false",
  "deviceType": "MOBILE",
  "playerId": 123456,
  "version": "1.0.0"
}

Update device display name

Request

Update the display name of a device by ID

Security
TokenAuth
Path
idstringrequired

The device ID

Bodyapplication/jsonrequired
displayNamestringrequired

The name of the device

Example: "Treasury vault"
curl -i -X PUT \
  'https://docs.ripple.com/_mock/products/palisade/api-docs/palisade-api/palisade-api/v2/devices/{id}/display-name' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "displayName": "Treasury vault"
  }'

Responses

Bodyapplication/json
idstringrequired

The device ID

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

The organization ID

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

The user ID that created the device

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

The date and time the device was created

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

The date and time the device was paired

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

The date and time the device was updated

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

The client ID

Example: "muDigc2N34HnKJh28l9pK6d0lBOFAe"
displayNamestringrequired

The name of the device

Example: "Treasury vault"
approvalStatusstring(devicev2ApprovalStatus)required
Enum"PENDING""APPROVED""REJECTED"
enabledStatusstring(v2EnabledStatus)required
Enum"ENABLED_STATUS_PENDING""ENABLED""DISABLED"
publicKeyHashstringrequired

The hash of the devices public key

Example: "muDigc2N34HnKJh28l9pK6d0lBOFAe"
deletedbooleanrequired

Whether the device has been deleted

Example: "false"
deviceTypestring(v2DeviceType)required
Enum"MOBILE""CLOUD"
playerIdinteger(int64)

The player ID

Example: 123456
versionstring

The version of the device

Example: "1.0.0"
Response
application/json
{
  "id": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "organizationId": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "createdBy": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "createdAt": "2022-03-29T10:22:22.420Z",
  "pairedAt": "2022-03-29T10:22:22.420Z",
  "updatedAt": "2022-03-29T10:22:22.420Z",
  "clientId": "muDigc2N34HnKJh28l9pK6d0lBOFAe",
  "displayName": "Treasury vault",
  "approvalStatus": "PENDING",
  "enabledStatus": "ENABLED_STATUS_PENDING",
  "publicKeyHash": "muDigc2N34HnKJh28l9pK6d0lBOFAe",
  "deleted": "false",
  "deviceType": "MOBILE",
  "playerId": 123456,
  "version": "1.0.0"
}

Update device enabled status

Request

Update the enabled status of a device by ID

Security
TokenAuth
Path
idstringrequired

The device ID

Bodyapplication/jsonrequired
enabledStatusstring(v2EnabledStatus)required
Enum"ENABLED_STATUS_PENDING""ENABLED""DISABLED"
curl -i -X PUT \
  'https://docs.ripple.com/_mock/products/palisade/api-docs/palisade-api/palisade-api/v2/devices/{id}/enabled-status' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "enabledStatus": "ENABLED_STATUS_PENDING"
  }'

Responses

Bodyapplication/json
idstringrequired

The device ID

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

The organization ID

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

The user ID that created the device

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

The date and time the device was created

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

The date and time the device was paired

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

The date and time the device was updated

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

The client ID

Example: "muDigc2N34HnKJh28l9pK6d0lBOFAe"
displayNamestringrequired

The name of the device

Example: "Treasury vault"
approvalStatusstring(devicev2ApprovalStatus)required
Enum"PENDING""APPROVED""REJECTED"
enabledStatusstring(v2EnabledStatus)required
Enum"ENABLED_STATUS_PENDING""ENABLED""DISABLED"
publicKeyHashstringrequired

The hash of the devices public key

Example: "muDigc2N34HnKJh28l9pK6d0lBOFAe"
deletedbooleanrequired

Whether the device has been deleted

Example: "false"
deviceTypestring(v2DeviceType)required
Enum"MOBILE""CLOUD"
playerIdinteger(int64)

The player ID

Example: 123456
versionstring

The version of the device

Example: "1.0.0"
Response
application/json
{
  "id": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "organizationId": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "createdBy": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "createdAt": "2022-03-29T10:22:22.420Z",
  "pairedAt": "2022-03-29T10:22:22.420Z",
  "updatedAt": "2022-03-29T10:22:22.420Z",
  "clientId": "muDigc2N34HnKJh28l9pK6d0lBOFAe",
  "displayName": "Treasury vault",
  "approvalStatus": "PENDING",
  "enabledStatus": "ENABLED_STATUS_PENDING",
  "publicKeyHash": "muDigc2N34HnKJh28l9pK6d0lBOFAe",
  "deleted": "false",
  "deviceType": "MOBILE",
  "playerId": 123456,
  "version": "1.0.0"
}

Get device pairing credentials

Request

Get a new set of pairing credentials for a device by ID

Security
TokenAuth
Path
idstringrequired

The device ID

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

Responses

Bodyapplication/json
idstringrequired

The device ID

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

The client ID

clientSecretstringrequired

The client secret

pairingKeystringrequired

The pairing key

Response
application/json
{
  "id": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "clientId": "string",
  "clientSecret": "string",
  "pairingKey": "string"
}

Trust organization

Request

Trust a new organization to use this device in it's controls

Security
TokenAuth
Path
idstringrequired

The device ID

Bodyapplication/jsonrequired
trustedOrganizationIdstringrequired

The trusted organization ID

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

The name of the trusted organization

Example: "Mega Corp"
curl -i -X POST \
  'https://docs.ripple.com/_mock/products/palisade/api-docs/palisade-api/palisade-api/v2/devices/{id}/trust-organization' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "trustedOrganizationId": "ce4918bf-a199-4ce2-85a3-d0d296855384",
    "trustedOrganizationName": "Mega Corp"
  }'

Responses

Bodyapplication/json
idstringrequired

The trusted organization ID

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

The name of the trusted organization

Example: "Mega Corp"
Response
application/json
{
  "id": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "name": "Mega Corp"
}

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