Cancel an order

1 curl -X PUT https://api.truework-sandbox.com/orders/AAAAAAAAQnIAAYd5YHFVOm8PNX2ecFbEjqV__upOKUE8YE_IK2GwSQTP/cancel \ 2 -H "Accept: application/json" \ 3 -H "Authorization: Bearer <token>" \ 4 -H "Content-Type: application/json" \ 5 -d '{ 6 "cancellation_reason": "immediate" 7 }'

1 { 2 "id": "AAAAAAAAAosABwGqF1AUKAH0-puth1tCzLNar3Jyb4bx3wdVKU99XC26", 3 "loan_id": "loan_id", 4 "verification_requests": [ 5 { 6 "created": "2021-12-20T18:50:20Z", 7 "id": "AAAAAAAAAosABwGqF1AUKAH0-puth1tCzLNar3Jyb4bx3wdVKU99XC26", 8 "state": { 9 "canonical_value": "pending-approval", 10 "raw_value": "raw_value" 11 }, 12 "turnaround_time": { 13 "best_estimate": "48", 14 "lower_bound": "20", 15 "upper_bound": "128" 16 }, 17 "cancellation_details": "cancellation_details", 18 "cancellation_reason": { 19 "canonical_value": "immediate", 20 "raw_value": "raw_value" 21 }, 22 "date_of_completion": "2021-12-20T18:50:20Z", 23 "loan_id": "loan_id" 24 } 25 ] 26 }

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

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

| 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

idstring>=1 character<=128 characters

loan_idstring or null

The loan id associated with the verification request

verification_requestslist of objects or null

Authentication

Path parameters

Headers

Request

Response

Errors