Skip to content
straddle API Docs
Get started
API Reference

Bridge

Bridge provides a comprehensive suite of tools for connecting customer bank accounts. Use it to generate secure widget sessions for instant account verification, accept tokens from major providers like Plaid and Finicity, or verify accounts directly via our API. Bridge handles all sensitive banking credentials and ensures secure, compliant connections with support for 90% of US bank accounts.

Create a Widget session token
BridgeTokenV1 Bridge.Initialize(BridgeInitializeParamsparameters, CancellationTokencancellationToken = default)
POST/v1/bridge/initialize
ModelsExpand Collapse
class BridgeTokenV1:
required Data Data
required string BridgeToken

JWT Token to use in the bridge widget.

required ResponseMetadata Meta

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

required string ApiRequestID

Unique identifier for this API request, useful for troubleshooting.

formatuuid
required DateTimeOffset ApiRequestTimestamp

Timestamp for this API request, useful for troubleshooting.

formatdate-time
required ResponseType ResponseType

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.
One of the following:
"object"Object
"array"Array
"error"Error
"none"None

Bridge provides a comprehensive suite of tools for connecting customer bank accounts. Use it to generate secure widget sessions for instant account verification, accept tokens from major providers like Plaid and Finicity, or verify accounts directly via our API. Bridge handles all sensitive banking credentials and ensures secure, compliant connections with support for 90% of US bank accounts.

Bridge a bank account
PaykeyV1 Bridge.Link.BankAccount(LinkBankAccountParamsparameters, CancellationTokencancellationToken = default)
POST/v1/bridge/bank_account
Bridge a Plaid token
PaykeyV1 Bridge.Link.Plaid(LinkPlaidParamsparameters, CancellationTokencancellationToken = default)
POST/v1/bridge/plaid
Create Tan
LinkCreateTanResponse Bridge.Link.CreateTan(LinkCreateTanParamsparameters, CancellationTokencancellationToken = default)
POST/v1/bridge/tan
Create a paykey from a Quiltt token
LinkCreatePaykeyResponse Bridge.Link.CreatePaykey(LinkCreatePaykeyParamsparameters, CancellationTokencancellationToken = default)
POST/v1/bridge/quiltt