Cancel a Verification

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

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

Request

URL Parameters

PARAMETER	TYPE	DESCRIPTION
id	string	id of the verification request

Request Body

PROPERTY	TYPE	REQUIRED	DESCRIPTION
cancellation_reason	CancellationReason		Reason for why this verification should be canceled
cancellation_details	string		Free form text on the details; can be blank

CancellationReason

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

Response

Status Codes

CODE	DESCRIPTION
200	The verification request was successfully canceled
403	The verification request cannot be canceled

Response Body

Upon successful cancellation, a subset of the canceled Verification is returned.

PROPERTY	TYPE	NULLABLE	DESCRIPTION
id	string		The id of the verification request
created	string		Creation date of verification request in ISO 8601 format
state	State		State of the verification request; always canceled
price	Price		Billing information about how much the verification request will cost once completed
turnaround_time	TurnaroundTime		Expected turnaround time in hours for the verification request; will be an empty if an estimate does not exist for the verification request
cancellation_reason	string		The reason for the cancellation of the request
cancellation_details	string		The details for the cancellation
loan_id	string		The loan_id associated with the verification request
date_of_completion	string		The date when this verification was completed in ISO 8601 format; always null

Examples

Request

cURL

$ curl 'https://api.truework.com/verification-requests/AAAAAAAAQnIAAYd5YHFVOm8PNX2ecFbEjqV__upOKUE8YE_IK2GwSQTP/cancel/' \

-X PUT \

-H 'Authorization: Bearer myTrueworkToken' \

-H 'Content-Type: application/json' \

-d '{

"cancellation_reason": "other",

"cancellation_details": "Details about why this request was canceled."

}'

Python

>>> truework.verification_request.VerificationRequest.cancel("AAAAAAAAACgAAf_MuMskFEZSkk_6RIp4-IDzykUNkQspgvdfHNHod0YB")

Ruby

Truework::VerificationRequest.cancel('AAAAAAAAQnIAAYd5YHFVOm8PNX2ecFbEjqV__upOKUE8YE_IK2GwSQTP', 'other', 'Details about why this request was canceled.')

Node

await client.verifications.cancel({

id: "AAAAAAAAQnIAAYd5YHFVOm8PNX2ecFbEjqV__upOKUE8YE_IK2GwSQTP",

cancellation_reason: "other",

cancellation_details: "Details about why this request was canceled."

});

Response

{

"id": "AAAAAAAAQnIAAYd5YHFVOm8PNX2ecFbEjqV__upOKUE8YE_IK2GwSQTP",

"state": "canceled",

"cancellation_reason": "other",

"cancellation_details": "Details about why this request was canceled.",

"created": "2008-09-15T15:53:00Z",

"price": {

"amount": "0.00",

"currency": "USD"

},

"turnaround_time": {},

"loan_id": null,

"date_of_completion": null

}