Cancel a Verification | Truework Docs

Cancels a Verification request, provided the request is not already in a terminal State.

Path parameters

verification_request_idstringRequired

Verification ID

Request

This endpoint expects an object.

cancellation_reasonenumRequired

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

| 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:

cancellation_detailsstringOptional

Free form text on the details; can be blank

Response

createddatetime

idstring>=1 character<=128 characters

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

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 |

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.

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

loan_idstring or null

The loan id associated with the verification request

Errors

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.

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

1	import requests
2
3	url = "https://api.truework-sandbox.com/verification-requests/AAAAAAAAQnIAAYd5YHFVOm8PNX2ecFbEjqV__upOKUE8YE_IK2GwSQTP/cancel"
4
5	payload = { "cancellation_reason": "immediate" }
6	headers = {
7	"Accept": "application/json",
8	"Authorization": "Bearer <token>",
9	"Content-Type": "application/json"
10	}
11
12	response = requests.put(url, json=payload, headers=headers)
13
14	print(response.json())

1	{
2	"created": "2021-12-20T18:50:20Z",
3	"id": "AAAAAAAAAosABwGqF1AUKAH0-puth1tCzLNar3Jyb4bx3wdVKU99XC26",
4	"price": {
5	"amount": "34.95",
6	"currency": "USD"
7	},
8	"state": "pending-approval",
9	"turnaround_time": {
10	"best_estimate": "48",
11	"lower_bound": "20",
12	"upper_bound": "128"
13	},
14	"cancellation_details": "cancellation_details",
15	"cancellation_reason": "immediate",
16	"date_of_completion": "2021-12-20T18:50:20Z",
17	"loan_id": "loan_id"
18	}

Path parameters

Headers

Request

Response

Errors