Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Ripple Labs Auditing API

Use these operations to audit your accounts.| Operation | Method | Description || -- | -- | -- || [Get audits](/products/payments-odl/api-docs/ripplenet/reference/openapi/auditing/getaudits) | GET | Gets an audit trail of user actions and configuration changes (to accounts, fees, and rates) on a RippleNet instance. || [Get event trail for payment](/products/payments-odl/api-docs/ripplenet/reference/openapi/auditing/geteventtrailforpayment) | GET | Gets an audit trail of a payment's state changes on a local RippleNet instance. |

Ripple Labs Auditing API is one of 36 APIs that Ripple Labs publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Auditing. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.

This API exposes 2 operations across 2 paths, and defines 6 schemas. It is described by OpenAPI 3.0.0, at version 2.0.

Requests are made against 2 base URLs: https://api.sandbox.palisade.co, https://api.palisade.co.

2 operations 2 paths 6 schemas 2 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
2.0
Base URL
https://api.ripple.com
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Ripple Labs Auditing API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (TokenAuth). By default, every request must be authenticated.

Paths & Operations 2

Across 2 paths, the API surfaces 2 operations — 2 GET. Each is listed below with its method, path, parameters, and response codes.

Auditing 2

Use these operations to audit your accounts. | Operation | Method | Description | | -- | -- | -- | | [Get audits](/products/payments-odl/api-docs/ripplenet/reference/openapi/audit…

GET
/audit
Get audits
getAudits 9 params → 200400
GET
/audit/payment/{id}
Get event trail for payment
getEventTrailForPayment 1 param → 200400

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are Page (8 properties), AuditEvent (8 properties), EventTrailEvent (7 properties), RippleNetProblem (6 properties). Each schema is shown below with its type and property counts.

Sort
object
6 properties
AuditEventResponse
Paged response for AuditEvent
AuditEvent
object
Represents an audit trail of user actions and configuration changes (to accounts, fees, and rates) on RippleNet.
8 properties
Page
object
Paginated response base object.
8 properties
RippleNetProblem
object
Represents a request to create and update a payout method record.
6 properties
EventTrailEvent
object
Represents a single event along the audit trail of a payment on RippleNet.
7 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ripple-labs-auditing-api-openapi.yml Raw ↑

Other APIs Ripple Labs publishes across the network.

Ripple Labs Addresses API
Ripple Labs API Credentials API
Ripple Labs Authentication API
Ripple Labs Balances and statements API
Ripple Labs Balances API
Ripple Labs Beneficiary confirmation API
Ripple Labs Counterparties API
Ripple Labs Diagnostics API
Ripple Labs Exchange transfers API
Ripple Labs Fees API
Ripple Labs Liquidations API
Ripple Labs Market Cap API