Previous API versionsAPI version 2020-12-07

Reverify a Verification

Deprecated
Reverifies a Verification request, provided the request is already in a completed state and no more than 90 days have passed since completion of the verification

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

verification_request_idstringRequired
Verification ID

Headers

Accept"application/json"Required
Specify the content type and version that the API should use. It's recommended to include this to avoid breaking changes.
Request-Sync"async"Required

A header that defines if a request should be executed synchronously. Only Verifications that were initially executed synchronously may be reverified synchronously. sync can only return completed or canceled verification responses, not pending. async will return only pending.

Request

This endpoint expects an object.
report_idstringRequired>=1 character

Response

Reverification Request Created.
createddatetime
idstring>=1 character<=128 characters
permissible_purposeenum
A valid purpose is required for Truework to process the verification request. Throughout the API, this is signified by the `permissible_purpose` field. | VALUE | DESCRIPTION | | ---------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | | child-support | Determine child support payments (available to verifiers that represent a state or local child support enforcement agencies) | | credit-application | The target's application for credit | | employee-eligibility | Employee's eligibility for a benefit granted by a governmental agency required by law to consider the employee's financial responsibility or status | | employee-request | The target has issued the verifier written instruction to obtain this information | | employee-review-or-collection | Performing a review or collection of the target's account | | employment | Employment purposes where the target has given prior written consent | | insurance-underwriting-application | Underwriting insurance in response to the target's application | | legitimate-reason-initiated | Legitimate business need for the information in connection with a business transaction initiated by the target | | legitimate-reason-review | Legitimate business need to review the target's account to determine whether the employee continues to meet the terms of the account | | risk-assessment | To assess the credit or prepayment risks associated with an existing credit obligation of the target | | subpoena | For a court order or a federal grand jury subpoena
priceobject
Currently we only support USD as currency. Currency amounts are represented as strings with two decimal precision, e.g. "34.95".
stateenum
The state helps convey where the verification request is in the Truework process. It will be returned in the JSON objects returned from this endpoint. The initial state of all Schemas is pending-approval, and will switch to processing once Truework begins to process the request. However, it may 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. | VALUE | DESCRIPTION | | ---------------- | ------------------------------------------------------------------------------------------------------- | | pending-approval | The initial state after creation; the Truework team has not started working on this request yet | | action-required | A user action is required to continue processing this request; visit the dashboard for more information | | invalid | Contains invalid information that prevents the verification request from being processed by Truework | | processing | The Truework team is currently working on the verification request | | completed | The verification request has been completed and a report can be found from the reports endpoint | | canceled | Truework denied processing of the request or the verifier no longer wants the request to be processed |
targetobject
turnaround_timeobject

We use data from thousands of verification requests to estimate the duration between creation and completion of a request. For a provided company, upper_bound and lower_bound are the time estimates (in hours) that this particular request will take to be fully processed by Truework. May be an empty if an estimate does not exist for the verification request.

typeenum
Allowed values:
use_caseenum
The verification request use case describes the type of product the verification request is originating from. If omitted, the verifier type in account settings will be used as a default | VALUE | DESCRIPTION | | ------------------ | ------------------------------------------------------------------------------------------------------------------------------ | | mortgage | Verification for a mortgage | | home-equity | Verification for home equity | background | Verification for a background check | | tenant | Verification for a rental property | | government | Verification for government/social services | | auto | Verification for auto lending | | lending | Verification for personal loans or consumer lending | | credit | Verification for credit cards | | identity | Verification for identity or fraud | | insurance | Verification for insurance | | health | Verification for health services | | offers | Verification for offers | | account-management | Verification for account management | | preapproval | Verification for preapprovals | | other | Verification for other products. This exists for historical compatibility, no new Schemas can be created with this value |
additional_informationstring or null
Any additional information about the target that can help expedite the completion of the verification request
cancellation_detailsstring or null

The details for the cancellation; only present when state is canceled

cancellation_reasonenum or null
| VALUE | DESCRIPTION | | -------------------- | ---------------------------------------------------------------------------------------------------- | | immediate | Can be used to cancel a request directly after submitting, before Truework has started processing it | | high-turnaround-time | The request is taking longer than expected | | competitor | You preferred a competitor for this request | | wrong-info | The request that is submitted contains information that is wrong | | other | No other reason in the list fits the cancellation reason |
Allowed values:
date_of_completiondatetime or null
The date when this verification was completed in ISO 8601 format
documentslist of objects or null
Supporting documentation files provided by the verifier for the verification
loan_idstring or null
The loan id associated with the verification request
metadatamap from strings to optional strings or null

A single level key-value JSON object that can be used to store custom data on the verification request; keys and values must be strings

reportslist of objects or null
Applicable reports belonging to this request, if the request has been completed
request_parametersobject or null
reseller_originating_partyobject or null
The originating party that requested the verification via a reseller.

Errors