Create a Truework Direct order

POST

/orders/truework-direct

POST

/orders/truework-direct

1 import requests
2 
3 url = "https://api.truework-sandbox.com/orders/truework-direct"
4 
5 payload = { "targets": [
6         {
7             "contact_email": "contact_email",
8             "date_of_birth": "1990-05-20",
9             "first_name": "Jane",
10             "last_name": "Doe",
11             "permissible_purpose": "child-support",
12             "social_security_number": "000-00-0000",
13             "type": "employment-income",
14             "use_case": "mortgage"
15         }
16     ] }
17 headers = {
18     "Accept": "application/json",
19     "Authorization": "Bearer <token>",
20     "Content-Type": "application/json"
21 }
22 
23 response = requests.post(url, json=payload, headers=headers)
24 
25 print(response.json())

Try it

201Created

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           "disputes": [
239             {
240               "created": "2021-12-20T18:50:20Z",
241               "id": "AAAAAAAAAL8AElevkrw2n2vI8ScqGJEf50Lfg4W9LiQXwi-KSmg7DH0P",
242               "description": "Employee Title",
243               "reference_id": "d75346a0-a747-4907-a506-639ea436f2b0"
244             }
245           ],
246           "paystubs": [
247             {
248               "id": "AAAAAAAAAmEADp7bmZJNhm4Kr5FM_ty5A_JX-Rxh04GSIHwmIRyp6Xss",
249               "base": "7000.00",
250               "bonus": "1000.00",
251               "commission": "0.00",
252               "gross": "8000.00",
253               "net": "5500.00",
254               "other": "0.00",
255               "overtime": "0.00",
256               "pay_period_hours": "86.67",
257               "reference_id": "6894632654"
258             }
259           ]
260         }
261       ],
262       "reseller_originating_party": {
263         "originating_party": "Acme Corporation",
264         "permissible_purpose": {
265           "canonical_value": "child-support",
266           "raw_value": "raw_value"
267         },
268         "use_case": {
269           "canonical_value": "mortgage",
270           "raw_value": "raw_value"
271         }
272       }
273     }
274   ]
275 }

POST requests create an order with a Truework Direct session token, used for instantiating the Truework.js widget.

Request

This endpoint expects an object.

targetslist of objectsRequired

loan_idstringOptional

The loan id associated with the verification request

search_keystringOptional

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

Response

Order 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 a Truework Direct order

Headers

Request

Response

Errors