Cancel an order | Truework Docs

Cancels all verification requests on an order, provided each request is not already in a terminal state.

Authentication

AuthorizationBearer

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 .

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

order_idstringRequired

Order ID

Request

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

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

idstring1-128 characters

loan_idstring or null

The loan id associated with the verification request

verification_requestslist of objects or null

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

$	curl -X PUT https://api.truework-sandbox.com/orders/order_id/cancel \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"cancellation_reason": "immediate"
>	}'

1	{
2	"id": "AAAAAAAAAosABwGqF1AUKAH0-puth1tCzLNar3Jyb4bx3wdVKU99XC26",
3	"loan_id": "LN1234567890",
4	"verification_requests": [
5	{
6	"cancellation_details": "Cancelled immediately upon user request before processing began.",
7	"cancellation_reason": {
8	"canonical_value": "immediate",
9	"raw_value": "Cancelled immediately by user"
10	},
11	"created": "2024-04-15T10:22:35.123456Z",
12	"date_of_completion": "2024-04-15T10:25:00.654321Z",
13	"id": "VR1234567890abcdef1234567890abcdef",
14	"loan_id": "LN1234567890",
15	"state": {
16	"canonical_value": "canceled",
17	"raw_value": "Canceled by user request"
18	},
19	"turnaround_time": {
20	"best_estimate": "0",
21	"lower_bound": "0",
22	"upper_bound": "0"
23	}
24	}
25	]
26	}