/
RI
ripple
/
Ripple Custody API
Search skmtc…
⌘K
Docs
Sign in
Sign in
APIs
Generators
Stacks
Projects
Docs
History
Schema
Sources
Checked 6h ago · Updated 3d ago
latest
OpenAPI 3.0.1
2026-08-19
163
888
1007.6 KB
410038300d74
Accounts
16
get
List accounts
get
Get address from all generated addresses across domains
get
List compliance configurations for all accounts in a domain
get
Get compliance configuration for an account
put
Create or update compliance configuration for an account
get
Get account details
get
Retrieve all generated addresses
post
Generate new account external address
post
Generate new account external address
get
Retrieve latest external address
get
Retrieve account address
get
Get account confirmed balance for a specific ticker
get
Get account balances
post
Update account balances forcefully
get
List manifests
get
Get manifest details
Backups
3
get
Get Backup information
get
List Backups
get
Get Backup trusted entity details
Compliance
24
get
Retrieves configuration steps and provider connection status for the give domain
post
Connects different external providers with Custody
get
Retrieves screening rules for connected provider of the given domain
post
Creates screening rules for connected provider of the given domain
put
Enables or disables the preview screening for an existing provider connection
put
Pause/unpause an existing external provider connection
post
Create Compliance Policy Payload
post
Creates Domain payload
delete
Delete compliance domain
post
Check if compliance domain creation/injection is allowed
post
Retrieves compliance analysis against all established external providers.
post
Performs a preview analysis of the wallet
get
Gets Exception role for the domain
get
Retrieves connected provider connection details for the given domain
get
Gets Compliance policy for the domain
delete
Deletes provider connection and screening rules for the given domain & provider
post
Creates a TravelRule message for a transfer
get
Get a travel rule transfer by ID
post
Append PII to a travel rule message
post
Present end-to-end encrypted PII to a travel rule message without policy
post
Append end-to-end encrypted PII to a travel rule message
post
Get travel rule details for a batch of requests
get
List all relationships registered with the travel rule provider
post
Create a relationship with the travel rule provider
Deposits
3
get
Get deposit wallet status and addresses for a tenant
post
Create a deposit wallet for a tenant on first request
get
List deposit wallets for an omnibus (paginated)
Domains
2
get
Get domain details
get
List domains
Endpoints
2
get
List endpoints
get
Get endpoint details
Event Distribution Service
9
get
Get all channels
post
Create a channel
post
Test a channel
get
Get channel details
delete
Delete a channel
patch
Update a channel
get
Get all events for a channel
get
Get channel event details
get
Get all events
Events
1
get
List events
Exports
2
post
Generate a Position Report (balance snapshot)
post
Generate a Movement Report (transaction history)
Gas station
19
get
Get sponsor configuration for an account
put
Update a sponsor configuration
post
Create a sponsor configuration
delete
Delete a sponsor configuration
get
List all sponsor (gas station) accounts in a domain
get
Find which gas station sponsors a specific account
get
List gas stations that could sponsor a specific account
get
Resolve domain-wide sponsorship for a domain
get
List accounts in a domain with their sponsorship status
get
List sub-domains in a domain with their sponsorship status
get
List sponsorable domains
post
Add sponsored domains
get
List sponsorable accounts
post
Add sponsored accounts
put
Add a single sponsored account (idempotent)
delete
Remove a single sponsored account
get
Get audit events for sponsorship configuration changes
get
Liveness check
get
Readiness check
Gas station (obsolete)
17
get
Get sponsor configuration for an account
put
Update a sponsor configuration
post
Create a sponsor configuration
delete
Delete a sponsor configuration
get
List all sponsor (gas station) accounts in a domain
get
Find which gas station sponsors a specific account
get
List gas stations that could sponsor a specific account
get
Resolve domain-wide sponsorship for a domain
get
List accounts in a domain with their sponsorship status
get
List sub-domains in a domain with their sponsorship status
get
List sponsorable domains
post
Add sponsored domains
get
List sponsorable accounts
post
Add sponsored accounts
put
Add a single sponsored account (idempotent)
delete
Remove a single sponsored account
get
Get audit events for sponsorship configuration changes
Genesis
1
post
Run the genesis
Intents
7
post
Propose an intent
post
Approve an intent
post
Reject an intent
get
List intents
get
Get intent details
get
Get remaining users
post
Perform a dry-run for given intent payload
Internal transfers
3
post
Transfer funds between two tenants within the same omnibus
get
List internal transfers for an omnibus (paginated)
get
Get a single internal transfer by operation ID
Ledgers
6
get
List ledgers
get
Get ledger details
get
Get ledger's fee details
post
[Ethereum] Process contract call
get
Get trusted ledger details
get
List trusted ledgers
Omnibus
4
get
Get the omnibus structure for a domain
put
Update an omnibus structure
get
Get the omnibus structure for a domain
post
Create a new omnibus structure within a domain
Policies
2
get
List policies
get
Get policy details
Requests
3
get
Get request state
get
Get all user requests state
get
Get all user requests state in domain
Sweep thresholds
2
get
List sweep threshold configurations for a domain
put
Bulk update sweep threshold configurations
SystemProperties
1
get
List system properties
SystemSigning
1
get
Get the system-signing info
Tenants
6
get
Get a tenant by ID
put
Update a tenant
get
List all tenants within an omnibus structure
post
Create a new tenant within an omnibus structure
post
Unlock a tenant
post
Lock a tenant
Tickers
2
get
List tickers
get
Get ticker details
Transactions
7
get
List transaction orders
get
Get transaction order details
get
List transfers
get
Get transfer details
get
List transactions
get
Get transaction details
post
Dry run a transaction order
TrustedPublicKeys
3
get
List trusted-collection public keys
get
List api public keys
get
List messages public keys
User invitations
8
get
/v1/domains/{domainId}/users/invitations
post
/v1/domains/{domainId}/users/invitations
get
/v1/domains/{domainId}/users/invitations/{id}
post
/v1/domains/{domainId}/users/invitations/{id}/cancel
post
/v1/domains/{domainId}/users/invitations/{id}/renew
post
/v1/domains/{domainId}/users/invitations/{id}/complete
get
/v1/users/invitations/{idOrCode}
post
/v1/users/invitations/{idOrCode}
Users
4
get
List users
get
Get known users roles
get
Get user details
get
List users belonging to the same public key
Vaults
4
get
List vaults
get
Get vault details
get
/v1/vaults/{vaultId}/operations/prepared
post
/v1/vaults/operations/signed
Withdrawals
1
post
Initiate a withdrawal from a tenant to an external destination address
Backups
Get Backup information
get
/v1/backups/{backupId}
Path parameters
backupId
string
uuid
required
Response
CoreApiBackup
required
id
string
uuid
required
data
union
required
metadata
CoreEntityMetadata
required
additionalDetails
CoreBackupAdditionalDetails