Create an employer search order

POST

/orders/employer-search

POST

/orders/employer-search

1 import requests
2 
3 url = "https://api.truework-sandbox.com/orders/employer-search"
4 
5 querystring = {"fields":"id,verification_requests(id,reports(employee(positions(start_date),social_security_number)))","include_income_analytics":"true","include_report_annotations":"true"}
6 
7 payload = {
8     "permissible_purpose": "child-support",
9     "target": {
10         "date_of_birth": "1995-08-25",
11         "first_name": "Jane",
12         "last_name": "Doe",
13         "social_security_number": "000-00-0000"
14     },
15     "type": "employment-income",
16     "use_case": "mortgage"
17 }
18 headers = {
19     "Accept": "application/json",
20     "Authorization": "Bearer <token>",
21     "Content-Type": "application/json"
22 }
23 
24 response = requests.post(url, json=payload, headers=headers, params=querystring)
25 
26 print(response.json())

Try it

1 {
2   "id": "AAAAAAAAAosABwGqF1AUKAH0-puth1tCzLNar3Jyb4bx3wdVKU99XC26",
3   "employer_search": {
4     "permissible_purpose": {
5       "canonical_value": "child-support",
6       "raw_value": "raw_value"
7     },
8     "request_config": {
9       "employer_filter": "any-employers",
10       "required_eligibilities": [
11         "d1c"
12       ]
13     },
14     "target": {
15       "contact_email": "contact_email",
16       "date_of_birth": "1985-12-20",
17       "first_name": "Jane",
18       "last_name": "Doe",
19       "social_security_number": "***-**-0000"
20     },
21     "type": "employment-income",
22     "use_case": {
23       "canonical_value": "mortgage",
24       "raw_value": "raw_value"
25     },
26     "additional_information": "some notes about the target",
27     "authorization_forms": [
28       {
29         "filename": "test.pdf"
30       }
31     ],
32     "loan_id": "1234",
33     "metadata": {
34       "key": "value"
35     },
36     "reseller_originating_party": {
37       "originating_party": "Acme Corporation",
38       "permissible_purpose": {
39         "canonical_value": "child-support",
40         "raw_value": "raw_value"
41       },
42       "use_case": {
43         "canonical_value": "mortgage",
44         "raw_value": "raw_value"
45       }
46     },
47     "search_key": "12345"
48   },
49   "loan_id": "1234",
50   "reverification": {
51     "parent_order_id": "parent_order_id",
52     "targets": [
53       {
54         "first_name": "first_name",
55         "last_name": "last_name"
56       }
57     ]
58   },
59   "search_key": "internal_key_12345",
60   "target_employer": {
61     "permissible_purpose": {
62       "canonical_value": "child-support",
63       "raw_value": "raw_value"
64     },
65     "request_config": {
66       "allowed_verification_methods": [
67         "instant"
68       ],
69       "required_eligibilities": [
70         "d1c"
71       ]
72     },
73     "target": {
74       "company": {
75         "name": "Acme Inc"
76       },
77       "contact_email": "contact_email",
78       "date_of_birth": "1985-12-20",
79       "first_name": "Jane",
80       "last_name": "Doe",
81       "social_security_number": "***-**-0000"
82     },
83     "type": "employment-income",
84     "use_case": {
85       "canonical_value": "mortgage",
86       "raw_value": "raw_value"
87     },
88     "additional_information": "some notes about the target",
89     "authorization_forms": [
90       {
91         "filename": "test.pdf"
92       }
93     ],
94     "loan_id": "1234",
95     "metadata": {
96       "key": "value"
97     },
98     "reseller_originating_party": {
99       "originating_party": "Acme Corporation",
100       "permissible_purpose": {
101         "canonical_value": "child-support",
102         "raw_value": "raw_value"
103       },
104       "use_case": {
105         "canonical_value": "mortgage",
106         "raw_value": "raw_value"
107       }
108     },
109     "search_key": "12345"
110   },
111   "truework_direct": {
112     "targets": [
113       {
114         "date_of_birth": "1990-05-20",
115         "permissible_purpose": {
116           "canonical_value": "child-support",
117           "raw_value": "raw_value"
118         },
119         "social_security_number": "***-**-0000",
120         "truework_direct_session_token": "tjs_i1D3IHdW52_vsLP5vQTng7vXBX93UD_7UdtVOIH2qVQ",
121         "type": "employment-income",
122         "use_case": {
123           "canonical_value": "mortgage",
124           "raw_value": "raw_value"
125         },
126         "companies": [
127           {
128             "name": "Acme Corp"
129           }
130         ],
131         "contact_email": "jane.doe@example.com",
132         "first_name": "Jane",
133         "last_name": "Doe",
134         "reseller_originating_party": {
135           "originating_party": "Acme Corporation",
136           "permissible_purpose": {
137             "canonical_value": "child-support",
138             "raw_value": "raw_value"
139           },
140           "use_case": {
141             "canonical_value": "mortgage",
142             "raw_value": "raw_value"
143           }
144         },
145         "truework_direct_session_link": "https://app.truework.com/api/connect/employee/email/tjs_i1D3IHdW52_vsLP5vQTng7vXBX93UD_7UdtVOIH2qVQ"
146       }
147     ]
148   },
149   "truework_direct_session_link": "truework_direct_session_link",
150   "verification_requests": [
151     {
152       "created": "2021-12-20T18:50:20Z",
153       "id": "AAAAAAAAAosABwGqF1AUKAH0-puth1tCzLNar3Jyb4bx3wdVKU99XC26",
154       "permissible_purpose": {
155         "canonical_value": "child-support",
156         "raw_value": "raw_value"
157       },
158       "state": {
159         "canonical_value": "pending-approval",
160         "raw_value": "raw_value"
161       },
162       "target": {
163         "first_name": "Jane",
164         "last_name": "Doe",
165         "social_security_number": "***-**-0000"
166       },
167       "turnaround_time": {
168         "best_estimate": "48",
169         "lower_bound": "20",
170         "upper_bound": "128"
171       },
172       "type": "employment-income",
173       "use_case": {
174         "canonical_value": "mortgage",
175         "raw_value": "raw_value"
176       },
177       "additional_information": "some notes about the target",
178       "applicant_documents": [
179         {
180           "detections": [
181             {
182               "count": 1,
183               "outcome": {
184                 "canonical_value": "passed",
185                 "raw_value": "raw_value"
186               },
187               "type": {
188                 "canonical_value": "ssn-mismatch",
189                 "raw_value": "raw_value"
190               }
191             }
192           ],
193           "id": "AAAAAAAAA3IAF7BGt6e3K0DXcz2pU2ZnvhxOzrfckvfNROXjJN9Rf6oV",
194           "url": "url"
195         }
196       ],
197       "cancellation_details": "cancellation_details",
198       "cancellation_reason": {
199         "canonical_value": "immediate",
200         "raw_value": "raw_value"
201       },
202       "date_of_completion": "2021-12-20T18:50:20Z",
203       "documents": [
204         {
205           "filename": "test.pdf"
206         }
207       ],
208       "loan_id": "1234",
209       "reports": [
210         {
211           "created": "2021-12-20T18:50:20Z",
212           "current_as_of": "2021-12-20",
213           "id": "AAAAAAAADU8ACy03lGitY_ocCMCcgproUq8Gt4r37MM6GbyX2-DxWM3Y",
214           "verification_request": {
215             "created": "2021-12-20T18:50:20Z",
216             "id": "AAAAAAAAEboABwQhKv1_pWO7MWtZs28ksPTH0uSt6GffsoIJPj7e69P1",
217             "type": "employment-income"
218           },
219           "applicant_documents": [
220             {
221               "detections": [
222                 {
223                   "count": 1,
224                   "outcome": {
225                     "canonical_value": "passed",
226                     "raw_value": "raw_value"
227                   },
228                   "type": {
229                     "canonical_value": "ssn-mismatch",
230                     "raw_value": "raw_value"
231                   }
232                 }
233               ],
234               "id": "AAAAAAAAA3IAF7BGt6e3K0DXcz2pU2ZnvhxOzrfckvfNROXjJN9Rf6oV",
235               "url": "url"
236             }
237           ],
238           "completed": "2021-12-20T18:50:20Z",
239           "disputes": [
240             {
241               "created": "2021-12-20T18:50:20Z",
242               "id": "AAAAAAAAAL8AElevkrw2n2vI8ScqGJEf50Lfg4W9LiQXwi-KSmg7DH0P",
243               "description": "Employee Title",
244               "reference_id": "d75346a0-a747-4907-a506-639ea436f2b0"
245             }
246           ],
247           "financial_institution_accounts": [
248             {
249               "income_streams": [
250                 {
251                   "confidence": 1,
252                   "confidence_level": "confidence_level",
253                   "id": "AAAAAAAAAosABwGqF1AUKAH0-puth1tCzLNar3Jyb4bx3wdVKU99XC31",
254                   "name": "name",
255                   "periods": [
256                     {
257                       "amount_duration": "amount_duration",
258                       "amount_type": "amount_type",
259                       "id": "AAAAAAAAAosABwGqF1AUKAH0-puth1tCzLNar3Jyb4bx3wdVKU99XC31",
260                       "start_day": "start_day"
261                     }
262                   ],
263                   "status": "status"
264                 }
265               ],
266               "snapshots": [
267                 {
268                   "id": "AAAAAAAAAosABwGqF1AUKAH0-puth1tCzLNar3Jyb4bx3wdVKU99XC31"
269                 }
270               ]
271             }
272           ],
273           "paystubs": [
274             {
275               "id": "AAAAAAAAAmEADp7bmZJNhm4Kr5FM_ty5A_JX-Rxh04GSIHwmIRyp6Xss",
276               "base": "7000.00",
277               "bonus": "1000.00",
278               "commission": "0.00",
279               "gross": "8000.00",
280               "net": "5500.00",
281               "other": "0.00",
282               "overtime": "0.00",
283               "pay_period_hours": "86.67",
284               "reference_id": "6894632654"
285             }
286           ]
287         }
288       ],
289       "reseller_originating_party": {
290         "originating_party": "Acme Corporation",
291         "permissible_purpose": {
292           "canonical_value": "child-support",
293           "raw_value": "raw_value"
294         },
295         "use_case": {
296           "canonical_value": "mortgage",
297           "raw_value": "raw_value"
298         }
299       }
300     }
301   ]
302 }

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

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 authentication of the form Bearer <token>, where token is your auth token.

