Skip to main content

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#

PARAMETERTYPEDESCRIPTION
idstringid of the verification request

Request Body#

PROPERTYTYPEREQUIREDDESCRIPTION
cancellation_reasonCancellationReasonReason for why this verification should be canceled
cancellation_detailsstringFree form text on the details, can be blank.

CancellationReason#

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
note

Cancellations are available after two days of its creation, with the exception of immediate.

Response#

No response body is returned. Instead, you should expect the following response codes:

CODEDESCRIPTION
200The verification request was successfully canceled.
403The verification request cannot be canceled.

Examples#

$ 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": "Here goes free form text", \
}'
{
"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": {},
}