Get All Verifications

Deprecated

GET

/verification-requests

GET

/verification-requests

1 curl https://api.truework-sandbox.com/verification-requests \
2      -H "Accept: application/json" \
3      -H "Authorization: Bearer <token>"

Try it

200Retrieved

1 {
2   "count": 253,
3   "results": [
4     {
5       "created": "2021-12-20T18:50:20Z",
6       "id": "AAAAAAAAAosABwGqF1AUKAH0-puth1tCzLNar3Jyb4bx3wdVKU99XC26",
7       "permissible_purpose": "child-support",
8       "price": {
9         "amount": "34.95"
10       },
11       "state": "pending-approval",
12       "target": {
13         "first_name": "Jane",
14         "last_name": "Doe",
15         "social_security_number": "***-**-0000"
16       },
17       "turnaround_time": {
18         "best_estimate": "48",
19         "lower_bound": "20",
20         "upper_bound": "128"
21       },
22       "type": "employment-income",
23       "use_case": "mortgage",
24       "additional_information": "additional_information",
25       "cancellation_details": "cancellation_details",
26       "cancellation_reason": "immediate",
27       "date_of_completion": "2021-12-20T18:50:20Z",
28       "documents": [
29         {
30           "filename": "test.pdf"
31         }
32       ],
33       "loan_id": "loan_id",
34       "reports": [
35         {
36           "created": "2021-12-20T18:50:20Z",
37           "current_as_of": "2021-12-20",
38           "disputes": [
39             {
40               "created": "2021-12-20T18:50:20Z",
41               "description": "Employee Title",
42               "id": "AAAAAAAAAL8AElevkrw2n2vI8ScqGJEf50Lfg4W9LiQXwi-KSmg7DH0P",
43               "reference_id": "d75346a0-a747-4907-a506-639ea436f2b0"
44             }
45           ],
46           "employee": {
47             "first_name": "Jane",
48             "last_name": "Doe",
49             "positions": [
50               {
51                 "employment_type": "regular-full-time",
52                 "title": "Software Engineer"
53               }
54             ],
55             "status": "active",
56             "status_detail": "active",
57             "earnings": [
58               {
59                 "base": "35000.00",
60                 "bonus": "0.00",
61                 "commission": "100.25",
62                 "other": "0.00",
63                 "overtime": "200.00",
64                 "termination": false,
65                 "total": "35300.25",
66                 "year": "2020"
67               }
68             ],
69             "salary": {
70               "reduced_covid": "yes",
71               "hours_per_week": "40",
72               "months_per_year": "12"
73             },
74             "social_security_number": "***-**-0000"
75           },
76           "employer": {
77             "name": "name",
78             "government_ids": [
79               {
80                 "id": "123456789",
81                 "type": "us-fein"
82               }
83             ]
84           },
85           "id": "AAAAAAAADU8ACy03lGitY_ocCMCcgproUq8Gt4r37MM6GbyX2-DxWM3Y",
86           "verification_request": {
87             "created": "2021-12-20T18:50:20Z",
88             "id": "AAAAAAAAEboABwQhKv1_pWO7MWtZs28ksPTH0uSt6GffsoIJPj7e69P1",
89             "type": "employment-income"
90           },
91           "paystubs": [
92             {
93               "id": "AAAAAAAAAmEADp7bmZJNhm4Kr5FM_ty5A_JX-Rxh04GSIHwmIRyp6Xss",
94               "base": "7000.00",
95               "bonus": "1000.00",
96               "commission": "0.00",
97               "gross": "8000.00",
98               "net": "5500.00",
99               "other": "0.00",
100               "overtime": "0.00",
101               "pay_period_hours": "86.67",
102               "reference_id": "6894632654"
103             }
104           ]
105         }
106       ],
107       "request_parameters": {
108         "automated_underwriting_system_eligibility": "not-required",
109         "employer_filter": "target-employer",
110         "verification_methods": {
111           "credentials": {
112             "enabled": true
113           },
114           "instant": {
115             "enabled": true
116           },
117           "smart_outreach": {
118             "enabled": true
119           }
120         }
121       },
122       "reseller_originating_party": {
123         "originating_party": "originating_party",
124         "permissible_purpose": "child-support",
125         "use_case": "mortgage"
126       }
127     }
128   ],
129   "next": "https://api.truework.com/resource?limit=25&offset=50",
130   "previous": "https://api.truework.com/resource?limit=25"
131 }

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.

Query parameters

stateenumOptional

Filter returned verifications by state

associated_idstringOptional

Filter by associated ID

limitintegerOptionalDefaults to 25

Limit the number of results returned

offsetintegerOptionalDefaults to 0

Offset the results by page

Response

A list of Verifications was successfully retrieved.

countinteger

resultslist of objects

nextstring or null

previousstring or null

Get All Verifications

Headers

Query parameters

Response

Errors