aid: truework
url: https://raw.githubusercontent.com/api-evangelist/truework/refs/heads/main/apis.yml
apis:
- aid: truework:truework-js
  name: Truework.js (Truework Direct)
  tags:
  - JavaScript
  - SDK
  - Embedded
  humanURL: https://www.truework.com/docs/guides/truework-direct/truework-js-reference
  baseURL: https://js.truework.com/v1
  properties:
  - url: https://www.truework.com/docs/guides/truework-direct/truework-js-reference
    type: Documentation
  - url: https://www.truework.com/docs/guides/truework-direct/getting-started
    type: Documentation
  - url: https://github.com/truework/truework.js-examples
    type: CodeExamples
  description: '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.

    '
- aid: truework:truework-subpackage-orders-api
  name: Truework Subpackage Orders API
  description: The subpackage_orders API from Truework — 8 operation(s) for subpackage_orders.
  humanURL: https://www.truework.com/docs/api-reference
  baseURL: https://api.truework.com
  tags: []
  tags_raw:
  - subpackage_orders
  properties:
  - type: OpenAPI
    url: openapi/truework-subpackage-orders-api-openapi.yml
  - type: Documentation
    url: https://www.truework.com/docs/api-reference
  - type: Documentation
    url: https://www.truework.com/docs/api-reference/versions/2023-10-30
  - type: JSONSchema
    url: json-schema/truework-order-schema.json
  - type: JSONSchema
    url: json-schema/truework-report-schema.json
  - type: JSONLD
    url: json-ld/truework-context.jsonld
  - type: Documentation
    url: https://www.truework.com/docs/api-reference/webhooks
  - type: Documentation
    url: https://www.truework.com/docs/api-reference/webhooks/security
- aid: truework:truework-subpackage-qualificationchecks-api
  name: Truework Subpackage Qualification Checks API
  description: The subpackage_qualificationChecks API from Truework — 3 operation(s) for subpackage_qualificationchecks.
  humanURL: https://www.truework.com/docs/api-reference
  baseURL: https://api.truework.com
  tags:
  - subpackage_qualificationChecks
  properties:
  - type: OpenAPI
    url: openapi/truework-subpackage-qualificationchecks-api-openapi.yml
  - type: Documentation
    url: https://www.truework.com/docs/api-reference
  - type: Documentation
    url: https://www.truework.com/docs/api-reference/versions/2023-10-30
  - type: JSONSchema
    url: json-schema/truework-order-schema.json
  - type: JSONSchema
    url: json-schema/truework-report-schema.json
  - type: JSONLD
    url: json-ld/truework-context.jsonld
  - type: Documentation
    url: https://www.truework.com/docs/api-reference/webhooks
  - type: Documentation
    url: https://www.truework.com/docs/api-reference/webhooks/security
- aid: truework:truework-subpackage-reports-api
  name: Truework Subpackage Reports API
  description: The subpackage_reports API from Truework — 1 operation(s) for subpackage_reports.
  humanURL: https://www.truework.com/docs/api-reference
  baseURL: https://api.truework.com
  tags: []
  tags_raw:
  - subpackage_reports
  properties:
  - type: OpenAPI
    url: openapi/truework-subpackage-reports-api-openapi.yml
  - type: Documentation
    url: https://www.truework.com/docs/api-reference
  - type: Documentation
    url: https://www.truework.com/docs/api-reference/versions/2023-10-30
  - type: JSONSchema
    url: json-schema/truework-order-schema.json
  - type: JSONSchema
    url: json-schema/truework-report-schema.json
  - type: JSONLD
    url: json-ld/truework-context.jsonld
  - type: Documentation
    url: https://www.truework.com/docs/api-reference/webhooks
  - type: Documentation
    url: https://www.truework.com/docs/api-reference/webhooks/security
