Get all orders

GET

/orders

GET

/orders

1 import requests
2 
3 url = "https://api.truework.com/orders"
4 
5 querystring = {"limit":"10","offset":"0","search_key":"search123","include_report_annotations":"true","verification_id":"AAAAAAAAQnIAAYd5YHFVOm8PNX2ecFbEjqV__upOKUE8YE_IK2GwSQTP"}
6 
7 headers = {
8     "Accept": "application/json",
9     "Authorization": "Bearer <token>"
10 }
11 
12 response = requests.get(url, headers=headers, params=querystring)
13 
14 print(response.json())

Try it

200Retrieved

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       "submitting_party": {
55         "email": "jane@example.com",
56         "name": "Jane Doe"
57       },
58       "target_employer": {
59         "permissible_purpose": {
60           "canonical_value": "child-support",
61           "raw_value": "raw_value"
62         },
63         "request_config": {
64           "allowed_verification_methods": [
65             "instant"
66           ],
67           "required_eligibilities": [
68             "d1c"
69           ]
70         },
71         "target": {
72           "date_of_birth": "1985-12-20",
73           "first_name": "Jane",
74           "last_name": "Doe",
75           "social_security_number": "***-**-0000"
76         },
77         "type": "employment-income",
78         "use_case": {
79           "canonical_value": "mortgage",
80           "raw_value": "raw_value"
81         },
82         "additional_information": "some notes about the target",
83         "loan_id": "1234",
84         "reseller_originating_party": {
85           "originating_party": "Acme Corporation",
86           "permissible_purpose": {
87             "canonical_value": "child-support",
88             "raw_value": "raw_value"
89           },
90           "use_case": {
91             "canonical_value": "mortgage",
92             "raw_value": "raw_value"
93           }
94         },
95         "search_key": "12345"
96       },
97       "truework_direct": {
98         "targets": [
99           {
100             "date_of_birth": "1990-05-20",
101             "permissible_purpose": {
102               "canonical_value": "child-support",
103               "raw_value": "raw_value"
104             },
105             "social_security_number": "***-**-0000",
106             "truework_direct_session_token": "tjs_i1D3IHdW52_vsLP5vQTng7vXBX93UD_7UdtVOIH2qVQ",
107             "type": "employment-income",
108             "use_case": {
109               "canonical_value": "mortgage",
110               "raw_value": "raw_value"
111             },
112             "companies": [
113               {
114                 "name": "Acme Corp"
115               }
116             ],
117             "contact_email": "jane.doe@example.com",
118             "first_name": "Jane",
119             "last_name": "Doe",
120             "reseller_originating_party": {
121               "originating_party": "Acme Corporation",
122               "permissible_purpose": {
123                 "canonical_value": "child-support",
124                 "raw_value": "raw_value"
125               },
126               "use_case": {
127                 "canonical_value": "mortgage",
128                 "raw_value": "raw_value"
129               }
130             },
131             "truework_direct_session_link": "https://app.truework.com/api/connect/employee/email/tjs_i1D3IHdW52_vsLP5vQTng7vXBX93UD_7UdtVOIH2qVQ"
132           }
133         ]
134       },
135       "verification_requests": [
136         {
137           "created": "2021-12-20T18:50:20Z",
138           "id": "AAAAAAAAAosABwGqF1AUKAH0-puth1tCzLNar3Jyb4bx3wdVKU99XC26",
139           "permissible_purpose": {
140             "canonical_value": "child-support",
141             "raw_value": "raw_value"
142           },
143           "state": {
144             "canonical_value": "pending-approval",
145             "raw_value": "raw_value"
146           },
147           "target": {
148             "first_name": "Jane",
149             "last_name": "Doe",
150             "social_security_number": "***-**-0000"
151           },
152           "turnaround_time": {
153             "best_estimate": "48",
154             "lower_bound": "20",
155             "upper_bound": "128"
156           },
157           "type": "employment-income",
158           "use_case": {
159             "canonical_value": "mortgage",
160             "raw_value": "raw_value"
161           },
162           "additional_information": "some notes about the target",
163           "applicant_documents": [
164             {
165               "detections": [
166                 {
167                   "count": 1,
168                   "outcome": {
169                     "canonical_value": "passed",
170                     "raw_value": "raw_value"
171                   },
172                   "type": {
173                     "canonical_value": "ssn-mismatch",
174                     "raw_value": "raw_value"
175                   }
176                 }
177               ],
178               "id": "AAAAAAAAA3IAF7BGt6e3K0DXcz2pU2ZnvhxOzrfckvfNROXjJN9Rf6oV",
179               "url": "url"
180             }
181           ],
182           "date_of_completion": "2021-12-20T18:50:20Z",
183           "loan_id": "1234",
184           "reports": [
185             {
186               "created": "2021-12-20T18:50:20Z",
187               "current_as_of": "2021-12-20",
188               "id": "AAAAAAAADU8ACy03lGitY_ocCMCcgproUq8Gt4r37MM6GbyX2-DxWM3Y",
189               "verification_request": {
190                 "created": "2021-12-20T18:50:20Z",
191                 "id": "AAAAAAAAEboABwQhKv1_pWO7MWtZs28ksPTH0uSt6GffsoIJPj7e69P1",
192                 "type": "employment-income"
193               },
194               "applicant_documents": [
195                 {
196                   "detections": [
197                     {
198                       "count": 1,
199                       "outcome": {
200                         "canonical_value": "passed",
201                         "raw_value": "raw_value"
202                       },
203                       "type": {
204                         "canonical_value": "ssn-mismatch",
205                         "raw_value": "raw_value"
206                       }
207                     }
208                   ],
209                   "id": "AAAAAAAAA3IAF7BGt6e3K0DXcz2pU2ZnvhxOzrfckvfNROXjJN9Rf6oV",
210                   "url": "url"
211                 }
212               ],
213               "disputes": [
214                 {
215                   "created": "2021-12-20T18:50:20Z",
216                   "id": "AAAAAAAAAL8AElevkrw2n2vI8ScqGJEf50Lfg4W9LiQXwi-KSmg7DH0P",
217                   "description": "Employee Title",
218                   "reference_id": "d75346a0-a747-4907-a506-639ea436f2b0"
219                 }
220               ],
221               "paystubs": [
222                 {
223                   "id": "AAAAAAAAAmEADp7bmZJNhm4Kr5FM_ty5A_JX-Rxh04GSIHwmIRyp6Xss",
224                   "base": "7000.00",
225                   "bonus": "1000.00",
226                   "commission": "0.00",
227                   "gross": "8000.00",
228                   "net": "5500.00",
229                   "other": "0.00",
230                   "overtime": "0.00",
231                   "pay_period_hours": "86.67",
232                   "reference_id": "6894632654"
233                 }
234               ]
235             }
236           ],
237           "reseller_originating_party": {
238             "originating_party": "Acme Corporation",
239             "permissible_purpose": {
240               "canonical_value": "child-support",
241               "raw_value": "raw_value"
242             },
243             "use_case": {
244               "canonical_value": "mortgage",
245               "raw_value": "raw_value"
246             }
247           }
248         }
249       ]
250     }
251   ],
252   "next": "https://api.truework.com/resource?limit=25&offset=50",
253   "previous": "https://api.truework.com/resource?limit=25"
254 }

An order is a consolidation of multiple verifications.

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

nextstringOptional

previousstringOptional

Get all orders

Headers

Query parameters

Response

Errors