GetDocumentStatus Method

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.

To get the status of a submitted document, first get an AuthToken from the REST Authentication service and then provide the SubmitDocumentTransID (along with the AuthToken).

Request

Parameter	Type	Required	Description

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

GET /rest/quikformxtract/v1000/documents/{{submitDocTransId}}/status HTTP/1.1
Host: uatwebsvcs.quikforms.com
Authorization: Bearer {{token}}

Response

Parameter	Type	Description

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

Sample Response

{
    "ResultData": {
        "SubmitDocumentTransId": 41,
        "StatusId": 3,
        "Status": "Cancelled"
    },
    "ErrorCode": 0,
    "Message": "",
    "Errors": null
}

FormXtract API Guide