For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Truework.comAPI StatusGet your API key
HomeGuidesAPI referenceHelp
HomeGuidesAPI referenceHelp
    • Introduction
  • Using the API
    • Authentication
    • Versioning
    • Webhooks
    • Sandbox environment
    • Monitoring
    • Limits
  • Verification orders & reports
    • POSTCreate a target employer order
    • POSTCreate an employer search order
    • POSTCreate a Truework Direct order
    • GETGet one order
    • GETGet all orders
    • PUTCancel an order
    • GETGet one report
    • GETGet order events
    • POSTReverify a report
  • Public beta APIs
  • Previous API versions
    • API version 2022-08-01
    • API version 2020-12-07
      • POSTCreate a Credentials Session
      • POSTCreate a Verification
      • GETGet All Verifications
      • GETGet One Verification
      • PUTReverify a Verification
      • PUTCancel a Verification
      • GETGet One Report
    • API version 2019-10-15
LogoLogo
Truework.comAPI StatusGet your API key
Previous API versionsAPI version 2020-12-07

Cancel a Verification

Deprecated
PUT
/verification-requests/:verification_request_id/cancel
PUT
/verification-requests/:verification_request_id/cancel
$curl -X PUT https://api.truework-sandbox.com/verification-requests/verification_request_id/cancel \
>     -H "Authorization: Bearer <token>" \
>     -H "Content-Type: application/json" \
>     -d '{
>  "cancellation_reason": "immediate"
>}'
1{
2  "cancellation_details": "string",
3  "cancellation_reason": "immediate",
4  "created": "2021-12-20T18:50:20.291247Z",
5  "date_of_completion": "2021-12-20T18:50:20.291247Z",
6  "id": "AAAAAAAAAosABwGqF1AUKAH0-puth1tCzLNar3Jyb4bx3wdVKU99XC26",
7  "loan_id": "string",
8  "price": {
9    "amount": "34.95",
10    "currency": "USD"
11  },
12  "state": "pending-approval",
13  "turnaround_time": {
14    "best_estimate": "48",
15    "lower_bound": "20",
16    "upper_bound": "128"
17  }
18}
Cancels a Verification request, provided the request is not already in a terminal State.
Was this page helpful?
Previous

Get One Report

Next
Built with

Authentication

AuthorizationBearer
Bearer tokens conform to the [RFC6750](https://datatracker.ietf.org/doc/html/rfc6750#section-2.1) spec. Production API keys (secret keys) are prefixed with `tw_sk_` and sandbox keys are prefixed with `tw_sk_test_`. If your secret key is published, you should rotate your API keys. Truework.JS publishable keys are prefixed with `tw_pk_` and `tw_pk_test` respectively. **Examples** - For Authorization Headers: `Authorization: Bearer tw_sk_test_e508eb797edb95ade85284bcb54dd49ed45db1be` - For the "try it now" `token` field, input only the token itself, omitting `Bearer `.

Path parameters

verification_request_idstringRequired
Verification ID

Headers

AcceptenumOptionalDefaults to application/json
Specify the content type and version that the API should use. It's recommended to include this to avoid breaking changes.
Allowed values:

Request

cancellation_reasonenumRequired
VALUEDESCRIPTION
immediateCan be used to cancel a request directly after submitting, before Truework has started processing it
high-turnaround-timeThe request is taking longer than expected
competitorYou preferred a competitor for this request
wrong-infoThe request that is submitted contains information that is wrong
otherNo other reason in the list fits the cancellation reason
Allowed values:
cancellation_detailsstring or nullOptional

Free form text on the details; can be blank

Response headers

Datestring
For JSON requests, the date at which the request was signed
X-Truework-Signaturestring
For JSON requests, the signature of the request, see: https://www.truework.com/docs/verifications-signatures

Response

OK
cancellation_detailsstring or null

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

cancellation_reasonenum or null
VALUEDESCRIPTION
immediateCan be used to cancel a request directly after submitting, before Truework has started processing it
high-turnaround-timeThe request is taking longer than expected
competitorYou preferred a competitor for this request
wrong-infoThe request that is submitted contains information that is wrong
otherNo other reason in the list fits the cancellation reason
Allowed values:
createddatetime
date_of_completiondatetime or null
The date when this verification was completed in ISO 8601 format
idstring1-128 characters
loan_idstring or null
The loan id associated with the verification request
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.

VALUEDESCRIPTION
pending-approvalThe initial state after creation; the Truework team has not started working on this request yet
action-requiredA user action is required to continue processing this request; visit the dashboard for more information
invalidContains invalid information that prevents the verification request from being processed by Truework
processingThe Truework team is currently working on the verification request
completedThe verification request has been completed and a report can be found from the reports endpoint
canceledTruework denied processing of the request or the verifier no longer wants the request to be processed
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.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
406
Not Acceptable Error
429
Too Many Requests Error
451
Unavailable for Legal Reasons Error
500
Internal Server Error
501
Not Implemented Error

Bearer tokens conform to the RFC6750 spec.

Production API keys (secret keys) are prefixed with tw_sk_ and sandbox keys are prefixed with tw_sk_test_. If your secret key is published, you should rotate your API keys.

Truework.JS publishable keys are prefixed with tw_pk_ and tw_pk_test respectively.

Examples

  • For Authorization Headers: Authorization: Bearer tw_sk_test_e508eb797edb95ade85284bcb54dd49ed45db1be
  • For the “try it now” token field, input only the token itself, omitting Bearer .

For JSON requests, the signature of the request, see: https://www.truework.com/docs/verifications-signatures