Jump to Content

Home Guides API Reference Changelog

Home Guides API Reference

Home Guides API Reference Changelog Get API Keys Log In

API Reference

Get API Keys Log In

Home Guides API Reference

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
Bridge Token
- Create a bridge tokenpost
Companies and Data Providers
Account Links
Data Refresh
- Create a data refresh taskpost
- Retrieve a data refresh statusget
Customization Templates
Webhooks

ORDERS

Orders

User reports

VOIE Reports
- Create an income and employment reportpost
- Retrieve an income and employment reportget
VOA Reports
- Create an assets reportpost
- Retrieve an assets reportget
Income Insights Reports
- Create a user bank income insights reportpost
- Retrieve a user bank income insights reportget
DDS Reports
- Retrieve a deposit switch reportget

income and Employment

Reports
- Retrieve an employment history report for a linkget
- Retrieve an income and employment report for a linkget
Identity
- Retrieve an identityget
- Webhooks
Shifts
- List all shiftsget
- Webhooks
Pay Statements
Tax Documents
- List all tax documentsget
- Retrieve tax documentget
Employment
Uploaded Documents
- List all documentsget
- Retrieve documentget

Direct Deposit Switching

Bank Accounts
- List all bank accountsget
- Webhooks
Deposit Switch Reports
- Retrieve a direct deposit switch report for a linkget
- Retrieve a paycheck linked loan reportget

Insurance

Insurance Reports

Financial Accounts

Accounts
- List all balancesget
- List financial accountsget
Transactions
- List all bank transactionsget
Income Report
- Creates a bank income reportpost
- Retrieves a bank income reportget

Scoring Attributes

Report
- Retrieve a scoring attributes reportget
- Create a scoring attributes reportpost

API Status

Citadel Status

status.citadelid.com