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
      • POSTCreate a Credentials Session
      • POSTCreate a Verification
      • GETGet All Verifications
      • GETGet One Verification
      • PUTReverify a Verification
      • PUTCancel a Verification
      • GETGet One Report
    • API version 2020-12-07
    • API version 2019-10-15
LogoLogo
Truework.comAPI StatusGet your API key
Previous API versionsAPI version 2022-08-01

Get All Verifications

Deprecated
GET
/verification-requests
GET
/verification-requests
$curl https://api.truework-sandbox.com/verification-requests \
>     -H "Authorization: Bearer <token>"
1{
2  "count": 253,
3  "next": "https://api.truework.com/resource?limit=25&offset=50",
4  "previous": "https://api.truework.com/resource?limit=25",
5  "results": [
6    {
7      "additional_information": "string",
8      "branch_id": "string",
9      "cancellation_details": "string",
10      "cancellation_reason": "immediate",
11      "created": "2021-12-20T18:50:20.291247Z",
12      "date_of_completion": "2021-12-20T18:50:20.291247Z",
13      "documents": [
14        {
15          "filename": "test.pdf"
16        }
17      ],
18      "id": "AAAAAAAAAosABwGqF1AUKAH0-puth1tCzLNar3Jyb4bx3wdVKU99XC26",
19      "loan_id": "string",
20      "metadata": {},
21      "permissible_purpose": "child-support",
22      "price": {
23        "amount": "34.95",
24        "currency": "USD"
25      },
26      "reports": [
27        {
28          "additional_notes": "string",
29          "created": "2021-12-20T18:50:20.291247Z",
30          "current_as_of": "2021-12-20",
31          "d1c_eligible": true,
32          "disputes": [
33            {
34              "created": "2021-12-20T18:50:20.291247Z",
35              "description": "Employee Title",
36              "id": "AAAAAAAAAL8AElevkrw2n2vI8ScqGJEf50Lfg4W9LiQXwi-KSmg7DH0P",
37              "reference_id": "d75346a0-a747-4907-a506-639ea436f2b0"
38            }
39          ],
40          "du_reference_id": "string",
41          "employee": {
42            "address": {
43              "address": "1234 Rainbow Road",
44              "city": "San Francisco",
45              "country_code": "US",
46              "country_subdivision_code": "CA",
47              "extended_address": "Suite 300",
48              "postal_code": "98265"
49            },
50            "earnings": [
51              {
52                "base": "35000.00",
53                "bonus": "0.00",
54                "commission": "100.25",
55                "other": "0.00",
56                "overtime": "200.00",
57                "termination": false,
58                "total": "35300.25",
59                "year": "2020"
60              }
61            ],
62            "email": "string",
63            "first_name": "Jane",
64            "hired_date": "2023-01-15",
65            "last_name": "Doe",
66            "on_leave_date": "2023-01-15",
67            "positions": [
68              {
69                "employment_type": "regular-full-time",
70                "end_date": "2023-01-15",
71                "start_date": "2023-01-15",
72                "title": "Software Engineer"
73              }
74            ],
75            "salary": {
76              "hours_per_week": "40",
77              "pay_frequency": "biweekly",
78              "pay_rate": {
79                "amount": "150000.00",
80                "unit": "annually"
81              },
82              "reduced_covid": "yes"
83            },
84            "social_security_number": "***-**-0000",
85            "status": "active",
86            "status_detail": "active",
87            "termination_date": "2023-01-15"
88          },
89          "employer": {
90            "address": {
91              "address": "1234 Rainbow Road",
92              "city": "San Francisco",
93              "country_code": "US",
94              "country_subdivision_code": "CA",
95              "extended_address": "Suite 300",
96              "postal_code": "98265"
97            },
98            "government_ids": [
99              {
100                "id": "123456789",
101                "type": "us-fein"
102              }
103            ],
104            "name": "string"
105          },
106          "id": "AAAAAAAADU8ACy03lGitY_ocCMCcgproUq8Gt4r37MM6GbyX2-DxWM3Y",
107          "income_analytics": {
108            "annualized_income": {
109              "amount": {
110                "amount": "34.95",
111                "currency": "USD"
112              },
113              "base_amount": {
114                "amount": "34.95",
115                "currency": "USD"
116              },
117              "gross_amount": {
118                "amount": "34.95",
119                "currency": "USD"
120              },
121              "short_employment_warning": true,
122              "stale_data_warning": true,
123              "variable_income_warning": true
124            },
125            "income_volatility": {
126              "gross_income_volatility": "string"
127            }
128          },
129          "paid_through_date": "2023-01-15",
130          "paystubs": [
131            {
132              "base": "7000.00",
133              "bonus": "1000.00",
134              "commission": "0.00",
135              "gross": "8000.00",
136              "id": "AAAAAAAAAmEADp7bmZJNhm4Kr5FM_ty5A_JX-Rxh04GSIHwmIRyp6Xss",
137              "net": "5500.00",
138              "other": "0.00",
139              "overtime": "0.00",
140              "pay_date": "2023-01-15",
141              "pay_period_end_date": "2023-01-15",
142              "pay_period_hours": "86.67",
143              "pay_period_start_date": "2023-01-15",
144              "reference_id": "6894632654"
145            }
146          ],
147          "pricing_tier": "instant",
148          "respondent": {
149            "email": "string",
150            "full_name": "string",
151            "title": "string"
152          },
153          "verification_request": {
154            "created": "2021-12-20T18:50:20.291247Z",
155            "id": "AAAAAAAAEboABwQhKv1_pWO7MWtZs28ksPTH0uSt6GffsoIJPj7e69P1",
156            "type": "employment"
157          }
158        }
159      ],
160      "request_parameters": {
161        "employer_filter": "target-employer",
162        "verification_methods": {
163          "credentials": {
164            "enabled": true
165          },
166          "instant": {
167            "enabled": true
168          },
169          "smart_outreach": {
170            "enabled": true
171          }
172        }
173      },
174      "reseller_originating_party": {
175        "originating_party": "string",
176        "permissible_purpose": "child-support",
177        "use_case": "mortgage"
178      },
179      "state": "pending-approval",
180      "target": {
181        "company": {
182          "address": "string",
183          "city": "string",
184          "id": 1,
185          "name": "Example Inc.",
186          "phone_number": "string",
187          "state": "string",
188          "zip_code": "string"
189        },
190        "contact_email": "string",
191        "date_of_birth": "2023-01-15",
192        "first_name": "Jane",
193        "last_name": "Doe",
194        "phone_number": "string",
195        "social_security_number": "***-**-0000"
196      },
197      "turnaround_time": {
198        "best_estimate": "48",
199        "lower_bound": "20",
200        "upper_bound": "128"
201      },
202      "type": "employment-income",
203      "use_case": "mortgage"
204    }
205  ]
206}
A Verification is used to retrieve information about an employee's occupation and compensation. The individual requesting the verification is referred to as the Verifier, and the individual who is being verified is referred to as the Target.
Was this page helpful?
Previous

Get One Verification

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 `.

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

stateenumOptional
Filter returned verifications by state
associated_idstring or nullOptional
Filter by associated ID
limitintegerOptionalDefaults to 25
Limit the number of results returned
offsetintegerOptionalDefaults to 0
Offset the results by page

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

A list of Verifications was successfully retrieved.
countinteger
nextstring or null
previousstring or null
resultslist of objects

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden 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