Jump to Content
Home
Guides
API Reference
Changelog
Home
Guides
API Reference
v1.0
Home
Guides
API Reference
Changelog
Get API Keys
Log In
API Reference
Get API Keys
Log In
v1.0
Home
Guides
API Reference
Auth
All
Pages
Start typing to search…
JUMP TO
Overview
Introduction
Postman Collection
Bridge SDK
API Keys Rotation
Platform Management
Data Structure
Connection Lifecycle
Webhooks
Webhook Event Descriptions
Advanced Security and mTLS
User Flow Endpoints
Users
List all users
get
Create a user
post
Retrieve a user
get
Update a user
patch
Delete a user
del
Bridge Token
Create a bridge token
post
Companies and Data Providers
Search companies
post
Search companies with autocomplete
get
Get company information
get
List all data providers
get
Retrieve a data provider
get
Account Links
Retrieve a link token
post
List all links
get
Retrieve a link
get
Delete a link
del
List all tasks
get
Retrieve a task
get
Webhooks
Data Refresh
Create a data refresh task
post
Retrieve a data refresh status
get
Customization Templates
List all customization templates
get
Create a customization template
post
Retrieve a customization template
get
Update a customization template
patch
Delete a customization template
del
Webhook Endpoints
List all webhooks
get
Create a webhook
post
Retrieve a webhook
get
Update a webhook
patch
Delete a webhook
del
ORDERS
Orders
Create an order
post
Get list of orders by SSN
post
Retrieve an order
get
Create a data refresh order
post
Update an order
patch
Cancel an order
post
Add new employer to the existing order
post
Retrieve an order invoice
get
Retrieve events for an order
get
Retrieve self-certification results for an order
get
Webhooks
User reports
VOIE Reports
Create an income and employment report
post
Retrieve an income and employment report
get
VOA Reports
Create an assets report
post
Retrieve an assets report
get
Income Insights Reports
Create a user bank income insights report
post
Retrieve a user bank income insights report
get
DDS Reports
Retrieve a deposit switch report
get
income and Employment
Employment
Retrieve an employment
get
List all employments
get
Webhooks
Identity
Retrieve an identity
get
Webhooks
Shifts
List all shifts
get
Webhooks
Pay Statements
List all statements
get
Retrieve a statement
get
Webhooks
Tax Documents
List all tax documents
get
Retrieve tax document
get
Reports
Retrieve an employment history report for a link
get
Retrieve an income and employment report for a link
get
DOCUMENT PROCESSING
Document Collections
Create a new document collection
post
Get document collection details
get
List all document collections
get
Delete a document collection
del
Upload files to existing collection
post
Get uploaded file details
get
Delete an uploaded file
del
Finalize a collection
post
Get collection finalization results
get
Uploaded Documents from Bridge
List all documents
get
Retrieve document
get
Parsed Documents from Bridge
List all parsed documents
get
Retrieve parsed document
get
Financial Accounts
Auth
Retrieve auth data
get
Accounts
List all balances
get
List financial accounts
get
Transactions
List all bank transactions
get
Income Report
Retrieve the most recent bank income report
get
Liabilities
Retrieve liabilities
get
Direct Deposit Switching
Bank Accounts
List all bank accounts
get
Webhooks
Deposit Switch Reports
Retrieve a direct deposit switch report for a link
get
Retrieve a paycheck linked loan report
get
Insurance
Insurance Reports
Retrieve an insurance report
get
Retrieve an auto insurance report
get
Retrieve an home insurance report
get
Scoring Attributes
Report
Retrieve a scoring attributes report
get
Create a scoring attributes report
post
Powered by
Auth
Ask AI
Learn about account details in a financial institution.
