For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Truework.comAPI StatusGet your API key
HomeGuidesAPI referenceHelp
HomeGuidesAPI referenceHelp
    • Overview
    • Methods
    • Workflows
  • Target Employer API
    • Quickstart
  • Truework Direct API
    • Quickstart
    • Truework.js API reference
  • Mortgage Recipes
    • Truework for Mortgage
    • Truework LOS Integrations
    • Truework POS Integrations
LogoLogo
Truework.comAPI StatusGet your API key
On this page
  • Explore Truework Income workflows
  • Order Creation API endpoints
  • Order Management API endpoints
  • Report Types
  • Questions about orchestrating your workflow?

API workflows

Was this page helpful?
Previous

Quickstart

Next
Built with

Explore Truework Income workflows

Truework’s APIs are designed to expand verification coverage and remove dependencies with a single API call to initiate requests. The integration process with Truework depends on your specific use case, determining which API endpoints you’ll need to work with. Each of Truework’s APIs offers unique capabilities to tailor workflows to suit your business needs.

Take a look at our different endpoints below and start planning how they will best fit into your existing workflow.

Order Creation API endpoints

EndpointRequest TypeDescription
Target Employer Order
/orders/target-employer		POSTTriggers verification requests directly from your backend, typically through your system of record.

Target employer orders are processed asynchronously, meaning the order will be created and returned in the response body without any reports. Truework will send a webhook when the request is finished processing, and any available reports can be retrieved.

A target employer is required to create a verification request.
Truework Direct Order
/orders/truework-direct		POSTIntegrates directly into your frontend, enabling in-app verifications so that consumers don’t have to leave your application to provide verified employment data.

The Truework Direct endpoint creates an order with a Truework Direct session token, used for instantiating the Truework.js widget. Target employer orders are processed asynchronously, meaning the order will be created and returned in the response body without any reports. Truework will send a webhook when the request is finished processing, and any available reports can be retrieved.

A target employer is required to create a verification request.
Employer Search Order
/orders/employer-search		POSTInstantly triggers a verification requests directly from your backend.

Employer search verifications are processed synchronously, meaning Truework will attempt to process the verification during the initial POST request. If successful, the 201 response will include a reports key, which will contain the requested data.

A target employer is not required to create a verification request.

Order Management API endpoints

EndpointRequest TypeDescription
Get One Order
/orders/{order_id}		GETRetrieves an order and any available income and/or employment verification reports, using the order_id when an order completed webhook is returned.
Get Order Events
/orders/{order_id}/events		GETReturns all events associated with an Order at the time of the request.
Get One Report
/reports/{verification_report_id}		GETRetrieves a specific employment verification PDF report by its unique report ID. This endpoint is useful for fetching the final report after it is completed.
Get All Orders
/orders		GETRetrieves a list of all verification orders associated with the API service account, including both completed and in-progress orders. The response provides detailed information for each order, including order IDs, creation dates, statuses, and related metadata. The endpoint supports query parameters to filter and sort the results, allowing more efficient access to order data.
Reverify a Report
/orders/reverification
POSTRequests a report reverification, provided no more than 90 days have passed since the initial completion of the original verification.
Cancel an Order
/orders/{order_id}/cancel		PUTCancels all verification requests within an order, provided each request is not already completed or canceled. Requests can be canceled after 48 hours, unless it is in a state that requires verifier input. (e.g. action-required)

Report Types

The use-case passed in when creating an order determines the the type of report that will be returned. Notable report types include:

  • preapproval
  • mortgage
  • heloc
  • background
  • auto
Depending on your workflow, you may require multiple report types at different points in time in your loan lifecycle. Your Solutions point-of-contact at Truework can speak to options that best fit your organization.

Questions about orchestrating your workflow?

Not a problem. Send your questions to implementations@truework.com and a solutions expert will be happy to assist.