# Transcrypts

## Docs

- [Bank Income Report](https://sdk.transcrypts.com/bank-income/income-report.md): Income verification data derived from bank account transaction history, identifying income sources, frequency, and amounts
- [Employment](https://sdk.transcrypts.com/income-and-employment/employment.md): Employment object attributes and data structure for tracking user employment data
- [Retrieve Employment History Report](https://sdk.transcrypts.com/income-and-employment/employment-history-report.md): Get the VOE (Verification of Employment) report for a link
- [Retrieve an Employment](https://sdk.transcrypts.com/income-and-employment/employment-retrieve.md): Get the most recent employment data for a specific link
- [Employment Webhooks](https://sdk.transcrypts.com/income-and-employment/employment-webhooks.md): Webhook payload examples for employment data events
- [List All Employments](https://sdk.transcrypts.com/income-and-employment/employments-list.md): Retrieve a list of all employment records associated with a specific link
- [Identity](https://sdk.transcrypts.com/income-and-employment/identity.md): Identity object attributes and data structure for user personal information
- [Retrieve an Identity](https://sdk.transcrypts.com/income-and-employment/identity-retrieve.md): Get the identity data for a user associated with a specific link
- [Identity Webhooks](https://sdk.transcrypts.com/income-and-employment/identity-webhooks.md): Webhook payload examples for identity profile events
- [Retrieve Income and Employment Report](https://sdk.transcrypts.com/income-and-employment/income-employment-report.md): Get the VOIE (Verification of Income and Employment) report for a link
- [Pay Statements](https://sdk.transcrypts.com/income-and-employment/pay-statements.md): Pay statement attributes and data structure for income and employment verification
- [Pay Statements Webhooks](https://sdk.transcrypts.com/income-and-employment/pay-statements-webhooks.md): Webhook payload examples for pay statement events
- [Reports](https://sdk.transcrypts.com/income-and-employment/reports.md): Report object attributes and data structure for income and employment verification reports
- [Retrieve a Statement](https://sdk.transcrypts.com/income-and-employment/statement-retrieve.md): Get a specific pay statement by ID
- [List All Statements](https://sdk.transcrypts.com/income-and-employment/statements-list.md): Retrieve a list of pay statements associated with a specific link
- [Retrieve Tax Document](https://sdk.transcrypts.com/income-and-employment/tax-document-retrieve.md): Get a specific tax document by ID
- [Tax Documents](https://sdk.transcrypts.com/income-and-employment/tax-documents.md): Tax document attributes and data structure
- [List All Tax Documents](https://sdk.transcrypts.com/income-and-employment/tax-documents-list.md): Retrieve a list of tax documents associated with a specific link
- [Instant Verification](https://sdk.transcrypts.com/instant-verification/instant-verification.md): Instant Verification object attributes and data structure for real-time employment and income verification
- [Create an Instant Verification](https://sdk.transcrypts.com/instant-verification/instant-verification-create.md): Submit a new instant verification request for employment and income data
- [List All Instant Verifications](https://sdk.transcrypts.com/instant-verification/instant-verification-list.md): Retrieve a paginated list of all instant verification requests
- [Retrieve an Instant Verification](https://sdk.transcrypts.com/instant-verification/instant-verification-retrieve.md): Get the details and results of a specific instant verification request
- [Instant Verification Webhooks](https://sdk.transcrypts.com/instant-verification/instant-verification-webhooks.md): Webhook payload examples for instant verification events
- [Orders API](https://sdk.transcrypts.com/orders/orders.md): Overview of the Orders API for creating customized landing pages and managing verification orders
- [Add New Employer to Existing Order](https://sdk.transcrypts.com/orders/orders-add-employer.md): Add a new employer to an order that is already in progress
- [Cancel an Order](https://sdk.transcrypts.com/orders/orders-cancel.md): Cancel an existing order in the Transcrypts system
- [Retrieve Self-Certification Results](https://sdk.transcrypts.com/orders/orders-certifications.md): Retrieve self-certification results for employments and accounts reviewed by the user
- [Create an Order](https://sdk.transcrypts.com/orders/orders-create.md): Create an order within the Transcrypts system
- [Retrieve Events for an Order](https://sdk.transcrypts.com/orders/orders-events.md): Returns a list of events for the specified order
- [Retrieve an Order Invoice](https://sdk.transcrypts.com/orders/orders-invoice.md): Returns an order invoice for the specified order
- [Get List of Orders by SSN](https://sdk.transcrypts.com/orders/orders-list-lookup.md): Returns a list of orders by an applicant SSN
- [Retrieve an Order](https://sdk.transcrypts.com/orders/orders-read.md): Retrieve order details from the Transcrypts system
- [Create a Data Refresh Order](https://sdk.transcrypts.com/orders/orders-refresh.md): Create a new order with data populated from an existing order
- [Update an Order](https://sdk.transcrypts.com/orders/orders-update.md): Modify an existing order when all employers are in pending or sent status
- [Orders Webhooks](https://sdk.transcrypts.com/orders/orders-webhooks.md): Webhook events for order status changes
- [API Keys Rotation](https://sdk.transcrypts.com/overview/api-keys-rotation.md): Guide for creating new keys, removing outdated keys, and implementing rotation procedures for Transcrypts API credentials.
- [Introduction](https://sdk.transcrypts.com/overview/introduction.md): Overview of the Transcrypts Employment and Income Verification platform, verification methods, authentication, protocols, security, error handling, and rate limiting.
- [Postman Collection](https://sdk.transcrypts.com/overview/postman-collection.md): Get started with the Transcrypts API integration using the Postman Collection with little to no code needed.
- [Advanced Security and mTLS](https://sdk.transcrypts.com/platform-management/advanced-security-and-mtls.md): Configure mutual TLS (mTLS) for secure API access and webhook communication with Transcrypts
- [Connection Lifecycle](https://sdk.transcrypts.com/platform-management/connection-lifecycle.md): Task status lifecycle, data processing stages, and connection timing for Transcrypts payroll connections
- [Data Structure](https://sdk.transcrypts.com/platform-management/data-structure.md): Overview of Transcrypts's data architecture including Links, Tasks, and provider connections
- [Webhook Event Descriptions](https://sdk.transcrypts.com/platform-management/webhook-event-descriptions.md): Detailed descriptions and example payloads for all Transcrypts webhook events
- [Webhooks](https://sdk.transcrypts.com/platform-management/webhooks.md): Configure and verify webhooks for real-time Task status updates and platform event notifications
- [Account Links](https://sdk.transcrypts.com/user-flow-endpoints/account-links.md): Overview of Account Links and their properties
- [Bridge Token](https://sdk.transcrypts.com/user-flow-endpoints/bridge-token.md): A short-lived token required to open Transcrypts Bridge.
- [Create a Bridge Token](https://sdk.transcrypts.com/user-flow-endpoints/bridge-token-create.md): Generate a bridge token required to initialize the Transcrypts Bridge widget.
- [Companies and Data Providers](https://sdk.transcrypts.com/user-flow-endpoints/companies-and-data-providers.md): Companies represent organizations where users work. Data Providers represent user data storage systems.
- [Search Companies with Autocomplete](https://sdk.transcrypts.com/user-flow-endpoints/company-autocomplete-search.md): Search for companies using prefix-based matching with autocomplete support.
- [Get Company Information](https://sdk.transcrypts.com/user-flow-endpoints/company-info.md): Retrieve detailed information for a specific company mapping.
- [Search Companies](https://sdk.transcrypts.com/user-flow-endpoints/company-mapping.md): Locate a company and retrieve its company_mapping_id.
- [Data Refresh](https://sdk.transcrypts.com/user-flow-endpoints/data-refresh.md): Refresh data from an existing Link without re-entering payroll credentials
- [Retrieve a Link Token](https://sdk.transcrypts.com/user-flow-endpoints/link-exchange-token.md): Exchange a bridge public token for a link access token
- [Delete a Link](https://sdk.transcrypts.com/user-flow-endpoints/links-delete.md): Remove a link and all associated data
- [Retrieve a Link](https://sdk.transcrypts.com/user-flow-endpoints/links-item.md): Retrieve details for a specific account link
- [List All Links](https://sdk.transcrypts.com/user-flow-endpoints/links-list.md): Retrieve a list of all account links
- [Account Links Webhooks](https://sdk.transcrypts.com/user-flow-endpoints/links-webhooks.md): Webhook payloads for Account Link lifecycle events
- [Retrieve a Data Provider](https://sdk.transcrypts.com/user-flow-endpoints/providers-detail.md): Retrieve information about a specific data provider.
- [List All Data Providers](https://sdk.transcrypts.com/user-flow-endpoints/providers-list.md): Retrieve a filtered list of data providers by product type.
- [Retrieve a Data Refresh Status](https://sdk.transcrypts.com/user-flow-endpoints/refresh-task.md): Get the current status of a data refresh task
- [Create a Data Refresh Task](https://sdk.transcrypts.com/user-flow-endpoints/refresh-task-create.md): Initiate a data refresh for an existing user link
- [List All Tasks](https://sdk.transcrypts.com/user-flow-endpoints/tasks-list.md): Retrieve a list of all tasks
- [Retrieve a Task](https://sdk.transcrypts.com/user-flow-endpoints/tasks-read.md): Retrieve details for a specific task
- [Users](https://sdk.transcrypts.com/user-flow-endpoints/users.md): User objects represent distinct users that connect their accounts via Transcrypts Bridge.
- [Create a User](https://sdk.transcrypts.com/user-flow-endpoints/users-create.md): Create a new user in the Transcrypts system.
- [Delete a User](https://sdk.transcrypts.com/user-flow-endpoints/users-delete.md): Permanently remove a user from the Transcrypts system.
- [List All Users](https://sdk.transcrypts.com/user-flow-endpoints/users-list.md): Retrieve a complete list of users from the Transcrypts API.
- [Retrieve a User](https://sdk.transcrypts.com/user-flow-endpoints/users-read.md): Retrieve user information from the Transcrypts API.
- [Update a User](https://sdk.transcrypts.com/user-flow-endpoints/users-update.md): Update an existing user's information within the Transcrypts system.
- [Webhook Endpoints](https://sdk.transcrypts.com/user-flow-endpoints/webhook-endpoints.md): Manage webhook configurations for real-time event notifications
- [List Webhook Request History](https://sdk.transcrypts.com/user-flow-endpoints/webhook-requests-list.md): Retrieve a paginated list of webhook requests filtered by criteria
- [Create a Webhook](https://sdk.transcrypts.com/user-flow-endpoints/webhooks-create.md): Create a new webhook for receiving event notifications
- [Delete a Webhook](https://sdk.transcrypts.com/user-flow-endpoints/webhooks-delete.md): Remove a webhook configuration from your account
- [List All Webhooks](https://sdk.transcrypts.com/user-flow-endpoints/webhooks-list.md): Retrieve a list of all configured webhooks
- [Retrieve a Webhook](https://sdk.transcrypts.com/user-flow-endpoints/webhooks-read.md): Retrieve details for a specific webhook configuration
- [Update a Webhook](https://sdk.transcrypts.com/user-flow-endpoints/webhooks-update.md): Modify the configuration of an existing webhook
- [Create a User Bank Income Insights Report](https://sdk.transcrypts.com/user-reports/income-insights-create.md): Creates a bank income insights report for a specified user
- [Income Insights Reports](https://sdk.transcrypts.com/user-reports/income-insights-reports.md): Income Insights report containing information on income that a user receives to their bank account(s) across all connected institutions
- [Retrieve a User Bank Income Insights Report](https://sdk.transcrypts.com/user-reports/income-insights-retrieve.md): Retrieves a bank income insights report for a specific user
- [VOIE Reports](https://sdk.transcrypts.com/user-reports/voie-reports.md): Verification of Income and Employment (VOIE) reports containing information from user accounts
- [Create an Income and Employment Report](https://sdk.transcrypts.com/user-reports/voie-reports-create.md): Creates a verification report for a user showing income and employment details
- [Retrieve an Income and Employment Report](https://sdk.transcrypts.com/user-reports/voie-reports-retrieve.md): Retrieves a previously generated income and employment report for a specific user
- [Bank Integration](https://sdk.transcrypts.com/verification-methods/bank-integration.md): Verify income through bank account deposit history and transaction analysis
- [Verification Methods](https://sdk.transcrypts.com/verification-methods/overview.md): Overview of all verification methods available through the Transcrypts platform for employment and income verification
- [Payroll Integration](https://sdk.transcrypts.com/verification-methods/payroll-integration.md): Connect directly to payroll providers for comprehensive employment and income verification including pay statements, tax documents, and employer details
- [Social Security Verification](https://sdk.transcrypts.com/verification-methods/social-security.md): Verify employment history through the Social Security Administration (SSA)
- [Stored Credentials](https://sdk.transcrypts.com/verification-methods/stored-credentials.md): Re-verify users quickly using previously stored credentials without requiring additional user action

## OpenAPI Specs

- [openapi](https://sdk.transcrypts.com/api-reference/openapi.json)

## Optional

- [npm](https://www.npmjs.com/package/transcrypts)