Skip to content

api-evangelist/truework

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Truework (truework)

Truework operates a unified income and employment verification platform for mortgage lenders, credit unions, and fintechs. The Truework API orchestrates six verification methods — Instant Data, Payroll Credentials, Bank Credentials, Tax Credentials, Smart Outreach, and Document Upload — behind a single REST surface (api.truework.com), asynchronous webhooks, and the Truework.js / Truework Direct widget for consumer-permissioned verifications. The platform claims coverage of more than 97% of U.S. workers and 75% completion rates versus a ~48% industry average. Core resources are Orders, Verification Requests, Reports, and Order Events, with beta surfaces for Qualification Checks and Tenant Properties.

APIs.json: https://raw.githubusercontent.com/api-evangelist/truework/refs/heads/main/apis.yml

Scope

  • Position: Consuming
  • Access: 3rd-Party

Tags

  • Verifications
  • Income Verification
  • Employment Verification
  • VOIE
  • Mortgage
  • Lending
  • Credit Unions
  • Identity
  • KYC
  • Fintech

Timestamps

  • Created: 2026-05-24T00:00:00.000Z
  • Modified: 2026-05-24

APIs

Truework Verifications API

Truework Verifications API for orders, reports, and order events. Submit a verification of income and employment (VOIE) order against a known target employer, run a synchronous employer search, kick off a Truework Direct (Truework.js) borrower-driven verification, retrieve completed verification reports, list and cancel orders, and replay the order event log. Six verification methods are orchestrated automatically: Instant Data, Payroll Credentials, Bank Credentials, Tax Credentials, Smart Outreach, and Document Upload. Current API version is 2023-10-30; pinned per API key via the Accept header.

Tags

  • Verifications
  • VOIE
  • Orders
  • Reports
  • Mortgage

Properties

Truework Qualifications API (Beta)

Public beta surface for running qualification checks against a borrower's verified employment and income data. Create a qualification check, retrieve a check result, and list the qualification check sets defined for a tenant. Useful for low-latency knockout decisions (e.g. "minimum gross monthly income") layered on top of full verification reports.

Tags

  • Qualifications
  • Decisioning
  • Beta
  • VOIE

Properties

Truework Tenant Properties API (Beta)

Public beta surface for programmatically managing tenant-scoped configuration properties on Truework. Create, list, retrieve, and update tenant properties that govern verification behavior (allowed methods, branding, callback expectations) across the account.

Tags

  • Configuration
  • Tenant
  • Beta

Properties

Truework Webhooks

Truework emits two webhook event types — order.completed when every verification on an order is finished, and verification_request.state.change as individual verifications transition through pending-approval, processing, action-required, completed, canceled, and invalid. Each webhook destination is associated with a token delivered in the X-Truework-Token header so receivers can authenticate the call. Failed deliveries are retried periodically for up to 48 hours. Accounts may register up to 10 webhook destinations.

Tags

  • Webhooks
  • Events

Properties

Truework.js (Truework Direct)

Truework.js is the client-side JavaScript library that powers Truework Direct, the borrower-driven (consumer-permissioned) verification flow. The host page loads https://js.truework.com/v1 and initializes the widget with a session token created server-side via POST /orders/truework-direct, then handles onComplete, onClose, and onError callbacks. Publishable keys (tw_pk_* / tw_pk_test_*) authenticate the client.

Tags

  • JavaScript
  • SDK
  • Embedded

Properties

Common Properties

Maintainers

FN: Kin Lane Email: info@apievangelist.com URL: https://apievangelist.com

About

API Evangelist profile for Truework — income and employment verification APIs

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors