/* Target SVGs within the navbar that use the mask-image style */
#navbar svg[style*="mask-image"] {
  background-color: #85affd !important; /* Force the desired blue background */
}

/* Force white background on cards in the integrations logo group */
.card-group .card {
  background-color: white !important;
}

/* Set the light mode background color */
html:not(.dark) {
  background-color: #f8f4f2 !important;
} 

Use this endpoint to retrieve a customer record by its unique `id`.

Lookup a customer

An object containing the customer's address. This is optional, but if provided, all required fields must be present.

Primary address line (e.g., street, PO Box).

Secondary address line (e.g., apartment, suite, unit, or building).

City, district, suburb, town, or village.

PII required to trigger Patriot Act compliant KYC verification.

Masked date of birth in ****-**-** format.

Masked Social Security Number in the format ***-**-****.

Individual Compliance Profile

Business registration data required to trigger Patriot Act compliant KYB verification.

Masked Employer Identification Number in the format **-*******

The official registered name of the business. This name should be correlated with the `ein` value.

A list of people related to the company. Only valid where customer type is 'business'.

Official business website URL. Optional but recommended for enhanced KYB.

Business Compliance Profile

Timestamp of when the customer record was created.

Unique identifier for the customer in your database, used for cross-referencing between Straddle and your systems.

Full name of the individual or business name.

The customer's phone number in E.164 format.

Timestamp of the most recent update to the customer record.

The customer's IP address at the time of profile creation. Use `0.0.0.0` to represent an offline customer registration.

Specific message regarding this exact request.

Array of error objects with more specific details.

Predefined general type of error (e.g. '/field_validation')

Detailed description of the specific error.

Identifier for the error (e.g., field name, error code).

Metadata about the API request, including an identifier and timestamp.

Unique identifier for this API request, useful for troubleshooting.

Timestamp for this API request, useful for troubleshooting.

Indicates the structure of the returned content.
- "object" means the `data` field contains a single JSON object.
- "array" means the `data` field contains an array of objects.
- "error" means the `data` field contains an error object with details of the issue.
- "none" means no data is returned.

Retrieves the details of an existing customer. Supply the unique customer ID that was returned from your 'create customer' request, and Straddle will return the corresponding customer information.

Bearer

API environment for testing (sandbox) or live transactions (production)

Straddle Docs

We're here to help you build better bank payments.

Welcome

Welcome to Straddle

A quick overview of how Straddle is structured

Core Concepts

Start building open banking payment experiences in minutes

Quickstart

Introduction to Straddle's unified API for account-to-account payments

Pay by Bank

A (really) big list of key terms and concepts for the Straddle platform

Glossary

If you can solve identity in payments, the rest is just accounting.

Overview

Manage end users who send or receive payments through your integration

Customers

Understanding Business Identity verification

Business Identity

Understanding Straddle's risk assessment system, including decision logic, risk scores, and correlation scores

Models & Scoring

Understanding the reason codes returned by Straddle's Identity verification process

Reason Codes

Watchlists are used to prevent money-launding and terrorism.

Watchlists

Supercharge platform payments with Straddle Embed

Instantly onboard new merchants with Straddle Embed

Onboarding

Learn about synthetic identity fraud, its impact on businesses, and how Straddle can help

Synthetic Identity Fraud

WALDO is Straddle's proprietary identity matching algorithm designed to securely and accurately verify that a customer's identity matches the ownership details of their bank account.

WALDO

WALDO: Identity Matching

An overview of the Straddle API structure and usage

Introduction

Learn how to authenticate your requests to the Straddle API

Authentication

Understanding and using Straddle's sandbox and production environments

Environments

Understanding the structure of Straddle API responses

Response Format

Learn how to interpret and handle HTTP errors when working with the Straddle API

Errors

Learn how to use Request ID and Correlation ID for debugging and tracing API requests

Request ID

Learn how to use metadata to attach custom information to Straddle objects

Metadata

Learn how to make API calls on behalf of your embedded accounts as a Straddle platform

Embedded Accounts

Python SDK

Get started with the Straddle Node.js SDK

Node.js SDK

Use this endpoint to verify and onboard a new customer.

Create a customer

Use this endpoint to update an existing customer.

Update a Customer

Update a customer

Use this endpoint to review the identity and risk scores of an existing customer.

Review a customer

Use this endpoint to update the status of a customer who was flagged for [review](/api/customers/review). You can set the new status to `verified` or `rejected`.

Decision a customer

Use this endpoint to unmask a customer's sensitive PII data.

Unmask customer data

