Cancel an order
Cancels all verification requests on an order, provided each request is not already in a terminal state.
Path parameters
order_id
Order ID
Headers
Authorization
Bearer authentication of the form Bearer <token>
, where token is your auth token.
Accept
Specify the content type and version that the API should use. It's recommended to include this to avoid breaking changes.
Request
This endpoint expects an object.
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_details
Free form text on the details; can be blank
Response
OK
id
loan_id
The loan id associated with the verification request
verification_requests