Create an employer search order
POST requests create both an order and a verification. Returns a JSON object representing the newly created order and verification.
## Verification processing
Employer search verifications are processed _synchronously_: 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.
It is recommended to set a timeout on synchronous requests, to account for potential latency when calling our
partners. Synchronous requests generally take only a few seconds to complete, but in rare cases they may take longer.
This creates a verification request with the following attributes:
- No target company
- Is processed synchronously
- Is Instant verification method only
- Filter employers by one of the following: any-employers, current-employers, previous-employers
- Returns the verification on a new order object
Authentication
AuthorizationBearer
Bearer tokens conform to the [RFC6750](https://datatracker.ietf.org/doc/html/rfc6750#section-2.1) spec.
Production API keys (secret keys) are prefixed with `tw_sk_` and sandbox keys are prefixed with `tw_sk_test_`. If your secret key is published, you should rotate your API keys.
Truework.JS publishable keys are prefixed with `tw_pk_` and `tw_pk_test` respectively.
**Examples**
- For Authorization Headers: `Authorization: Bearer tw_sk_test_e508eb797edb95ade85284bcb54dd49ed45db1be`
- For the "try it now" `token` field, input only the token itself, omitting `Bearer `.
Headers
Accept
Specify the content type and version that the API should use. It's recommended to include this to avoid breaking changes.
Allowed values:
Query parameters
fields
Comma-separated names of fields to include in the response. Separate multiple fields with commas, and denote subfields with parentheses. Multiple subfields from the same type can be listed within parentheses. In case of a list, subfields apply to each individual object. If omitted, all fields are included.
include_income_analytics
Whether to calculate income analytics for the nested reports in each verification.
include_report_annotations
Include potentially unverified data in the response, including report annotations and unparsed documents.
Request
permissible_purpose
A valid purpose is required for Truework to process the verification request.
Throughout the API, this is signified by the permissible_purpose field.
target
Information on the individual who is being verified
type
Allowed values:
use_case
The verification request use case describes the type of product the verification request is originating from. If omitted, the verifier type in account settings will be used as a default
additional_information
Any additional information about the target that can help expedite the completion of the verification request
branch_id
The branch id associated with the verification request
loan_id
The loan id associated with the verification request
metadata
A single level key-value JSON object that can be used to store custom data on the verification request; keys and values must be strings
request_config
reseller_originating_party
The originating party that requested the verification via a reseller. reseller_originating_party is required for for companies that resell data provided by Truework.
search_key
A non-unique key that can be used to search for Orders
tenant_property_id
The ID of the tenant property to be used for this verification request.
Response headers
Date
For JSON requests, the date at which the request was signed
X-Truework-Signature
For JSON requests, the signature of the request, see: https://www.truework.com/docs/verifications-signatures
Response
Order and Verification Request Created.
assets
Response object specific to Assets requests or VOA add-ons.
branch_id
The branch id associated with the verification request
employer_search
Response object specific to Employer Search requests.
id
loan_id
The loan id associated with the verification request
reverification
Response object specific to Reverification requests.
search_key
A non-unique key that can be used to search for Orders
self_employment
Response object specific to Self Employment requests or self-employment add-ons.
target_employer
Response object specific to Target Employer requests.
truework_direct
Response object specific to Truework Direct requests.
truework_direct_session_link
The Truework Direct URL that is emailed to the applicant for eligible orders. Will only be present when the order is using Truework Direct via email for fulfillment, and the session is prepared for input from the applicant.
verification_requests
Errors
400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
406
Not Acceptable Error
429
Too Many Requests Error
451
Unavailable for Legal Reasons Error
500
Internal Server Error
501
Not Implemented Error