Get all orders

GET

/orders

GET

/orders

1 curl -G https://api.truework-sandbox.com/orders \
2      -H "Accept: application/json" \
3      -H "Authorization: Bearer <token>" \
4      -d limit=10 \
5      -d offset=0 \
6      -d search_key=search123 \
7      -d include_report_annotations=true \
8      -d verification_id=AAAAAAAAQnIAAYd5YHFVOm8PNX2ecFbEjqV__upOKUE8YE_IK2GwSQTP

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

An order is a consolidation of multiple verifications.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

limitintegerOptionalDefaults to 25

Limit the number of results returned

offsetintegerOptionalDefaults to 0

Offset the results by page

search_keystringOptional

Filter by search_key value passed in on Order creation

include_report_annotationsbooleanOptionalDefaults to false

Opt-in to including annotations on reports

verification_idstringOptional

Filter by associated verification_id

Response

A list of Orders was successfully retrieved.

countinteger

resultslist of objects

nextstring

previousstring

Errors

400

Get All Orders Request Bad Request Error

401

Get All Orders Request Unauthorized Error

403

Get All Orders Request Forbidden Error

406

Get All Orders Request Not Acceptable Error

429

Get All Orders Request Too Many Requests Error

451

Get All Orders Request Unavailable for Legal Reasons Error

500

Get All Orders Request Internal Server Error

501

Get All Orders Request Not Implemented Error

Authentication

Headers

Query parameters

Response

Errors