API reference

The Truework API is a JSON REST API that enables verifiers to quickly and programmatically order income and employment verifications and retrieve verification reports from Truework.

This reference guide provides detailed information about the Truework API, including the available endpoints, request and response formats, authentication, and other considerations. The guide is organized into the following sections:

  • Using the API: An overview of key aspects of the API, including authentication, versioning, and testing.
  • API reference: Detailed information about each API endpoint, including the request and response formats, query parameters, and examples.
  • Previous API versions: Detailed information about previous versions of the Truework API.

API Explorer

The API Explorer allows you to interact with the Truework API directly from your browser. You can use it to explore available endpoints, view request and response structures, and submit test API requests.

You can access the API Explorer below or by clicking the “Try It” button on any endpoint reference page.

API Explorer

Try the Truework API from the comfort of your browser.

Feedback

We welcome your feedback at implementations@truework.com. Please let us know about any errors you discover in this guide, or anything that would make this guide better.