/
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 4d ago
View markdown
Accounts
16
Backups
3
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
Domains
2
Endpoints
2
Event Distribution Service
9
Events
1
Exports
2
Gas station
19
Gas station (obsolete)
17
Genesis
1
Intents
7
Internal transfers
3
Ledgers
6
Omnibus
4
Policies
2
Requests
3
Sweep thresholds
2
SystemProperties
1
SystemSigning
1
Tenants
6
Tickers
2
Transactions
7
TrustedPublicKeys
3
User invitations
8
Users
4
Vaults
4
Withdrawals
1
Compliance
Performs a preview analysis of the wallet
post
/v1/domains/{domainId}/compliance/analysis/preview
Path parameters
domainId
string
uuid
required
Request body
union
required
object
required
OR
object
required
Response
OK
union
required
object
required
OR
object
required