API Reference

View as Markdown

View as Markdown

Copy Markdown

---

Open in Claude

Open in ChatGPT

Bridge

Create a Widget session token

bridge.initialize(BridgeInitializeParams**kwargs) -> BridgeTokenV1

post/v1/bridge/initialize

ModelsExpand Collapse

class BridgeTokenV1: …

data: Data

bridge_token: str

JWT Token to use in the bridge widget.

meta: ResponseMetadata

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

api_request_id: str

Unique identifier for this API request, useful for troubleshooting.

formatuuid

api_request_timestamp: datetime

Timestamp for this API request, useful for troubleshooting.

formatdate-time

response_type: Literal["object", "array", "error", "none"]

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.

Accepts one of the following:

"object"

"array"

"error"

"none"

BridgeLink

Bridge a bank account

bridge.link.bank_account(LinkBankAccountParams**kwargs) -> PaykeyV1

post/v1/bridge/bank_account

Bridge a Plaid token

bridge.link.plaid(LinkPlaidParams**kwargs) -> PaykeyV1

post/v1/bridge/plaid

Create Tan

bridge.link.create_tan(LinkCreateTanParams**kwargs) -> LinkCreateTanResponse

post/v1/bridge/tan

Create a paykey from a Quiltt token

bridge.link.create_paykey(LinkCreatePaykeyParams**kwargs) -> LinkCreatePaykeyResponse

post/v1/bridge/quiltt