API workflows | Truework Docs

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

Endpoint	Request Type	Description
Target Employer Order /orders/target-employer	POST	Triggers 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	POST	Integrates 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	POST	Instantly 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

Endpoint	Request Type	Description
Get One Order /orders/{order_id}	GET	Retrieves an order and any available income and/or employment verification reports, using the `order_id` when an order completed webhook is returned.
Get Status Updates /orders/{order_id}/events	GET	Returns all events associated with an Order at the time of the request.
Get One Report /reports/{verification_report_id}	GET	Retrieves 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	GET	Retrieves 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 mortgage use case only	POST	Requests 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	PUT	Cancels 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`)

Qualification checks endpoints (beta)

This endpoint is in beta for the tenant use case only and is subject to change. Please contact implementations@truework.com for more information before integrating.

Endpoint	Request Type	Description
Create a Qualification Check Request /qualification-checks	POST	Creates a new qualification check and returns a JSON object with the resulting evaluation.
Get One Qualification Check Result /qualification-checks/{qualification_check_result_id}	GET	Retrieves a qualification check result by id.
Get All Qualification Check Sets /qualification-check-sets	GET	Retrieves all qualification check set rulesets for evaluating income data

Questions about your workflow?

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