Cancel an order

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

Path parameters

order_idstringRequired
Order ID

Headers

AuthorizationstringRequired

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

Accept"application/json"RequiredDefaults to application/json
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
idstring>=1 character<=128 characters
loan_idstring or null
The loan id associated with the verification request
verification_requestslist of objects or null

Errors