Get Verifications

GET https://api.truework.com/verification-requests/

Returns an array of Verifications as a paginated response.

Request

Query Parameters

The following properties can be passed as query parameters:

PARAMETERTYPEREQUIREDDEFAULTDESCRIPTION
stateStateFilter results by state
limitnumber25Filter results by state
offsetnumber0Filter results by state

Response

Response Body

PROPERTYTYPENULLABLEDESCRIPTION
resultsVerification[]The list of verification requests filtered as requested.
countnumberTotal number of results
nextstringURL for next page of results
previousstringURL for previous page of results
note

The Verification is the same format as the response for creating new Verifications.

Examples

$ curl 'https://api.truework.com/verification-requests/?state=pending-approval' \
-X GET \
-H 'Authorization: Bearer myTrueworkToken' \
-H 'Content-Type: application/json'
{
"results": [
{
"id": "AAAAAAAAQnIAAYd5YHFVOm8PNX2ecFbEjqV__upOKUE8YE_IK2GwSQTP",
"created": "2020-01-02T01:46:37.839067Z",
"type": "employment",
"permissible_purpose": "risk-assessment",
"state": "pending-approval",
"target": {
"first_name": "Joe",
"last_name": "Smith",
"contact_email": "joesmith@example.org",
"social_security_number": "***-**-0001",
"company": {
"id": "1234",
"name": "Future Widget LLC"
}
},
"price": {
"amount": "34.95",
"currency":"USD"
},
"turnaround_time": {
"upper_bound": "42",
"best_estimate": "34",
"lower_bound": "23"
},
"documents": [
{
"filename": "signed_auth_form.pdf"
},
{
"filename": "verifier_notes.pdf"
}
]
}
// ... Further 24 results omitted in example
],
"next": "https://api.truework.com/verification-requests/?offset=25",
"count": 30
}