Get one order

GET

/orders/:order_id

GET

/orders/:order_id

1 curl -G https://api.truework-sandbox.com/orders/AAAAAAAAQnIAAYd5YHFVOm8PNX2ecFbEjqV__upOKUE8YE_IK2GwSQTP \
2      -H "Accept: application/json" \
3      -H "Authorization: Bearer <token>" \
4      -d include_report_annotations=true

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         "address": {
76           "address": "1234 Rainbow Road",
77           "city": "San Francisco",
78           "country_code": "US",
79           "country_subdivision_code": "CA",
80           "extended_address": "Suite 300",
81           "postal_code": "98265"
82         },
83         "name": "Acme Inc"
84       },
85       "contact_email": "contact_email",
86       "date_of_birth": "1985-12-20",
87       "first_name": "Jane",
88       "last_name": "Doe",
89       "social_security_number": "***-**-0000"
90     },
91     "type": "employment-income",
92     "use_case": {
93       "canonical_value": "mortgage",
94       "raw_value": "raw_value"
95     },
96     "additional_information": "some notes about the target",
97     "authorization_forms": [
98       {
99         "filename": "test.pdf"
100       }
101     ],
102     "loan_id": "1234",
103     "metadata": {
104       "key": "value"
105     },
106     "reseller_originating_party": {
107       "originating_party": "Acme Corporation",
108       "permissible_purpose": {
109         "canonical_value": "child-support",
110         "raw_value": "raw_value"
111       },
112       "use_case": {
113         "canonical_value": "mortgage",
114         "raw_value": "raw_value"
115       }
116     },
117     "search_key": "12345"
118   },
119   "truework_direct": {
120     "targets": [
121       {
122         "date_of_birth": "1990-05-20",
123         "permissible_purpose": {
124           "canonical_value": "child-support",
125           "raw_value": "raw_value"
126         },
127         "social_security_number": "***-**-0000",
128         "truework_direct_session_token": "tjs_i1D3IHdW52_vsLP5vQTng7vXBX93UD_7UdtVOIH2qVQ",
129         "type": "employment-income",
130         "use_case": {
131           "canonical_value": "mortgage",
132           "raw_value": "raw_value"
133         },
134         "companies": [
135           {
136             "name": "Acme Corp"
137           }
138         ],
139         "contact_email": "jane.doe@example.com",
140         "first_name": "Jane",
141         "last_name": "Doe",
142         "reseller_originating_party": {
143           "originating_party": "Acme Corporation",
144           "permissible_purpose": {
145             "canonical_value": "child-support",
146             "raw_value": "raw_value"
147           },
148           "use_case": {
149             "canonical_value": "mortgage",
150             "raw_value": "raw_value"
151           }
152         },
153         "truework_direct_session_link": "https://app.truework.com/api/connect/employee/email/tjs_i1D3IHdW52_vsLP5vQTng7vXBX93UD_7UdtVOIH2qVQ"
154       }
155     ]
156   },
157   "truework_direct_session_link": "truework_direct_session_link",
158   "verification_requests": [
159     {
160       "created": "2021-12-20T18:50:20Z",
161       "id": "AAAAAAAAAosABwGqF1AUKAH0-puth1tCzLNar3Jyb4bx3wdVKU99XC26",
162       "permissible_purpose": {
163         "canonical_value": "child-support",
164         "raw_value": "raw_value"
165       },
166       "state": {
167         "canonical_value": "pending-approval",
168         "raw_value": "raw_value"
169       },
170       "target": {
171         "first_name": "Jane",
172         "last_name": "Doe",
173         "social_security_number": "***-**-0000"
174       },
175       "turnaround_time": {
176         "best_estimate": "48",
177         "lower_bound": "20",
178         "upper_bound": "128"
179       },
180       "type": "employment-income",
181       "use_case": {
182         "canonical_value": "mortgage",
183         "raw_value": "raw_value"
184       },
185       "additional_information": "some notes about the target",
186       "applicant_documents": [
187         {
188           "detections": [
189             {
190               "count": 1,
191               "outcome": {
192                 "canonical_value": "passed",
193                 "raw_value": "raw_value"
194               },
195               "type": {
196                 "canonical_value": "ssn-mismatch",
197                 "raw_value": "raw_value"
198               }
199             }
200           ],
201           "id": "AAAAAAAAA3IAF7BGt6e3K0DXcz2pU2ZnvhxOzrfckvfNROXjJN9Rf6oV",
202           "url": "url"
203         }
204       ],
205       "cancellation_details": "cancellation_details",
206       "cancellation_reason": {
207         "canonical_value": "immediate",
208         "raw_value": "raw_value"
209       },
210       "date_of_completion": "2021-12-20T18:50:20Z",
211       "documents": [
212         {
213           "filename": "test.pdf"
214         }
215       ],
216       "loan_id": "1234",
217       "reports": [
218         {
219           "created": "2021-12-20T18:50:20Z",
220           "current_as_of": "2021-12-20",
221           "id": "AAAAAAAADU8ACy03lGitY_ocCMCcgproUq8Gt4r37MM6GbyX2-DxWM3Y",
222           "verification_request": {
223             "created": "2021-12-20T18:50:20Z",
224             "id": "AAAAAAAAEboABwQhKv1_pWO7MWtZs28ksPTH0uSt6GffsoIJPj7e69P1",
225             "type": "employment-income"
226           },
227           "applicant_documents": [
228             {
229               "detections": [
230                 {
231                   "count": 1,
232                   "outcome": {
233                     "canonical_value": "passed",
234                     "raw_value": "raw_value"
235                   },
236                   "type": {
237                     "canonical_value": "ssn-mismatch",
238                     "raw_value": "raw_value"
239                   }
240                 }
241               ],
242               "id": "AAAAAAAAA3IAF7BGt6e3K0DXcz2pU2ZnvhxOzrfckvfNROXjJN9Rf6oV",
243               "url": "url"
244             }
245           ],
246           "completed": "2021-12-20T18:50:20Z",
247           "disputes": [
248             {
249               "created": "2021-12-20T18:50:20Z",
250               "id": "AAAAAAAAAL8AElevkrw2n2vI8ScqGJEf50Lfg4W9LiQXwi-KSmg7DH0P",
251               "description": "Employee Title",
252               "reference_id": "d75346a0-a747-4907-a506-639ea436f2b0"
253             }
254           ],
255           "financial_institution_accounts": [
256             {
257               "income_streams": [
258                 {
259                   "confidence": 1,
260                   "confidence_level": "confidence_level",
261                   "id": "AAAAAAAAAosABwGqF1AUKAH0-puth1tCzLNar3Jyb4bx3wdVKU99XC31",
262                   "name": "name",
263                   "periods": [
264                     {
265                       "amount_duration": "amount_duration",
266                       "amount_type": "amount_type",
267                       "id": "AAAAAAAAAosABwGqF1AUKAH0-puth1tCzLNar3Jyb4bx3wdVKU99XC31",
268                       "start_day": "start_day"
269                     }
270                   ],
271                   "status": "status"
272                 }
273               ],
274               "snapshots": [
275                 {
276                   "id": "AAAAAAAAAosABwGqF1AUKAH0-puth1tCzLNar3Jyb4bx3wdVKU99XC31"
277                 }
278               ]
279             }
280           ],
281           "paystubs": [
282             {
283               "id": "AAAAAAAAAmEADp7bmZJNhm4Kr5FM_ty5A_JX-Rxh04GSIHwmIRyp6Xss",
284               "base": "7000.00",
285               "bonus": "1000.00",
286               "commission": "0.00",
287               "gross": "8000.00",
288               "net": "5500.00",
289               "other": "0.00",
290               "overtime": "0.00",
291               "pay_period_hours": "86.67",
292               "reference_id": "6894632654"
293             }
294           ]
295         }
296       ],
297       "reseller_originating_party": {
298         "originating_party": "Acme Corporation",
299         "permissible_purpose": {
300           "canonical_value": "child-support",
301           "raw_value": "raw_value"
302         },
303         "use_case": {
304           "canonical_value": "mortgage",
305           "raw_value": "raw_value"
306         }
307       }
308     }
309   ]
310 }

Retrieves an order by id.

Authentication

AuthorizationBearer

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

Path parameters

order_idstringRequired

Order ID

Query parameters

include_report_annotationsbooleanOptionalDefaults to false

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

Response

idstring1-128 characters

employer_searchobject

Response object specific to Employer Search requests.

loan_idstring

The loan id associated with the verification request

reverificationobject

Response object specific to Reverification requests.

search_keystring

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

target_employerobject

Response object specific to Target Employer requests.

truework_directobject

Response object specific to Truework Direct requests.

truework_direct_session_linkstring

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

Errors

400

Get One Order Request Bad Request Error

401

Get One Order Request Unauthorized Error

403

Get One Order Request Forbidden Error

404

Get One Order Request Not Found Error

406

Get One Order Request Not Acceptable Error

429

Get One Order Request Too Many Requests Error

451

Get One Order Request Unavailable for Legal Reasons Error

500

Get One Order Request Internal Server Error

501

Get One Order Request Not Implemented Error

Authentication

Path parameters

Headers

Query parameters

Response

Errors