Ripple Custody Documentation
Plan, deploy, govern, integrate, and operate Ripple Custody.
Start by goal
Evaluate Ripple Custody
Check deployment models, prerequisites, and readiness before implementation.
Deploy and initialize
Plan infrastructure, install the platform, and verify the first deployment.
Design genesis governance
Model initial domains, users, and policies before genesis.
Manage governance
Manage domains, policies, endpoints, intents, and approvals after launch.
Manage accounts and assets
Create accounts, manage tokens, and operate asset workflows.
Send and monitor transactions
Build transactions, send and receive assets, and track lifecycle state.Build and integrate
Use the API
Register, authenticate, dry run, propose, approve, and track API changes.
Use the Java SDK
Use SDK concepts, entities, intent approval, and code examples.
Work with events and webhooks
Subscribe to events and deliver updates to downstream systems.
API reference
Look up REST operations, schemas, parameters, and responses.Operate in production
Deployment reference
Review deployment and values.yaml reference material.
Monitoring and observability
Run telemetry, log forwarding, events, and webhook delivery.
Disaster recovery
Recover the anti-rewind file and register disaster recovery keys.Upgrade and release notes
Plan releases, migration guides, compatibility checks, and rollbacks.Core concepts
Domains
Define governance boundaries and inheritance.
Policies
Control who can approve each governed action.
Intents and approvals
Understand proposal, approval, signing, and execution.
Users and roles
Model human users, service accounts, and permissions.
Accounts
Understand account structure and asset custody.
Vaults
Configure vaults and key-management boundaries.
Transactions
Follow the transaction lifecycle across ledgers.
Compliance
Plan screening, Travel Rule, and risk workflows.