For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Truework.comAPI StatusGet your API key
HomeGuidesAPI referenceHelp
HomeGuidesAPI referenceHelp
    • Introduction
  • Using the API
    • Authentication
    • Versioning
    • Webhooks
    • Sandbox environment
    • Monitoring
    • Limits
  • Verification orders & reports
    • POSTCreate a target employer order
    • POSTCreate an employer search order
    • POSTCreate a Truework Direct order
    • GETGet one order
    • GETGet all orders
    • PUTCancel an order
    • GETGet one report
    • GETGet order events
    • POSTReverify a report
  • Public beta APIs
  • Previous API versions
    • API version 2022-08-01
    • API version 2020-12-07
    • API version 2019-10-15
LogoLogo
Truework.comAPI StatusGet your API key

Get one order

GET
/orders/:order_id
GET
/orders/:order_id
$curl https://api.truework-sandbox.com/orders/order_id \
>     -H "Authorization: Bearer <token>"
1{
2  "employer_search": {
3    "additional_information": "some notes about the target",
4    "authorization_forms": [
5      {
6        "filename": "test.pdf"
7      }
8    ],
9    "loan_id": "1234",
10    "metadata": {
11      "file_number": "C4066199"
12    },
13    "permissible_purpose": {
14      "canonical_value": "child-support",
15      "raw_value": "string"
16    },
17    "request_config": {
18      "employer_filter": "any-employers"
19    },
20    "reseller_originating_party": {
21      "originating_party": "Acme Corporation",
22      "permissible_purpose": {
23        "canonical_value": "child-support",
24        "raw_value": "string"
25      },
26      "use_case": {
27        "canonical_value": "mortgage",
28        "raw_value": "string"
29      }
30    },
31    "search_key": "12345",
32    "target": {
33      "contact_email": "string",
34      "date_of_birth": "1985-12-20",
35      "first_name": "Jane",
36      "last_name": "Doe",
37      "social_security_number": "***-**-0000"
38    },
39    "type": "employment-income",
40    "use_case": {
41      "canonical_value": "mortgage",
42      "raw_value": "string"
43    }
44  },
45  "id": "AAAAAAAAAosABwGqF1AUKAH0-puth1tCzLNar3Jyb4bx3wdVKU99XC26",
46  "loan_id": "1234",
47  "reverification": {
48    "parent_order_id": "string",
49    "targets": [
50      {
51        "first_name": "string",
52        "last_name": "string",
53        "truework_direct_session_token": "string"
54      }
55    ]
56  },
57  "search_key": "internal_key_12345",
58  "target_employer": {
59    "additional_information": "some notes about the target",
60    "authorization_forms": [
61      {
62        "filename": "test.pdf"
63      }
64    ],
65    "loan_id": "1234",
66    "metadata": {
67      "file_number": "C4066199"
68    },
69    "permissible_purpose": {
70      "canonical_value": "child-support",
71      "raw_value": "string"
72    },
73    "request_config": {
74      "allowed_verification_methods": [
75        "instant"
76      ]
77    },
78    "reseller_originating_party": {
79      "originating_party": "Acme Corporation",
80      "permissible_purpose": {
81        "canonical_value": "child-support",
82        "raw_value": "string"
83      },
84      "use_case": {
85        "canonical_value": "mortgage",
86        "raw_value": "string"
87      }
88    },
89    "search_key": "12345",
90    "target": {
91      "company": {
92        "address": {
93          "address": "1234 Rainbow Road",
94          "city": "San Francisco",
95          "country_code": "US",
96          "country_subdivision_code": "CA",
97          "extended_address": null,
98          "postal_code": "98265"
99        },
100        "name": "Acme Inc"
101      },
102      "contact_email": "string",
103      "date_of_birth": "1985-12-20",
104      "first_name": "Jane",
105      "last_name": "Doe",
106      "social_security_number": "***-**-0000"
107    },
108    "type": "employment-income",
109    "use_case": {
110      "canonical_value": "mortgage",
111      "raw_value": "string"
112    }
113  },
114  "truework_direct": {
115    "targets": [
116      {
117        "authorization_forms": [
118          {
119            "filename": "test.pdf"
120          }
121        ],
122        "companies": [
123          {
124            "action": {
125              "canonical_value": "verify",
126              "raw_value": "string"
127            },
128            "address": {
129              "address": "1234 Rainbow Road",
130              "city": "San Francisco",
131              "country_code": "US",
132              "country_subdivision_code": "CA",
133              "extended_address": "Suite 300",
134              "postal_code": "98265"
135            },
136            "name": "Acme Corp",
137            "phone_number": "string"
138          }
139        ],
140        "contact_email": "jane.doe@example.com",
141        "date_of_birth": "1990-05-20",
142        "first_name": "Jane",
143        "last_name": "Doe",
144        "metadata": {
145          "file_number": "C4066199"
146        },
147        "permissible_purpose": {
148          "canonical_value": "child-support",
149          "raw_value": "string"
150        },
151        "reseller_originating_party": {
152          "originating_party": "Acme Corporation",
153          "permissible_purpose": {
154            "canonical_value": "child-support",
155            "raw_value": "string"
156          },
157          "use_case": {
158            "canonical_value": "mortgage",
159            "raw_value": "string"
160          }
161        },
162        "self_employment": {
163          "business_name": "Jane Doe Consulting"
164        },
165        "social_security_number": "***-**-0000",
166        "truework_direct_session_link": "https://app.truework.com/api/connect/employee/email/tjs_i1D3IHdW52_vsLP5vQTng7vXBX93UD_7UdtVOIH2qVQ",
167        "truework_direct_session_token": "tjs_i1D3IHdW52_vsLP5vQTng7vXBX93UD_7UdtVOIH2qVQ",
168        "type": "employment-income",
169        "use_case": {
170          "canonical_value": "mortgage",
171          "raw_value": "string"
172        }
173      }
174    ]
175  },
176  "truework_direct_session_link": "string",
177  "verification_requests": [
178    {
179      "additional_information": "some notes about the target",
180      "applicant_documents": [
181        {
182          "detections": [
183            {
184              "count": 1,
185              "outcome": {
186                "canonical_value": "passed",
187                "raw_value": "string"
188              },
189              "type": {
190                "canonical_value": "ssn-mismatch",
191                "raw_value": "string"
192              }
193            }
194          ],
195          "id": "AAAAAAAAA3IAF7BGt6e3K0DXcz2pU2ZnvhxOzrfckvfNROXjJN9Rf6oV",
196          "url": "string"
197        }
198      ],
199      "cancellation_details": "string",
200      "cancellation_reason": {
201        "canonical_value": "immediate",
202        "raw_value": "string"
203      },
204      "created": "2021-12-20T18:50:20.291247Z",
205      "date_of_completion": "2021-12-20T18:50:20.291247Z",
206      "documents": [
207        {
208          "filename": "test.pdf"
209        }
210      ],
211      "id": "AAAAAAAAAosABwGqF1AUKAH0-puth1tCzLNar3Jyb4bx3wdVKU99XC26",
212      "loan_id": "1234",
213      "metadata": {
214        "file_number": "C4066199"
215      },
216      "permissible_purpose": {
217        "canonical_value": "child-support",
218        "raw_value": "string"
219      },
220      "reports": [
221        {
222          "additional_notes": "string",
223          "annotations": {
224            "applicant": {
225              "employee": {
226                "positions": [
227                  {
228                    "end_date": {},
229                    "start_date": {},
230                    "title": "Software Engineer"
231                  }
232                ],
233                "salary": {
234                  "pay_rate": {}
235                },
236                "status": {
237                  "canonical_value": {},
238                  "raw_value": {}
239                },
240                "status_detail": {
241                  "canonical_value": {},
242                  "raw_value": {}
243                }
244              },
245              "employer": {
246                "email": "string",
247                "name": "string",
248                "phone_number": "string"
249              }
250            },
251            "verifier": {
252              "employee": {
253                "positions": [
254                  {
255                    "end_date": {},
256                    "start_date": {},
257                    "title": "Software Engineer"
258                  }
259                ],
260                "salary": {
261                  "pay_rate": {}
262                },
263                "status": {
264                  "canonical_value": {},
265                  "raw_value": {}
266                },
267                "status_detail": {
268                  "canonical_value": {},
269                  "raw_value": {}
270                }
271              },
272              "employer": {
273                "email": "string",
274                "name": "string",
275                "phone_number": "string"
276              }
277            }
278          },
279          "applicant_documents": [
280            {
281              "detections": [
282                {
283                  "count": 1,
284                  "outcome": {
285                    "canonical_value": "passed",
286                    "raw_value": "string"
287                  },
288                  "type": {
289                    "canonical_value": "ssn-mismatch",
290                    "raw_value": "string"
291                  }
292                }
293              ],
294              "id": "AAAAAAAAA3IAF7BGt6e3K0DXcz2pU2ZnvhxOzrfckvfNROXjJN9Rf6oV",
295              "url": "string"
296            }
297          ],
298          "completed": "2021-12-20T18:50:20.291247Z",
299          "completed_by_method": {
300            "canonical_value": "instant",
301            "raw_value": "string"
302          },
303          "created": "2021-12-20T18:50:20.291247Z",
304          "current_as_of": "2021-12-20",
305          "disputes": [
306            {
307              "created": "2021-12-20T18:50:20.291247Z",
308              "description": "Employee Title",
309              "id": "AAAAAAAAAL8AElevkrw2n2vI8ScqGJEf50Lfg4W9LiQXwi-KSmg7DH0P",
310              "reference_id": "d75346a0-a747-4907-a506-639ea436f2b0"
311            }
312          ],
313          "eligibilities": [
314            {
315              "is_eligible": true,
316              "provider": {
317                "canonical_value": "truework",
318                "raw_value": "truework"
319              },
320              "reference_id": "FNM123",
321              "type": {
322                "canonical_value": "d1c",
323                "raw_value": "string"
324              }
325            }
326          ],
327          "employee": {
328            "address": {
329              "address": "1234 Rainbow Road",
330              "city": "San Francisco",
331              "country_code": "US",
332              "country_subdivision_code": "CA",
333              "extended_address": "Suite 300",
334              "postal_code": "98265"
335            },
336            "earnings": [
337              {
338                "base": "35000.00",
339                "bonus": "0.00",
340                "commission": "100.25",
341                "other": "0.00",
342                "overtime": "200.00",
343                "total": "35300.25",
344                "year": "2020"
345              }
346            ],
347            "email": "john.doe@example.com",
348            "first_name": "Jane",
349            "hired_date": "2023-05-15",
350            "last_name": "Doe",
351            "on_leave_date": "2023-08-20",
352            "original_hired_date": "2020-02-16",
353            "positions": [
354              {
355                "employment_type": {
356                  "canonical_value": "regular-full-time",
357                  "raw_value": "string"
358                },
359                "end_date": "2022-12-31",
360                "start_date": "2022-01-01",
361                "title": "Software Engineer"
362              }
363            ],
364            "salary": {
365              "hours_per_week": "40",
366              "pay_frequency": {
367                "canonical_value": "annually",
368                "raw_value": "string"
369              },
370              "pay_rate": {
371                "amount": "150000.00",
372                "unit": {
373                  "canonical_value": {},
374                  "raw_value": {}
375                }
376              },
377              "reduced_covid": "yes"
378            },
379            "social_security_number": "***-**-0000",
380            "status": {
381              "canonical_value": "active",
382              "raw_value": "string"
383            },
384            "status_detail": {
385              "canonical_value": "active",
386              "raw_value": "string"
387            },
388            "termination_date": "2024-02-29"
389          },
390          "employer": {
391            "address": {
392              "address": "1234 Rainbow Road",
393              "city": "San Francisco",
394              "country_code": "US",
395              "country_subdivision_code": "CA",
396              "extended_address": "Suite 300",
397              "postal_code": "98265"
398            },
399            "government_ids": [
400              {
401                "id": "123456789",
402                "type": {
403                  "canonical_value": "us-fein",
404                  "raw_value": "string"
405                }
406              }
407            ],
408            "name": "ACME Inc"
409          },
410          "financial_institution_accounts": [
411            {
412              "account_name": "string",
413              "account_type": "string",
414              "financial_institution_name": "string",
415              "income_streams": [
416                {
417                  "age_in_months": 1,
418                  "average_monthly_net_income": 1.1,
419                  "confidence": 1,
420                  "confidence_level": "string",
421                  "end_date": "2023-01-15",
422                  "estimated_gross_annual": 1.1,
423                  "frequency_days": 1,
424                  "id": "AAAAAAAAAosABwGqF1AUKAH0-puth1tCzLNar3Jyb4bx3wdVKU99XC31",
425                  "name": "string",
426                  "net_annual": 1.1,
427                  "periods": [
428                    {
429                      "amount": 1.1,
430                      "amount_duration": "string",
431                      "amount_type": "string",
432                      "estimated_gross_income": {
433                        "average_monthly_net_income": 1.1,
434                        "estimated_gross_annual": 1.1,
435                        "net_annual": 1.1
436                      },
437                      "id": "AAAAAAAAAosABwGqF1AUKAH0-puth1tCzLNar3Jyb4bx3wdVKU99XC31",
438                      "start_day": "2023-01-15"
439                    }
440                  ],
441                  "start_date": "2023-01-15",
442                  "status": "string"
443                }
444              ],
445              "number": "string",
446              "oldest_transaction_date": "2023-01-15",
447              "owner_name": "string",
448              "snapshots": [
449                {
450                  "available_balance": 1.1,
451                  "average_monthly_balance": 1.1,
452                  "balance": 1.1,
453                  "balance_date": "2023-01-15",
454                  "currency_code": "string",
455                  "id": "AAAAAAAAAosABwGqF1AUKAH0-puth1tCzLNar3Jyb4bx3wdVKU99XC31",
456                  "tot_number_days_since_most_recent_insufficient_funds_fee_debit_tx_account": 1,
457                  "tot_number_insufficient_funds_fee_debit_tx_account": 1,
458                  "tot_number_insufficient_funds_fee_debit_tx_over_2_months_account": 1
459                }
460              ]
461            }
462          ],
463          "id": "AAAAAAAADU8ACy03lGitY_ocCMCcgproUq8Gt4r37MM6GbyX2-DxWM3Y",
464          "income_analytics": {
465            "annualized_income": {
466              "base_amount": {
467                "amount": "34.95",
468                "currency": "USD"
469              },
470              "gross_amount": {
471                "amount": "34.95",
472                "currency": "USD"
473              },
474              "short_employment_warning": true,
475              "stale_data_warning": true,
476              "variable_income_warning": true
477            },
478            "income_volatility": {
479              "gross_income_volatility": "0.1234"
480            }
481          },
482          "paystubs": [
483            {
484              "base": "7000.00",
485              "bonus": "1000.00",
486              "commission": "0.00",
487              "gross": "8000.00",
488              "id": "AAAAAAAAAmEADp7bmZJNhm4Kr5FM_ty5A_JX-Rxh04GSIHwmIRyp6Xss",
489              "net": "5500.00",
490              "other": "0.00",
491              "overtime": "0.00",
492              "pay_date": "2023-01-15",
493              "pay_period_end_date": "2023-01-15",
494              "pay_period_hours": "86.67",
495              "pay_period_start_date": "2023-01-15",
496              "reference_id": "6894632654"
497            }
498          ],
499          "respondent": {
500            "email": "john.doe@example.com",
501            "full_name": "John Doe",
502            "title": "Software Engineer"
503          },
504          "verification_request": {
505            "created": "2021-12-20T18:50:20.291247Z",
506            "id": "AAAAAAAAEboABwQhKv1_pWO7MWtZs28ksPTH0uSt6GffsoIJPj7e69P1",
507            "type": "employment"
508          }
509        }
510      ],
511      "reseller_originating_party": {
512        "originating_party": "Acme Corporation",
513        "permissible_purpose": {
514          "canonical_value": "child-support",
515          "raw_value": "string"
516        },
517        "use_case": {
518          "canonical_value": "mortgage",
519          "raw_value": "string"
520        }
521      },
522      "state": {
523        "canonical_value": "pending-approval",
524        "raw_value": "string"
525      },
526      "target": {
527        "company": {
528          "address": "string",
529          "city": "string",
530          "id": 1,
531          "name": "Example Inc.",
532          "phone_number": "string",
533          "state": "string",
534          "zip_code": "string"
535        },
536        "contact_email": "string",
537        "date_of_birth": "2023-01-15",
538        "first_name": "Jane",
539        "last_name": "Doe",
540        "phone_number": "string",
541        "social_security_number": "***-**-0000"
542      },
543      "turnaround_time": {
544        "best_estimate": "48",
545        "lower_bound": "20",
546        "upper_bound": "128"
547      },
548      "type": "employment-income",
549      "unverified_information": {
550        "applicant": {
551          "employee": {
552            "positions": [
553              {
554                "end_date": "2023-01-15",
555                "start_date": "2023-01-15",
556                "title": "Software Engineer"
557              }
558            ],
559            "salary": {
560              "pay_rate": {
561                "amount": "150000.00",
562                "unit": {}
563              }
564            },
565            "status": {
566              "canonical_value": "active",
567              "raw_value": "string"
568            },
569            "status_detail": {
570              "canonical_value": "active",
571              "raw_value": "string"
572            }
573          },
574          "employer": {
575            "email": "string",
576            "name": "string",
577            "phone_number": "string"
578          }
579        },
580        "verifier": {
581          "employee": {
582            "positions": [
583              {
584                "end_date": "2023-01-15",
585                "start_date": "2023-01-15",
586                "title": "Software Engineer"
587              }
588            ],
589            "salary": {
590              "pay_rate": {
591                "amount": "150000.00",
592                "unit": {}
593              }
594            },
595            "status": {
596              "canonical_value": "active",
597              "raw_value": "string"
598            },
599            "status_detail": {
600              "canonical_value": "active",
601              "raw_value": "string"
602            }
603          },
604          "employer": {
605            "email": "string",
606            "name": "string",
607            "phone_number": "string"
608          }
609        }
610      },
611      "use_case": {
612        "canonical_value": "mortgage",
613        "raw_value": "string"
614      }
615    }
616  ]
617}
Retrieves an order by id.
Was this page helpful?
Previous

