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 Beneficiary confirmation API

Use these operations to perform beneficiary confirmations.| Operation | Method | Description || -- | -- | -- || [Get account lookup by status](/products/payments-odl/api-docs/ripplenet/reference/openapi/beneficiary-confirmation/getaccountlookupbystatus) | GET | Get Account Lookup entities by status and other filters. || [Initiate account lookup](/products/payments-odl/api-docs/ripplenet/reference/openapi/beneficiary-confirmation/initiateaccountlookup) | POST | Creates an Account Lookup request to validate a beneficiary's account details before sending a payment. || [Complete account lookup](/products/payments-odl/api-docs/ripplenet/reference/openapi/beneficiary-confirmation/completeaccountlookup) | POST | Posts an Account Lookup response to validate a beneficiary's account details before payment. || [Get account lookup by ID](/products/payments-odl/api-docs/ripplenet/reference/openapi/beneficiary-confirmation/getaccountlookupbyid) | GET | Gets an Account Lookup entity for its `account_lookup_id` value. |

Ripple Labs Beneficiary confirmation 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 Beneficiary confirmation. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.

This API exposes 4 operations across 4 paths, and defines 8 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.

4 operations 4 paths 8 schemas 2 GET2 POST

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 Beneficiary confirmation 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 4

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

Beneficiary confirmation 4

Use these operations to perform beneficiary confirmations. | Operation | Method | Description | | -- | -- | -- | | [Get account lookup by status](/products/payments-odl/api-docs/r…

GET
/account_lookups
Get account lookup by status
getAccountLookupByStatus 7 params → 200400404500
POST
/account_lookups/request
Initiate account lookup
initiateAccountLookup body → 200400500
POST
/account_lookups/response
Complete account lookup
completeAccountLookup body → 200400404500
GET
/account_lookups/{account_lookup_id}
Get account lookup by ID
getAccountLookupById 1 param → 200400404500

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are AccountLookup (23 properties), CompleteAccountLookupRequest (14 properties), InitiateAccountLookupRequest (10 properties), Page (8 properties). Each schema is shown below with its type and property counts.

Sort
object
6 properties
CompleteAccountLookupRequest
object
Complete account lookup request to validate the Beneficiary before initiating the payment.
14 properties 4 required
AccountLookups
Paged response for account lookups
Page
object
Paginated response base object.
8 properties
InitiateAccountLookupRequest
object
Initiate account lookup request to validate a beneficiary's account details before sending a payment.
10 properties 4 required
AccountLookup
object
Response to the sender/receiver for Account Lookup.
23 properties 2 required
AccountLookupStatus
string
RippleNetProblem
object
Represents a request to create and update a payout method record.
6 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ripple-labs-beneficiary-confirmation-api-openapi.yml Raw ↑

Other APIs Ripple Labs publishes across the network.

Ripple Labs Addresses API
Ripple Labs API Credentials API
Ripple Labs Auditing API
Ripple Labs Authentication API
Ripple Labs Balances and statements API
Ripple Labs Balances 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