Skip to main content

Get a Verification

GET https://api.truework.com/verification-requests/<id>/

Retrieves a Verification by id.

Request#

URL Parameters#

PARAMETERTYPEDESCRIPTION
idstringThe id of the desired Verification request.

Response#

Response Body#

Returns a Verification, the same object returned from create and get.

The initial State will be pending-approval, and will switch to processing once Truework begins to process the request. However, it can switch back to pending-approval if it is pending approval by the Target.

The states completed, canceled, invalid are all terminal states of a Verification. A Report is only available when it is in the completed state. A Verification will enter the state canceled when either Truework or an API user cancels the request. The invalid state indicates that there are issues with the data e.g. we could not locate the employee at a given employer, or could not find the employer itself.

Examples#

$ curl 'https://api.truework.com/verification-requests/AAAAAAAAQnIAAYd5YHFVOm8PNX2ecFbEjqV__upOKUE8YE_IK2GwSQTP' \
-X GET \
-H 'Authorization: Bearer myTrueworkToken' \
-H 'Content-Type: application/json'
{
"id": "AAAAAAAAQnIAAYd5YHFVOm8PNX2ecFbEjqV__upOKUE8YE_IK2GwSQTP",
"state": "completed",
"created": "2008-09-15T15:53:00Z",
"type": "employment-income",
"price": {
"amount": "39.95",
"currency": "USD"
},
"turnaround_time": {},
"permissible_purpose": "credit-application",
"target": {
"company": {
"name": "Future Widget LLC"
},
"first_name": "Joe",
"last_name": "Smith",
"contact_email": "joesmith@example.org"
},
"type": "employment",
"documents": [{
"filename": "employee_authorization.pdf"
}]
}