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
Headers
Authorization
Bearer authentication of the form Bearer <token>, where token is your auth token.
Accept
Specify the content type and version that the API should use. It's recommended to include this to avoid breaking changes.
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
This endpoint expects an object.
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.
| VALUE | DESCRIPTION |
| ---------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |
| child-support | Determine child support payments (available to verifiers that represent a state or local child support enforcement agencies) |
| credit-application | The target's application for credit |
| employee-eligibility | Employee's eligibility for a benefit granted by a governmental agency required by law to consider the employee's financial responsibility or status |
| employee-request | The target has issued the verifier written instruction to obtain this information |
| employee-review-or-collection | Performing a review or collection of the target's account |
| employment | Employment purposes where the target has given prior written consent |
| insurance-underwriting-application | Underwriting insurance in response to the target's application |
| legitimate-reason-initiated | Legitimate business need for the information in connection with a business transaction initiated by the target |
| legitimate-reason-review | Legitimate business need to review the target's account to determine whether the employee continues to meet the terms of the account |
| risk-assessment | To assess the credit or prepayment risks associated with an existing credit obligation of the target |
| subpoena | For a court order or a federal grand jury subpoena
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
| VALUE | DESCRIPTION |
| ------------------ | ------------------------------------------------------------------------------------------------------------------------------ |
| mortgage | Verification for a mortgage |
| home-equity | Verification for home equity
| background | Verification for a background check |
| tenant | Verification for a rental property |
| government | Verification for government/social services |
| auto | Verification for auto lending |
| lending | Verification for personal loans or consumer lending |
| credit | Verification for credit cards |
| identity | Verification for identity or fraud |
| insurance | Verification for insurance |
| health | Verification for health services |
| offers | Verification for offers |
| account-management | Verification for account management |
| preapproval | Verification for preapprovals |
additional_information
Any additional information about the target that can help expedite the completion of 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
Order and Verification Request Created.
id
employer_search
Response object specific to Employer Search requests.
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
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
