Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

End Point

PROD: https://websvcs.quikforms.com/rest/quikformxtract/v1000/documents/{{submitDocTransId}}/status

Description

After submitting a document for processing, customers can check the status of the submit request to determine what stage of the process the submitted document is in.

...

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.com/GET /rest/quikformxtract/v1000/documents/{{submitDocTransId}}/status Method: GETHTTP/1.1
Host: uatwebsvcs.quikforms.com
Authorization: Bearer {{token}}

Response

Parameter

Type

Description

SubmitDocumentTransID

Integer

Unique identifier for the submitted document

StatusID

Integer

StatusID of the document:

1 = Not Processed
2 = Submitted for Process
3 = Cancelled
4 = Processed
5 = Rejected
6 = AI Cannot Process
7 = Exceeds Quantity
8 = Retry
9 = Failed Submit

Status

String

Status label of the document:

1 = Not Processed
2 = Submitted for Process
3 = Cancelled
4 = Processed
5 = Rejected
6 = AI Cannot Process
7 = Exceeds Quantity
8 = Retry
9 = Failed Submit

ErrorCode

String

Error code if the operation failed

ErrorMessage

String

Error message if the operation failed

...