- aid: truework:truework-subpackage-tenantproperties-api
  name: Truework Subpackage Tenant Properties API
  description: The subpackage_tenantProperties API from Truework — 2 operation(s) for subpackage_tenantproperties.
  humanURL: https://www.truework.com/docs/api-reference
  baseURL: https://api.truework.com
  tags:
  - subpackage_tenantProperties
  properties:
  - type: OpenAPI
    url: openapi/truework-subpackage-tenantproperties-api-openapi.yml
  - type: Documentation
    url: https://www.truework.com/docs/api-reference
  - type: Documentation
    url: https://www.truework.com/docs/api-reference/versions/2023-10-30
  - type: JSONSchema
    url: json-schema/truework-order-schema.json
  - type: JSONSchema
    url: json-schema/truework-report-schema.json
  - type: JSONLD
    url: json-ld/truework-context.jsonld
  - type: Documentation
    url: https://www.truework.com/docs/api-reference/webhooks
  - type: Documentation
    url: https://www.truework.com/docs/api-reference/webhooks/security
- aid: truework:truework-truework-webhooks-api
  name: Truework Webhooks API
  description: The Truework Webhooks API from Truework — 0 operation(s) for truework webhooks.
  humanURL: https://www.truework.com/docs/guides/truework-direct/truework-js-reference
  baseURL: https://js.truework.com/v1
  tags:
  - Truework Webhooks
  properties:
  - type: OpenAPI
    url: openapi/truework-truework-webhooks-api-openapi.yml
name: Truework
tags:
- Verification
- Income Verification
- Employment Verification
- VOIE
- Mortgage
- Lending
- Credit Union
- Identity
- KYC
- Fintech
tags_raw:
- Verifications
- Income Verification
- Employment Verification
- VOIE
- Mortgage
- Lending
- Credit Unions
- Identity
- KYC
- Fintech
kind: contract
deliveryModel:
  model: saas
  open_source: false
  commercial: true
  callable_host: true
  label: Hosted service · you call their endpoint
  confidence: high
  source:
  - openapi
  - pricing
  generated: '2026-08-28'
  method: derived
accessModel:
  pricing: unknown
  onboarding: unknown
  trial: false
  try_now: false
  public: false
  label: Unknown
  confidence: low
  source:
  - plans
  - authentication
  - security
  generated: '2026-09-03'
  method: derived
image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/icons/truework.png
access: 3rd-Party
common:
- type: CapabilityMap
  url: capabilities/truework-capability-edges.yml
  name: Truework Business Capability Map
- type: Website
  url: https://www.truework.com/
- type: PostmanWorkspace
  url: https://www.postman.com/kinlaneapi/truework/overview
- type: AgenticAccess
  url: agentic-access/truework-agentic-access.yml
- type: DomainSecurity
  url: security/truework-domain-security.yml
- type: Authentication
  url: authentication/truework-authentication.yml
- type: Portal
  url: https://www.truework.com
- type: Documentation
  url: https://www.truework.com/docs
- type: Documentation
  url: https://www.truework.com/docs/api-reference
  name: API Reference
- type: Documentation
  url: https://www.truework.com/docs/api-reference/versions/2023-10-30
  name: API Version 2023-10-30
- type: Documentation
  url: https://www.truework.com/docs/api-reference/versions
  name: Versioning
- type: Versioning
  url: https://www.truework.com/docs/api-reference/versions
- type: Authentication
  url: https://www.truework.com/docs/api-reference/authentication
- type: RateLimits
  url: https://www.truework.com/docs/api-reference/limits
- type: ErrorCodes
  url: https://www.truework.com/docs/api-reference/versions/2023-10-30
- type: Sandbox
  url: https://www.truework.com/docs/api-reference/sandbox
  name: Sandbox Environment
- type: Documentation
  url: https://www.truework.com/docs/api-reference/sandbox/test-cases
  name: Sandbox Test Cases
- type: Documentation
  url: https://www.truework.com/docs/api-reference/monitoring
  name: Monitoring
- type: Webhooks
  url: https://www.truework.com/docs/api-reference/webhooks
- type: Documentation
  url: https://www.truework.com/docs/api-reference/webhooks/security
  name: Webhook Security
- type: Documentation
  url: https://www.truework.com/docs/guides
  name: Guides
- type: GettingStarted
  url: https://www.truework.com/docs/guides/api/getting-started
- type: Documentation
  url: https://www.truework.com/docs/guides/methods
  name: Verification Methods
- type: Documentation
  url: https://www.truework.com/docs/guides/workflows
  name: API Workflows
