# Truv ## Docs - [Welcome](https://docs.truv.com/developers/home.md): Start here to integrate Truv into your application - [Start Building](https://docs.truv.com/developers/quickstarts-overview.md): Quickstart for basics, demo apps for real integration patterns - [Quickstart](https://docs.truv.com/developers/quickstart.md): Run a complete Truv integration in minutes with Python, Ruby, Go, Node.js, or C# - [POS Application Demo](https://docs.truv.com/developers/demos/mortgage/pos-application.md): Verify borrower income or assets in real time during the loan application - [POS Tasks Demo](https://docs.truv.com/developers/demos/mortgage/pos-tasks.md): Complete outstanding income, employment, and asset verifications after loan submission - [LOS Demo](https://docs.truv.com/developers/demos/mortgage/los.md): Create verification orders from your LOS and send borrowers a link to complete on their own - [Document Processing Demo](https://docs.truv.com/developers/demos/mortgage/document-processing.md): Upload pay stubs, W-2s, and tax returns and extract structured income data for underwriting - [Customer Portal Demo](https://docs.truv.com/developers/demos/public-sector/customer-portal.md): Let benefit applicants verify income and employment through a self-service portal - [Document Processing Demo](https://docs.truv.com/developers/demos/public-sector/document-processing.md): Process pay stubs, W-2s, and tax returns for benefit eligibility decisions - [Case Worker Portal Demo](https://docs.truv.com/developers/demos/public-sector/case-worker-portal.md): Create verification orders from applicant data and send a link for self-service completion - [Smart Routing Demo](https://docs.truv.com/developers/demos/consumer-credit/smart-routing.md): Check employer payroll coverage and route applicants to the fastest verification method - [Bank Income Demo](https://docs.truv.com/developers/demos/consumer-credit/bank-income.md): Verify applicant income from bank transactions when payroll data is unavailable - [Payroll Income Demo](https://docs.truv.com/developers/demos/consumer-credit/payroll-income.md): Verify income and employment directly from payroll data for fast lending decisions - [Paycheck-Linked Loans Demo](https://docs.truv.com/developers/demos/consumer-credit/paycheck-linked-loans.md): Verify income and set up automatic loan repayment through payroll deductions in one flow - [Direct Deposit Switch Demo](https://docs.truv.com/developers/demos/retail-banking/direct-deposit-switch.md): Switch a customer's direct deposit to your bank through their payroll provider - [Building with AI](https://docs.truv.com/developers/building-with-ai.md): Connect Claude Code, Codex, or Cursor to Truv docs via MCP for accurate API integrations - [Embedded Orders](https://docs.truv.com/developers/integration/embedded-orders/overview.md): Create an order when you don't know the user's employer or provider - [Display Modes](https://docs.truv.com/developers/integration/embedded-orders/display-modes.md): Control how the embedded order appears: as an overlay dialog or inline within your page - [Deeplinking](https://docs.truv.com/developers/integration/embedded-orders/deeplinking.md): Pre-fill account information (employer, bank, etc.) to skip search steps and maximize conversion - [Follow-up](https://docs.truv.com/developers/integration/embedded-orders/follow-up.md): Let Truv handle email and SMS reminders when users leave without finishing verification - [Data Refresh](https://docs.truv.com/developers/integration/embedded-orders/data-refresh.md): Refresh verification data from a completed order without requiring the user to reconnect - [Add Employer](https://docs.truv.com/developers/integration/embedded-orders/add-employer.md): Add a new employer to an existing order after it has been created - [Self-Certification](https://docs.truv.com/developers/integration/embedded-orders/self-certification.md): Retrieve user self-certification results for employments, accounts, and bank income in an order - [Embedded Orders Best Practices](https://docs.truv.com/developers/best-practices/embedded-orders.md): Guidelines for implementing Embedded Orders - [Bridge Widget Overview](https://docs.truv.com/developers/integration/bridge-widget/overview.md): The client-side widget for secure account connections - [New User](https://docs.truv.com/developers/integration/bridge-widget/new-user.md): Direct API integration for Deposit Switch and Paycheck Linked Lending - [Returning User](https://docs.truv.com/developers/integration/bridge-widget/returning-user.md): Re-authenticate expired connections and refresh data - [Deeplinking](https://docs.truv.com/developers/integration/bridge-widget/deeplinking.md): Pre-fill account information in Bridge Widget flows to skip search steps - [Widget-only Best Practices](https://docs.truv.com/developers/best-practices/bridge-token.md): Guidelines for implementing Deposit Switch and Paycheck Linked Lending - [New User](https://docs.truv.com/developers/integration/hosted-orders/new-user.md): Create an order where Truv contacts the user via email or SMS to complete verification - [Deeplinking](https://docs.truv.com/developers/integration/hosted-orders/deeplinking.md): Pre-fill account information (employer, bank, etc.) to skip search steps and maximize conversion - [Data Refresh](https://docs.truv.com/developers/integration/hosted-orders/data-refresh.md): Refresh verification data from a completed order without requiring the user to reconnect - [Add Employer](https://docs.truv.com/developers/integration/hosted-orders/add-employer.md): Add a new employer to an existing order after it has been created - [Self-Certification](https://docs.truv.com/developers/integration/hosted-orders/self-certification.md): Retrieve user self-certification results for employments, accounts, and bank income in an order - [New Order](https://docs.truv.com/developers/integration/manual-orders/new-user.md): Create a verification order through the Truv Dashboard without writing any code - [Manage Orders](https://docs.truv.com/developers/integration/manual-orders/manage-orders.md): Filter, search, export, and customize the orders table in the Dashboard - [CSV Upload](https://docs.truv.com/developers/integration/manual-orders/csv-upload.md): Create verification orders in bulk by uploading a CSV file through the Dashboard - [Document Processing Implementation](https://docs.truv.com/developers/integration/document-processing.md): Upload, validate, classify, and verify borrower documents through the Truv API and get the same income and employment report as a live payroll connection - [Fraud Detection & Manual Review](https://docs.truv.com/developers/fraud-and-manual-review.md): How to interpret the is_suspicious flag, detect document fraud, and handle manual review scenarios - [SDK Overview](https://docs.truv.com/developers/sdks/overview.md): Truv Bridge SDKs for web and mobile - [Vanilla JS SDK](https://docs.truv.com/developers/sdks/javascript.md): Truv Bridge SDK for vanilla JavaScript - [React SDK](https://docs.truv.com/developers/sdks/react.md): Truv Bridge SDK for React - [iOS SDK](https://docs.truv.com/developers/sdks/ios.md): Truv Bridge SDK for iOS (Swift) - [Android SDK](https://docs.truv.com/developers/sdks/android.md): Truv Bridge SDK for Android (Kotlin) - [React Native SDK](https://docs.truv.com/developers/sdks/react-native.md): Truv Bridge SDK for React Native - [Flutter SDK](https://docs.truv.com/developers/sdks/flutter.md): Truv Bridge SDK for Flutter - [Bridge Events](https://docs.truv.com/developers/sdks/bridge-events.md): Complete reference for Truv Bridge JavaScript callbacks, onEvent types, event data payloads, and error codes - [Test Credentials](https://docs.truv.com/developers/testing/test-credentials.md): Start here — pick your product, then use the universal login scenarios and sandbox environment behavior that apply across every Truv product - [Income & Employment Testing](https://docs.truv.com/developers/testing/income-employment.md): Sandbox credentials, scenarios, and sample reports for VOIE and VOE integrations - [Assets Testing](https://docs.truv.com/developers/testing/assets.md): Sandbox credentials, account variants, and bank income source scenarios for VOA integrations - [Direct Deposit Switch Testing](https://docs.truv.com/developers/testing/direct-deposit-switch.md): Sandbox credentials, allocation scenarios, and webhook flow for DDS integrations - [Paycheck Linked Lending Testing](https://docs.truv.com/developers/testing/paycheck-linked-lending.md): Sandbox credentials and integration patterns for testing PLL flows - [Test Documents](https://docs.truv.com/developers/testing/test-documents.md): Sample PDFs for testing document processing in the sandbox - [GSE Testing](https://docs.truv.com/developers/testing/gse-testing.md): Sandbox borrower accounts and pre-generated report IDs for testing Fannie Mae Day 1 Certainty and Freddie Mac AIM submissions - [Launch Checklist](https://docs.truv.com/developers/testing/launch-checklist.md): Pre-production steps for any Truv integration - [Truv Dashboard](https://docs.truv.com/developers/dashboard.md): Your central hub for managing verifications, teams, customization, billing, integrations and more. - [Home](https://docs.truv.com/developers/dashboard/home.md): Monitor verification performance and team activity from your reporting dashboard - [Emulator](https://docs.truv.com/developers/dashboard/emulator.md): Preview and test the Truv verification experience as the end-user using different products and flows. - [Activity](https://docs.truv.com/developers/dashboard/activity.md): Search and manage users, orders, tasks, and provider coverage - [Customization](https://docs.truv.com/developers/dashboard/customization.md): Control branding, order defaults, templates, and API response fields - [Development](https://docs.truv.com/developers/dashboard/development.md): Manage API keys, view logs, and configure webhooks for your Truv integration - [Billing](https://docs.truv.com/developers/dashboard/billing.md): View your subscription, invoices, and usage data - [Support](https://docs.truv.com/developers/dashboard/support.md): Submit and track support tickets with the Truv team - [Settings](https://docs.truv.com/developers/dashboard/settings.md): Configure company details, manage your team, and control notification preferences - [Login](https://docs.truv.com/developers/login.md): Log into the Truv Dashboard using email, SSO, or a social provider - [Multi-Tenancy](https://docs.truv.com/developers/multi-tenancy.md): Manage separate Dashboard instances for different business units - [UX Customization](https://docs.truv.com/developers/customization.md): Brand your verification experience across Bridge, emails, SMS, and landing pages - [SSO Configuration](https://docs.truv.com/developers/sso.md): Set up single sign-on with SAML 2.0, OIDC, or Azure AD - [Payroll](https://docs.truv.com/developers/coverage-payroll.md): Payroll provider coverage, authentication methods, and Smart Login - [Financial Accounts](https://docs.truv.com/developers/coverage-financial-accounts.md): Financial institution coverage, supported account types, and data access - [Home Lending](https://docs.truv.com/mortgage/overview.md): Income, employment, asset, and document-based income verification for mortgage origination - [Income & Employment for Mortgage](https://docs.truv.com/mortgage/products/income-employment.md): Verify borrower income and employment directly from payroll providers, certified by Fannie Mae and Freddie Mac - [Assets for Mortgage](https://docs.truv.com/mortgage/products/assets.md): Verify borrower bank account balances, ownership, and transaction history for mortgage underwriting - [AIM Check for Mortgage](https://docs.truv.com/mortgage/products/aim-check.md): Document-based income verification for Freddie Mac AIM Check using pay stubs and W-2s - [POS Integrations](https://docs.truv.com/mortgage/integration/pos-overview.md): Pre-built integrations with major point-of-sale platforms, no code required - [nCino (fka SimpleNexus) Integration](https://docs.truv.com/mortgage/integration/simplenexus.md): Income, employment, and asset verification embedded in nCino's point-of-sale platform - [TidalWave Integration](https://docs.truv.com/mortgage/integration/tidalwave.md): Income, employment, and asset verification embedded in TidalWave's SOLO point-of-sale platform - [Lodasoft Integration](https://docs.truv.com/mortgage/integration/lodasoft.md): Real-time income and employment verification embedded in the Lodasoft mortgage platform - [LenderLogix Integration](https://docs.truv.com/mortgage/integration/lenderlogix.md): Income and employment verification within LenderLogix LiteSpeed: four-step self-service setup - [Floify Integration](https://docs.truv.com/mortgage/integration/floify.md): Use Truv income and employment verification within the Floify point-of-sale system - [BeSmartee Integration](https://docs.truv.com/mortgage/integration/besmartee.md): Verify borrower income and employment within the BeSmartee digital mortgage POS platform - [Encompass Consumer Connect](https://docs.truv.com/mortgage/integration/ice-encompass/consumer-connect.md): Set up Truv in Encompass Consumer Connect for borrower-facing verification - [LOS Integrations](https://docs.truv.com/mortgage/integration/los-overview.md): Pre-built integrations with major loan origination systems, no code required - [Overview](https://docs.truv.com/mortgage/integration/ice-encompass.md): Verify income, employment, and assets directly within Encompass® SmartClient and LO Connect - [Encompass LOS Setup Guide](https://docs.truv.com/mortgage/integration/ice-encompass/setup.md): Setup Truv within ICE Encompass® (SmartClient/Desktop and web editions) - [Create and Manage Orders](https://docs.truv.com/mortgage/integration/ice-encompass/manual-voie.md): Manually order income, employment, and asset verifications using Truv within ICE Encompass - [Automated Service Ordering (ASO)](https://docs.truv.com/mortgage/integration/ice-encompass/aso.md): Automatically trigger Truv verification orders in ICE Encompass when loan conditions are met - [AIM Check via Automated Service Ordering](https://docs.truv.com/mortgage/integration/ice-encompass/aim-check.md): Enable Freddie Mac AIM Check in ICE Encompass using Automated Service Ordering to receive early income assessments from digitized paystub and W-2 data - [Customization](https://docs.truv.com/mortgage/integration/ice-encompass/customization.md): White labeling, eFolder document mapping, status notification routing, and custom field configuration - [TPO Connect](https://docs.truv.com/mortgage/integration/ice-encompass/tpo-connect.md): Set up Truv in Encompass TPO Connect for broker, wholesale, and correspondent channels - [Blue Sage Solutions Integration](https://docs.truv.com/mortgage/integration/bluesage.md): Income and employment verification directly within the Blue Sage LOS: one-click ordering, AUS-ready reports - [Vesta LOS Integration](https://docs.truv.com/mortgage/integration/vesta.md): Income and employment verification embedded in Vesta's loan origination platform - [Dark Matter Empower Integration](https://docs.truv.com/mortgage/integration/dark-matter-empower.md): Income and employment verification within the Empower® Loan Origination Platform by Dark Matter Technologies - [BYTE Software](https://docs.truv.com/mortgage/integration/byte-pro.md): Auto-run and manual income and employment verification within BYTE Software LOS - [Custom Integration](https://docs.truv.com/mortgage/integration/custom-overview.md): Choose where to integrate Truv verification in your mortgage workflow - [POS Application](https://docs.truv.com/mortgage/integration/custom-pos.md): Embed income, employment, and asset verification in your borrower portal using the Application demo - [Follow-up Verification](https://docs.truv.com/mortgage/integration/embedded-orders.md): Verify co-borrowers and complete post-application verification using the Follow-up demo - [LOS Integration](https://docs.truv.com/mortgage/integration/custom-los.md): Send verification links to borrowers from your loan origination system using the LOS demo - [Document Processing](https://docs.truv.com/mortgage/integration/document-processing.md): Extract structured income data from pay stubs, W-2s, and tax returns using the Document Processing demo - [Overview](https://docs.truv.com/mortgage/d1c-aim/overview.md): Overview of Fannie Mae Day 1 Certainty and Freddie Mac Asset and Income Modeler with Truv - [Day 1 Certainty (D1C)](https://docs.truv.com/mortgage/d1c-aim/fannie-mae.md): Day 1 Certainty validation through Desktop Underwriter for income, employment, and assets - [Asset and Income Modeler (AIM)](https://docs.truv.com/mortgage/d1c-aim/freddie-mac.md): Asset and Income Modeler (AIM) integration through Loan Product Advisor for income, employment, and assets - [Sample Reports](https://docs.truv.com/mortgage/testing/sample-reports.md): Reference report retrieval patterns and Encompass field mappings for DU and AIM - [Public Sector](https://docs.truv.com/government/overview.md): Income, employment, and asset verification for government programs - [Income & Employment for Government](https://docs.truv.com/government/products/income-employment.md): Income and employment verification for government benefits programs - [Assets for Government](https://docs.truv.com/government/products/self-employed-income.md): Verify self-employment income, gig work, and financial assets for government programs - [Document Processing for Government](https://docs.truv.com/government/products/document-processing.md): Verify client income and employment from uploaded documents when payroll connections are unavailable - [Self-Certification for Government](https://docs.truv.com/government/products/self-certification.md): Let clients review and confirm the income, employment, and asset data Truv retrieves before it reaches a caseworker - [Custom Integration](https://docs.truv.com/government/integration/overview.md): Choose where to integrate Truv verification in your benefits workflow - [Customer Portal](https://docs.truv.com/government/integration/customer-portal.md): Embed income, employment, and asset verification in your benefits portal using the CustomerPortal demo - [Caseworker Portal](https://docs.truv.com/government/integration/caseworker-portal.md): Create verification orders and send links to clients from your caseworker system using the EmployeePortal demo - [Offline & Contact Center Workflows](https://docs.truv.com/government/integration/offline-contact-center.md): Verify income and employment for clients who apply by phone or in person - [Renewals](https://docs.truv.com/government/integration/renewals.md): Re-verify income and employment for clients renewing their benefits at recertification - [Consumer Credit](https://docs.truv.com/credit/overview.md): Income and asset verification for auto loans, personal loans, and credit decisioning - [Income & Employment for Lending](https://docs.truv.com/credit/products/income-employment.md): Income verification for consumer lending decisions - [Assets for Lending](https://docs.truv.com/credit/products/assets.md): Asset verification for consumer lending - [Transactions for Lending](https://docs.truv.com/credit/products/bank-aggregation.md): Cash flow analysis and bank data for lending decisions - [Paycheck Linked Lending](https://docs.truv.com/credit/products/pll.md): Automatic loan repayment directly from paycheck - [Scoring Attributes for Lending](https://docs.truv.com/credit/products/scoring.md): Transaction-derived risk scores and financial metrics for credit decisioning - [Document Processing](https://docs.truv.com/credit/data-sources/document-processing.md): Collect and process documents for income and employment verification - [Tax Returns](https://docs.truv.com/credit/data-sources/tax-returns.md): Verify income through tax preparation software connections - [Integration for Consumer Credit](https://docs.truv.com/credit/integration/implementation.md): Choose the right verification method for your lending workflow - [Smart Routing](https://docs.truv.com/credit/integration/smart-routing.md): Automatically recommend the best verification method based on employer payroll coverage - [Bank Income](https://docs.truv.com/credit/integration/bank-income.md): Verify applicant income from bank transactions using income insights - [Payroll Income](https://docs.truv.com/credit/integration/payroll-income.md): Verify applicant income and employment directly from payroll providers - [Paycheck-Linked Loans](https://docs.truv.com/credit/integration/pll.md): Set up automatic loan repayment directly from the borrower paycheck via payroll deduction - [Retail Banking](https://docs.truv.com/banking/overview.md): Direct deposit switching and paycheck-linked lending for banks and fintech - [Smart Login](https://docs.truv.com/banking/smart-login.md): Truv Smart Login presents the best authentication method for each user to maximize deposit switch and PLL conversion - [Deposit Switch](https://docs.truv.com/banking/products/dds.md): Automatically switch customer direct deposit to your bank - [Transactions](https://docs.truv.com/banking/products/bank-aggregation.md): Bank account and transaction data for fintech applications - [Document Processing](https://docs.truv.com/banking/products/document-processing.md): AI-powered document upload and verification for banking and fintech - [Direct Deposit Switch](https://docs.truv.com/banking/integration/dds.md): Switch customer direct deposits to your bank using the Deposit Switch demo - [Background Screening](https://docs.truv.com/screening/overview.md): Employment verification for pre-employment screening and background checks - [Income & Employment for Screening](https://docs.truv.com/screening/products/income-employment.md): Income and employment verification for tenant screening - [Employment for Screening](https://docs.truv.com/screening/products/employment.md): Employment history verification for background checks - [Screening Implementation Guide](https://docs.truv.com/screening/integration/implementation.md): Complete implementation guide for background screening - [Embedded Orders for Screening](https://docs.truv.com/screening/integration/embedded-orders.md): Implement employment verification for background screening - [TazWorks Integration](https://docs.truv.com/screening/integration/tazworks.md): Verify employment history directly within the TazWorks platform using Truv - [Authentication](https://docs.truv.com/api-reference/authentication.md): How to authenticate with the Truv API - [Errors & Rate Limits](https://docs.truv.com/api-reference/errors.md): HTTP error codes, API error response format, task error states, Bridge error codes, and rate limiting behavior - [Security](https://docs.truv.com/api-reference/security.md): Overview of Truv security, privacy, compliance, webhook security, and mTLS - [OpenAPI Spec](https://docs.truv.com/api-reference/openapi.md): Truv OpenAPI specification in YAML format - [Webhooks](https://docs.truv.com/api-reference/webhooks.md): Receive real-time notifications when verification events occur - [Postman Collection](https://docs.truv.com/api-reference/postman.md): Get started with Truv APIs using the Postman collection - [Report Sizes](https://docs.truv.com/api-reference/report-sizes.md): Typical and long-tail payload sizes for Truv reports, so you can plan storage, request timeouts, and bandwidth. - [Data Structure](https://docs.truv.com/api-reference/data-structure.md): How Truv's core objects (Orders, Users, Links, and Tasks) relate to each other - [Data Processing](https://docs.truv.com/api-reference/data-processing.md): Processing stages, timing, and data availability during verification - [The Orders object](https://docs.truv.com/api-reference/orders/object.md): Create verification requests, generate bridge tokens, and manage the full order lifecycle - [Order Webhook Events](https://docs.truv.com/api-reference/orders/events.md): Webhook events for Order status changes and refresh failures - [Create an order](https://docs.truv.com/api-reference/orders/orders_create.md): The endpoint creates an order - [List orders](https://docs.truv.com/api-reference/orders/orders_list.md): The endpoint returns a list of orders. - [Get list of orders by SSN](https://docs.truv.com/api-reference/orders/orders_list_lookup.md): The endpoint returns a list of orders by an applicant SSN - [Retrieve an order](https://docs.truv.com/api-reference/orders/orders_read.md): The endpoint returns the order. - [Update an order](https://docs.truv.com/api-reference/orders/orders_partial_update.md): The endpoint updates the order. Update only available if all employers in one of statuses: pending, sent. - [Cancel an order](https://docs.truv.com/api-reference/orders/orders_cancel_create.md): The endpoint cancels the order. - [Create a data refresh order](https://docs.truv.com/api-reference/orders/orders_create_refresh_order.md): The endpoint creates the new order with data populated from the existing order. - [Add new employer to the existing order](https://docs.truv.com/api-reference/orders/order-add-new-employer.md): The endpoint allows to add new employer to the existing order. The order should not be expired or canceled. - [Retrieve events for an order](https://docs.truv.com/api-reference/orders/orders_events_list.md): Returns a list of events for the specified order. - [Retrieve self-certification results for an order](https://docs.truv.com/api-reference/orders/orders_certifications_results.md): The endpoint returns self-certification results for employments and accounts that have been reviewed and certified by the user. - [Retrieve an order invoice](https://docs.truv.com/api-reference/orders/order_group_invoice_detail.md): The endpoint returns an order invoice. - [The Users object](https://docs.truv.com/api-reference/users/object.md): Manage users and user tokens for Truv Bridge with the Users endpoint. - [Create a user](https://docs.truv.com/api-reference/users/users_create.md): The endpoint creates a user. - [List all users](https://docs.truv.com/api-reference/users/users_list.md): The endpoint returns a list of users. - [Retrieve a user](https://docs.truv.com/api-reference/users/users_read.md): This endpoint retrieves a user. - [Update a user](https://docs.truv.com/api-reference/users/users_partial_update.md): The endpoint updates a user. - [Delete a user](https://docs.truv.com/api-reference/users/users_delete.md): The endpoint deletes a user. - [The Bridge Token object](https://docs.truv.com/api-reference/bridge-token/object.md): Create tokens with the API to use Truv Bridge in your integration. - [Create a bridge token](https://docs.truv.com/api-reference/bridge-token/users_tokens.md): The endpoint creates a bridge token for a user. This is typically the endpoint called before initializing the Bridge since the response from this call is passed to the TruvBridge.init function. - [The Tasks object](https://docs.truv.com/api-reference/tasks/object.md): A job created on a Link to pull, refresh, or update data in the linked account. - [Task Lifecycle](https://docs.truv.com/api-reference/tasks/lifecycle.md): How tasks progress through the flow: statuses, errors, and processing timelines - [Task Webhook Events](https://docs.truv.com/api-reference/tasks/events.md): Webhook events for Task status changes and data object creation and updates - [List all tasks](https://docs.truv.com/api-reference/tasks/tasks_list.md): The endpoint returns a list of Tasks. - [Retrieve a task](https://docs.truv.com/api-reference/tasks/tasks_read.md): The endpoint returns a Task. - [The Task Refresh object](https://docs.truv.com/api-reference/refresh/object.md): View information about data refresh endpoints for Links. - [Create a data refresh task](https://docs.truv.com/api-reference/refresh/refresh_task_create.md): The endpoint creates a link data refresh task. - [Retrieve a data refresh status](https://docs.truv.com/api-reference/refresh/refresh_task.md): The endpoint returns the refresh task status. - [The Account Links object](https://docs.truv.com/api-reference/links/object.md): Manage Links (persistent connections to user accounts) and refresh their data - [Account Link Webhook Events](https://docs.truv.com/api-reference/links/events.md): Webhook events for Account Link connections, disconnections, and deletions - [List all links](https://docs.truv.com/api-reference/links/links-list.md) - [Retrieve a link](https://docs.truv.com/api-reference/links/links-item.md) - [Retrieve a link token](https://docs.truv.com/api-reference/links/link_exchange_token_flow.md): Exchange a bridge public_token for a link access_token. - [Delete a link](https://docs.truv.com/api-reference/links/delete_link_by_link_id.md): The endpoint removes a link and all associated data. - [The Companies object](https://docs.truv.com/api-reference/companies/object.md): Search employers, check coverage, and map companies to payroll providers - [Search companies](https://docs.truv.com/api-reference/companies/company_mapping.md): The endpoint returns the `company_mapping_id` for a company if it exists. This `company_mapping_id` can be passed to the `/bridge-tokens` endpoint to have the user skip the company selection step and suggest a data provider. - [Get company information](https://docs.truv.com/api-reference/companies/company_info.md): The endpoint returns detailed information for a specific company mapping, including basic company details, success rate, and bank account information. - [Search companies with autocomplete](https://docs.truv.com/api-reference/companies/company_autocomplete_search.md): The endpoint provides company search using prefix. - [The Data Providers object](https://docs.truv.com/api-reference/data-providers/object.md): Look up payroll, bank, and insurance providers supported by Truv, filter by product type and data source - [List all data providers](https://docs.truv.com/api-reference/data-providers/providers-list.md): The endpoint returns a list of data providers filtered by the query parameter `product_type`. - [Retrieve a data provider](https://docs.truv.com/api-reference/data-providers/providers-detail.md): This endpoint retrieves a data provider. - [The Templates object](https://docs.truv.com/api-reference/templates/object.md): Customization templates let you configure the design and text of Truv Bridge and your workflow. - [Create a customization template](https://docs.truv.com/api-reference/templates/templates_create.md): The endpoint creates a customization template. - [List all customization templates](https://docs.truv.com/api-reference/templates/templates_list.md): The endpoint returns a list of all customization templates for user. - [Retrieve a customization template](https://docs.truv.com/api-reference/templates/templates_read.md): This endpoint retrieves a customization template. - [Update a customization template](https://docs.truv.com/api-reference/templates/templates_partial_update.md): The endpoint updates a customization template. - [Delete a customization template](https://docs.truv.com/api-reference/templates/templates_delete.md): The endpoint deletes a customization template. - [The Webhook Endpoint object](https://docs.truv.com/api-reference/webhooks/object.md): Learn how to create a webhook configuration to receive updates from Truv platform - [Create a webhook endpoint](https://docs.truv.com/api-reference/webhooks/webhooks_create.md): The endpoint creates a webhook. - [List all webhook endpoints](https://docs.truv.com/api-reference/webhooks/webhooks_list.md): The endpoint returns a list of webhooks. - [Retrieve a webhook endpoint](https://docs.truv.com/api-reference/webhooks/webhooks_read.md): This endpoint retrieves a webhook. - [Update a webhook endpoint](https://docs.truv.com/api-reference/webhooks/webhooks_partial_update.md): The endpoint updates a webhook. - [Delete a webhook endpoint](https://docs.truv.com/api-reference/webhooks/webhooks_delete.md): The endpoint deletes a webhook. - [List webhook request history](https://docs.truv.com/api-reference/webhooks/webhook_requests_list.md): Returns a paginated list of webhook requests filtered by the provided criteria. Only webhook requests from the last 30 days are available. - [The User Income & Employment Reports object](https://docs.truv.com/api-reference/user-income-and-employment-reports/object.md): User-level Verification of Income and Employment (VOIE) reports that aggregate income and employment data across all account links. - [Create an income and employment report](https://docs.truv.com/api-reference/user-income-and-employment-reports/users_reports.md): The endpoint creates a report for a user. - [Retrieve an income and employment report](https://docs.truv.com/api-reference/user-income-and-employment-reports/users_get_report.md): The endpoint retrieves a report for a user. - [The Link Income & Employment Reports object](https://docs.truv.com/api-reference/account-link-income-and-employment-reports/object.md): Account link-level income and employment verification reports for individual account connections. - [Retrieve an income and employment report for a link](https://docs.truv.com/api-reference/account-link-income-and-employment-reports/link_detail_reports_income.md): The endpoint returns the VOIE report for a link - [Retrieve an employment history report for a link](https://docs.truv.com/api-reference/account-link-income-and-employment-reports/link_detail_reports_employment.md): The endpoint returns the VOE report for a link - [The Employment object](https://docs.truv.com/api-reference/employment/object.md): Find information related to user employment with the endpoints in this section. - [Employment Webhook Events](https://docs.truv.com/api-reference/employment/events.md): Webhook events for employment data creation and updates. - [List all employments](https://docs.truv.com/api-reference/employment/link-employments.md): The endpoint returns a list of all employments. - [Retrieve an employment](https://docs.truv.com/api-reference/employment/link-last-employment.md): Get the most recent employment data - [The Identity object](https://docs.truv.com/api-reference/identity/object.md): View information and details about the user's identity. - [Identity Webhook Events](https://docs.truv.com/api-reference/identity/events.md): Webhook events for identity profile creation and updates. - [Retrieve an identity](https://docs.truv.com/api-reference/identity/link-identity.md): Get the identity data for the user - [The Pay Statements object](https://docs.truv.com/api-reference/statements/object.md): View information from pay statements such as dates, gross pay, net pay, and earnings with deductions. - [Pay Statement Webhook Events](https://docs.truv.com/api-reference/statements/events.md): Webhook events for pay statement creation and updates. - [List all statements](https://docs.truv.com/api-reference/statements/link-statements.md): The endpoint returns a list of pay statements with dates, gross pay, net pay and earnings with deductions breakdown. - [Retrieve a statement](https://docs.truv.com/api-reference/statements/retrieve-statement.md): Get the pay statement - [The Shifts object](https://docs.truv.com/api-reference/shifts/object.md): Learn more about information related to ongoing and completed work shifts. - [Shift Webhook Events](https://docs.truv.com/api-reference/shifts/events.md): Webhook events for shift data creation and updates. - [List all shifts](https://docs.truv.com/api-reference/shifts/link-shifts.md): The endpoint returns ongoing and completed work shifts. It includes time entries (clock in/clock out), the type of work, and earnings. - [The Tax Documents object](https://docs.truv.com/api-reference/tax/object.md): Learn more about the reference information for Tax Documents. - [List all tax documents](https://docs.truv.com/api-reference/tax/tax-documents.md): The endpoint returns a list of tax documents. - [Retrieve tax document](https://docs.truv.com/api-reference/tax/tax-document.md): The endpoint returns a tax document. - [The User Asset Reports object](https://docs.truv.com/api-reference/user-asset-verification-reports/object.md): User-level Verification of Assets (VOA) reports that aggregate asset and financial account data across all account links. - [Create an assets report](https://docs.truv.com/api-reference/user-asset-verification-reports/assets-report-create.md): The endpoint creates an assets report for the user. - [Retrieve an assets report](https://docs.truv.com/api-reference/user-asset-verification-reports/assets-report-retrieve.md): The endpoint retrieves an assets report for the user. - [The Bank Income Report Object](https://docs.truv.com/api-reference/bank-income-insights/object.md): Find more information about bank income reports. - [Retrieve the most recent bank income report](https://docs.truv.com/api-reference/bank-income-insights/bank-income-report-retrieve.md): Retrieves the most recent bank income report for the specified link. This endpoint returns the latest generated report containing transaction-based income analysis and verification data. - [The User Income Insights object](https://docs.truv.com/api-reference/income-insights/object.md): Find more information on data returned by the user-level Income Insights report. - [Create a user bank income insights report](https://docs.truv.com/api-reference/income-insights/income-insights-report-create.md): The endpoint creates a bank income insights report for the user. - [Retrieve a user bank income insights report](https://docs.truv.com/api-reference/income-insights/income-insights-report-retrieve.md): The endpoint retrieves a bank income insights report for the user. - [The Auth object](https://docs.truv.com/api-reference/auth/object.md): Account and routing numbers for ACH, RTP, and wire transfers from connected financial accounts. - [Retrieve auth data](https://docs.truv.com/api-reference/auth/bank-auth-get.md): The endpoint retrieves a list of connected financial accounts, including their bank identification numbers. - [The Balances object](https://docs.truv.com/api-reference/balances/object.md): Current balance data for connected financial accounts. - [List all balances](https://docs.truv.com/api-reference/balances/balances-list.md): The endpoint allows developers to receive balances. - [The Transactions object](https://docs.truv.com/api-reference/transactions/object.md): Transaction history from connected financial accounts. - [List all bank transactions](https://docs.truv.com/api-reference/transactions/link-bank-data-transactions.md): The endpoint allows developers to receive user-authorized transaction data. - [Retrieve recurring transactions (inflows and outflows) for a user](https://docs.truv.com/api-reference/recurring-transactions/applicant-recurring-transactions.md): Returns recurring transaction patterns detected across the user's linked bank accounts, split into recurring outflows (subscriptions, bills, and other recurring expenses) and recurring inflows (salary, benefits, and other recurring income sources). - [List all bank statements](https://docs.truv.com/api-reference/bank-statements/link-bank-statements.md): The endpoint returns a list of bank statement PDFs collected for the link's accounts. - [List all investment holdings](https://docs.truv.com/api-reference/investments/link-investments-list.md): The endpoint returns a paginated list of investment accounts and their associated holdings, including positions, quantities, values, and asset details. Supports optional filtering by account IDs, account subtypes, and holding types. - [The Liabilities object](https://docs.truv.com/api-reference/liabilities/object.md): Retrieve user liability data from connected financial accounts. - [Retrieve liabilities](https://docs.truv.com/api-reference/liabilities/link_liabilities.md): The endpoint returns liability accounts including credit cards and loans with detailed balance and payment information. - [The Scoring Attributes Report object](https://docs.truv.com/api-reference/scoring-attributes/object.md): View more information about scoring attribute reports. - [Create a scoring attributes report](https://docs.truv.com/api-reference/scoring-attributes/scoring-attributes-report-create.md) - [Retrieve a scoring attributes report](https://docs.truv.com/api-reference/scoring-attributes/scoring-attributes-report-retrieve.md) - [The Document Collections object](https://docs.truv.com/api-reference/document-collections/object.md): Find more information about document collections API. - [Document Collection Webhook Events](https://docs.truv.com/api-reference/document-collections/events.md): Webhook events for document collection file processing and categorization - [Create a new document collection](https://docs.truv.com/api-reference/document-collections/collections_create.md): The endpoint creates a new document collection and uploads documents in a single request. Documents are provided as base64-encoded content in JSON format. The uploaded files are automatically validated and queued for AI-powered categorization. - [Get document collection details](https://docs.truv.com/api-reference/document-collections/collections_retrieve.md): The endpoint returns detailed information about a specific collection, including all uploaded files and recognized documents with their categorization results. - [List all document collections](https://docs.truv.com/api-reference/document-collections/collections_list.md): The endpoint returns a paginated list of document collections for the authenticated user. - [Upload files to existing collection](https://docs.truv.com/api-reference/document-collections/collections_upload.md): The endpoint uploads additional files to an existing collection. Documents are provided as base64-encoded content in JSON format. Each uploaded file is automatically validated and queued for AI-powered categorization. - [Get uploaded file details](https://docs.truv.com/api-reference/document-collections/collections_uploaded_file_retrieve.md): The endpoint returns details about a specific uploaded file, including its processing status and any recognized documents. - [Finalize a collection](https://docs.truv.com/api-reference/document-collections/collections_finalize_create.md): The endpoint finalizes a document collection by creating or updating links for all matched documents and users. Optionally accepts a subset of document IDs to finalize. If no document_ids provided, all recognized documents in the collection will be finalized. - [Get collection finalization results](https://docs.truv.com/api-reference/document-collections/collections_finalize_retrieve.md): Returns the current finalization results for the collection: the users involved, their links, and the documents associated with each link. This endpoint does not expose a top-level status; use the presence and contents of users/links/documents to inspect the result. - [Delete an uploaded file](https://docs.truv.com/api-reference/document-collections/collections_uploaded_file_delete.md): The endpoint soft-deletes a specific uploaded file from a collection. The file is marked as deleted but not physically removed from storage. - [Delete a document collection](https://docs.truv.com/api-reference/document-collections/collections_delete.md): The endpoint soft-deletes a document collection and all its associated files. The collection and files are marked as deleted but not physically removed from storage. - [The Uploaded Documents object](https://docs.truv.com/api-reference/uploaded-documents/object.md): Find more information about the responses for uploaded documents. - [List all documents](https://docs.truv.com/api-reference/uploaded-documents/list-documents.md): The endpoint returns a list of documents. - [Retrieve document](https://docs.truv.com/api-reference/uploaded-documents/retrieve-document.md): The endpoint returns a document. - [The Parsed Documents object](https://docs.truv.com/api-reference/parsed-documents/object.md): Access parsed document data retrieved through Truv Bridge connections. - [List all parsed documents](https://docs.truv.com/api-reference/parsed-documents/list-parsed-documents.md): The endpoint returns a list of parsed documents. Parsed documents contain structured data extracted from uploaded documents. **Note:** Currently, only volunteer letters are available through this endpoint. Support for additional document types (paystubs, etc.) will be added in future releases. You c… - [Retrieve parsed document](https://docs.truv.com/api-reference/parsed-documents/retrieve-parsed-document.md): The endpoint returns a parsed document with its extracted data. The `parsed_data` field contains structured information extracted from the document. **Note:** Currently, only volunteer letters are available through this endpoint. For volunteer letters, the `parsed_data` includes volunteer informatio… - [The Bank Accounts object](https://docs.truv.com/api-reference/bank-accounts/object.md): Learn how to manage bank accounts for the DDS and PLL. - [List all bank accounts](https://docs.truv.com/api-reference/bank-accounts/link-bank-accounts.md): List of all bank accounts used for the direct deposit - [Bank Account Webhook Events](https://docs.truv.com/api-reference/bank-accounts/events.md): Webhook events for bank account creation and updates. - [The Deposit Switch object](https://docs.truv.com/api-reference/deposit-switch/object.md): Learn about the values for reports for Direct Deposit Switch (DDS). - [Retrieve a direct deposit switch report for a link](https://docs.truv.com/api-reference/deposit-switch/link_detail_reports_dds.md): The endpoint returns the DDS report for a link - [Retrieve a paycheck linked loan report](https://docs.truv.com/api-reference/deposit-switch/link_detail_reports_pll.md): The endpoint returns the PLL report. - [The User Deposit Switch Object](https://docs.truv.com/api-reference/dds-reports/object.md): Find reference information on this page for Direct Deposit Switch (DDS) reports. - [Retrieve a deposit switch report](https://docs.truv.com/api-reference/dds-reports/dds-report-retrieve.md): The endpoint retrieves a deposit switch report for a user. - [The Insurance object](https://docs.truv.com/api-reference/insurance/object.md): View the comprehensive reference information for insurance data responses. - [Retrieve an auto insurance report](https://docs.truv.com/api-reference/insurance/link_detail_reports_insurance_auto.md): The endpoint returns the auto insurance report. - [Retrieve a home insurance report](https://docs.truv.com/api-reference/insurance/link_detail_reports_insurance_home.md): The endpoint returns the home insurance report. - [Retrieve an insurance report](https://docs.truv.com/api-reference/insurance/link_detail_reports_insurance.md): The endpoint returns the Insurance report. ## OpenAPI Specs - [openapi](https://docs.truv.com/openapi.yaml)