Cancel an order

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

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

order_idstringRequired
Order ID

Headers

Accept"application/json"Required
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_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_detailsstringOptional

Free form text on the details; can be blank

Response

OK
idstring1-128 characters
loan_idstring
The loan id associated with the verification request
verification_requestslist of objects

Errors

400
Cancel an Order Request Bad Request Error
401
Cancel an Order Request Unauthorized Error
403
Cancel an Order Request Forbidden Error
404
Cancel an Order Request Not Found Error
406
Cancel an Order Request Not Acceptable Error
429
Cancel an Order Request Too Many Requests Error
451
Cancel an Order Request Unavailable for Legal Reasons Error
500
Cancel an Order Request Internal Server Error
501
Cancel an Order Request Not Implemented Error