Query parameters

fieldsstringOptional

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_analyticsbooleanOptionalDefaults to false

Whether to calculate income analytics for the nested reports in each verification.

include_report_annotationsbooleanOptionalDefaults to false

Include potentially unverified data in the response, including report annotations and unparsed documents.

Request

This endpoint expects an object.

permissible_purposeenumRequired

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

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

targetobjectRequired

Information on the individual who is being verified

typeenumRequired

Allowed values:

use_caseenumRequired

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

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_informationstringOptional

Any additional information about the target that can help expedite the completion of the verification request

authorization_formslist of objectsOptional

Authorization form files provided by the verifier for the verification

loan_idstringOptional

The loan id associated with the verification request

metadatamap from strings to optional stringsOptional

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_configobjectOptional

reseller_originating_partyobjectOptional

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_keystringOptional

A non-unique key that can be used to search for Orders

tenant_property_idstringOptional

The ID of the tenant property to be used for this verification request.

Response

Order and Verification Request Created.

idstring>=1 character<=128 characters

employer_searchobject or null

Response object specific to Employer Search requests.

loan_idstring or null

The loan id associated with the verification request

reverificationobject or null

Response object specific to Reverification requests.

search_keystring or null

A non-unique key that can be used to search for Orders

target_employerobject or null

Response object specific to Target Employer requests.

truework_directobject or null

Response object specific to Truework Direct requests.

truework_direct_session_linkstring or null

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_requestslist of objects or null

Create an employer search order

Verification processing

Authentication

Headers

Query parameters

Request

Response

Errors

Verification processing