Permanently removes a customer record from Straddle. This action cannot be undone and should only be used to satisfy regulatory requirements or for privacy compliance.

Delete a customer

Use this endpoint to list or search for customers using filters or query parameters

List customers

Use this endpoint to generate a session token for the Bridge widget.

Initiate a widget session

Use this endpoint to use the Bridge API with a Plaid token.

Bridge a Plaid token

Use this endpoint to use the Bridge API with a 'raw' bank account.

Bridge a bank account

Use this endpoint to retrieve a paykey by its unique `id`.

Lookup a paykey

Use this endpoint to unmask a paykey's sensitive bank account data.

Unmask paykey data

Use this endpoint to search for paykeys using filters or query parameters.

Search paykeys

Create charges to collect payments from your customers for the goods or services you provide.

Create a charge

Update a charge to change the amount, date, or other details.

Update a charge

Use this endpoint to retrieve a charge by its unique `id`.

Lookup a charge

Place a charge on hold to prevent it from being processed. Only charges in `created` status can be placed on hold.

Hold a charge

Release a charge from hold to allow it to be processed. Only charges in `hold` status can be released.

Release a charge

Cancel a charge to prevent it from being processed. Only charges in a `created` or `hold` status can be canceled.

Cancel a charge

Use payouts to send money to your customers.

Create a payout

Update a payout to change the amount, date, or other details.

Update a payout

Use this endpoint to retrieve a payout by its unique `id`.

Lookup a payout

Hold a payout to prevent it from being processed. The status of the payout must be `created`, `scheduled`, or `on_hold`.

Hold a payout

Release a payout from hold to allow it to be processed. Only payouts in `hold` status can be released.

Release a payout

Cancel a payout to prevent it from being sent. Only payouts in `created` or `hold` status can be canceled.

Cancel a payout

Use this endpoint to list or search for funding events using filters or query parameters

List funding events

Use this endpoint to get line item details for every payment in a funding event.

Lookup funding details

Search for all Payments

Learn the basics of deploying, ingesting, and verifying webhooks from Straddle.

Webhooks 101

Learn how to configure endpoints to start receiving and testing Straddle webhooks

Endpoints & Testing

Get a stream of events by polling, without having to set up a webhook endpoint.

Polling Endpoints

A comprehensive guide to all webhook events available in the Straddle platform

Event Catalog

Learn how to locate and filter webhook delivery logs for specific messages

Filtering Logs

Learn how Straddle handles webhook replays and failed delivery attempts

Replays and Retries

Understanding the importance of verifying webhooks from Straddle

Why Verify Webhooks

Guide to manually verify webhook signatures without libraries

Manual Verification

Learn how to securely verify webhook payloads from Straddle using Svix

Webhook Security SDKs

Secure communication between Straddle and your endpoints

Trusted IPs

Trusted IP Lists

Bring your Plaid bank connections to Straddle

Plaid

Product updates and announcements for Straddle in 2025.

2025 Updates

Changelog

Product updates and announcements for Straddle in 2024.

2024 Updates

Changelog 2024

Learn how to use the Bridge open-banking platform to securely connect identities to bank accounts and generate Paykeys for initiating payments

A new kind of token for secure account-to-account payments

Paykeys

Drop-in UI component to securely connect user bank accounts to your application.

Widget

Integrating Plaid with Straddle to create paykeys for account-to-account payments

Plaid Token

The Bridge API allows you to create paykeys using raw bank account details.

Bank Account

Bank Accounts

Guide for integrating the Straddle hosted onboarding form into your platform

Hosted Onboarding

A comprehensive guide to integrating and customizing the Straddle embed form in your React application

Embed React Component

Manage multiple accounts under a single umbrella

Organizations

Accounts

Manage representatives for your Straddle accounts

Representatives

Manage linked bank accounts for your users

Linked Bank Accounts

Capabilities

Create test accounts quickly in the Straddle sandbox

Platform Sandbox Quickstart

Creates a new organization related to your Straddle integration. Organizations can be used to group related accounts and manage permissions across multiple users.

Create an organization

Retrieves a list of organizations associated with your Straddle integration. The organizations are returned sorted by creation date, with the most recently created organizations appearing first. This endpoint supports advanced sorting and filtering options to help you find specific organizations.

List organizations

Creates a new account associated with your Straddle platform integration. This endpoint allows you to set up an account with specified details, including business and contact information.

Fundamentals

SDKs

Customers

Bridge

Paykeys

Charges

Payouts

Funding

Payments

Embed

Lookup a customer

Authorizations

Headers

Path Parameters

Response