Skip to main content

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
limitnumber25Limit the number of results returned
offsetnumber0Offset query by a number of results

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

Examples#

Request#

$ curl 'https://api.truework.com/verification-requests/?state=pending-approval&limit=10' \
-X GET \
-H 'Authorization: Bearer myTrueworkToken' \
-H 'Content-Type: application/json'

Response#

{
"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 8 results omitted in example
{
"id": "AAAAAAAAAKsAAYJIcQvm1nwU0xBbfC1Yh4qyqjvLhwt1B9gRmTCHCyW6",
"state": "pending-approval",
"created": "2008-09-15T15:53:00Z",
"type": "employment-income",
"permissible_purpose": "credit-application",
"target": {
"first_name": "Jane",
"last_name": "Brown",
"social_security_number": "***-**-1234",
"company": {
"name": "Bob's Widgets"
}
},
"price": {
"amount": "39.95",
"currency": "USD"
},
"turnaround_time": {},
"documents": []
}
],
"next": "https://api.truework.com/verification-requests/?state=pending-approval&offset=10&limit=10",
"count": 30
}