Get one order

GET

/orders/:order_id

GET

/orders/:order_id

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

Try it

200Retrieved

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

Retrieves an order by id.

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

idstring>=1 character<=128 characters

employer_searchobjectOptional

Response object specific to Employer Search requests.

loan_idstringOptional

The loan id associated with the verification request

reverificationobjectOptional

Response object specific to Reverification requests.

search_keystringOptional

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

submitting_partyobjectOptional

Party who originally submitted the order, when using an API integration.

target_employerobjectOptional

Response object specific to Target Employer requests.

truework_directobjectOptional

Response object specific to Truework Direct requests.

verification_requestslist of objectsOptional

Get one order

Path parameters

Headers

Query parameters

Response

Errors