End Point
PROD: https://websvcs.quikforms.com/rest/quikformxtract/v1000/documents/{{submitDocumentTransIdsubmitDocTransId}}/cancel
Description
FormXtract offers a 10-minute delay on every submitted form to allow for cancellations. This ensures customers have an opportunity to fix accidental submissions or mistakes before costs are incurred. Once processing begins the cost of the transaction will be incurred and the process cannot be stopped.
...
Parameter | Type | Required | Description |
|---|---|---|---|
AuthToken | String | Yes | OAuth token to authorize the API call |
SubmitDocumentTransID | Integer | Yes | Unique identifier for the submitted document |
Sample Request
URL: https://websvcs.quikforms.comPUT /rest/quikformxtract/v1000/documents/{{submitTransactionIdsubmitDocTransId}}/cancelMethod: PUT HTTP/1.1
Host: websvcs.quikforms.com
Authorization: Bearer {{token}}
Content-length: 0
Response
When a cancellation is submitted, the response will indicate if the cancel request was successful or not.
...
Success response:
| Code Block | ||
|---|---|---|
| ||
{
"ResultData": {
"SubmitDocumentTransId": 43,
"CancelResponse": true
},
"ErrorCode": 0,
"Message": "",
"Errors": null
} |
...