- type: Documentation
  url: https://www.truework.com/docs/guides/truework-direct/getting-started
  name: Truework Direct
- type: Documentation
  url: https://www.truework.com/docs/guides/truework-direct/truework-js-reference
  name: Truework.js Reference
- type: Documentation
  url: https://www.truework.com/docs/guides/mortgage/mortgage-intro
  name: Mortgage Solutions
- type: Documentation
  url: https://www.truework.com/docs/guides/mortgage/mortgage-los
  name: LOS Integrations
- type: Documentation
  url: https://www.truework.com/docs/guides/mortgage/mortgage-pos
  name: POS Integrations
- type: Portal
  url: https://www.truework.com/products/api
  name: Truework API Product Page
- type: Portal
  url: https://www.truework.com/products
  name: Products
- type: Signup
  url: https://app.truework.com/requester/signup
- type: Login
  url: https://app.truework.com/requester/login
- type: Sandbox
  url: https://api.truework-sandbox.com
  name: Sandbox API
- type: StatusPage
  url: https://truework.statuspage.io
- type: Support
  url: https://help.truework.com
  name: Help Center
- type: Documentation
  url: https://www.truework.com/legal/terms
  name: Terms of Service
- type: PrivacyPolicy
  url: https://www.truework.com/legal/privacy
- type: GitHubOrganization
  url: https://github.com/truework
- type: SDKs
  url: https://github.com/truework/truework.js-examples
  name: Truework.js Examples
- type: Tools
  url: https://github.com/truework/gretchen
  name: gretchen
- type: Tools
  url: https://github.com/truework/mounty
  name: mounty
- type: LinkedIn
  url: https://www.linkedin.com/company/truework
- type: Blog
  url: https://www.truework.com/resource-center/blog
- type: Plans
  url: plans/truework-plans-pricing.yml
- type: RateLimits
  url: rate-limits/truework-rate-limits.yml
- type: FinOps
  url: finops/truework-finops.yml
- type: Features
  data:
  - Six verification methods orchestrated automatically — Instant Data, Payroll Credentials, Bank Credentials,
    Tax Credentials, Smart Outreach, Document Upload
  - Coverage of over 97% of U.S. workers from a single platform
  - Truework Direct (Truework.js) borrower-driven verification widget loaded from https://js.truework.com/v1
  - Dated API versioning (current 2023-10-30) with per-key version pinning via the Accept header
  - Bearer-token API keys, prefixed tw_sk_ (production) and tw_sk_test_ (sandbox)
  - Publishable keys (tw_pk_, tw_pk_test_) for client-side Truework.js
  - Sandbox environment at https://api.truework-sandbox.com with deterministic test SSN fixtures
  - Webhook delivery with 48-hour retry and X-Truework-Token header authentication
  - Up to 10 webhook destinations per account
  - 10 req/s per source IP and 10 req/s per account rate envelope, with 429 on overage
  - Order lifecycle states pending-approval, processing, action-required, completed, canceled, invalid
  - Asynchronous target-employer orders plus synchronous employer-search orders
  - Reverification endpoint POST /orders/reverification for refreshing prior reports
  - Beta Qualification Checks for low-latency knockout decisioning on verified income/employment
  - Beta Tenant Properties for tenant-scoped verification configuration
  - GSE-ready unified reporting (Day 1 Certainty, AIM, GUS) for mortgage lenders
  - LOS integrations (Encompass, Empower) and POS integrations (Blend, nCino)
  - Public OpenAPI specs published from truework.docs.buildwithfern.com
  sources:
  - https://www.truework.com/docs
  - https://www.truework.com/docs/api-reference
  - https://www.truework.com/docs/api-reference/limits
  - https://www.truework.com/docs/api-reference/webhooks
  - https://www.truework.com/products/api
  - https://www.truework.com/products
  updated: '2026-05-24'
created: '2026-05-24T00:00:00.000Z'
modified: '2026-09-16'
position: Consuming
description: '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.

  '
maintainers:
- FN: Kin Lane
  email: info@apievangelist.com
  X: apievangelist
  url: https://apievangelist.com
specificationVersion: '0.23'