Get all orders

Next
Built with

Authentication

AuthorizationBearer
Bearer tokens conform to the [RFC6750](https://datatracker.ietf.org/doc/html/rfc6750#section-2.1) spec. Production API keys (secret keys) are prefixed with `tw_sk_` and sandbox keys are prefixed with `tw_sk_test_`. If your secret key is published, you should rotate your API keys. Truework.JS publishable keys are prefixed with `tw_pk_` and `tw_pk_test` respectively. **Examples** - For Authorization Headers: `Authorization: Bearer tw_sk_test_e508eb797edb95ade85284bcb54dd49ed45db1be` - For the "try it now" `token` field, input only the token itself, omitting `Bearer `.

Path parameters

order_idstringRequired
Order ID

Headers

AcceptenumOptionalDefaults to application/json
Specify the content type and version that the API should use. It's recommended to include this to avoid breaking changes.
Allowed values:

Query parameters

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

Response headers

Datestring
For JSON requests, the date at which the request was signed
X-Truework-Signaturestring
For JSON requests, the signature of the request, see: https://www.truework.com/docs/verifications-signatures

Response

OK
employer_searchobject or null
Response object specific to Employer Search requests.
idstring1-128 characters
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

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
406
Not Acceptable Error
429
Too Many Requests Error
451
Unavailable for Legal Reasons Error
500
Internal Server Error
501
Not Implemented Error

Bearer tokens conform to the RFC6750 spec.

Production API keys (secret keys) are prefixed with tw_sk_ and sandbox keys are prefixed with tw_sk_test_. If your secret key is published, you should rotate your API keys.

Truework.JS publishable keys are prefixed with tw_pk_ and tw_pk_test respectively.

Examples

  • For Authorization Headers: Authorization: Bearer tw_sk_test_e508eb797edb95ade85284bcb54dd49ed45db1be
  • For the “try it now” token field, input only the token itself, omitting Bearer .

For JSON requests, the signature of the request, see: https://www.truework.com/docs/verifications-signatures