CFWeb Status Request API

This is a polling method for the Merchant to call our system to get channel data. When a status is requested the data is sent back to the Merchant and not directed to a different URL. The difference between statusRequest and statusTransaction polling is that CFWeb will return the data to a specified URL when the transaction is complete.

The statusRequest is the original transaction session that provides the document validation. This session remains pending until all images have been processed. This is important to note because when an image is submitted it can have a different condition like Rescan. This causes statusRequest to remain pending.  The statusTransaction gives you the current status for the last set of images that have been submitted. This can be an iterative process when images require different conditions. This is why we strongly recommend PostbackURL as the preferred method for retrieving data from the system.

You can use the Status Request API as a method to retrieve data. The data is returned using one of the two postback mechanisms. We will call the Merchant, and the customer configures Postback. CFWeb will call this URL using the POST method. 

CFWeb server offers three methods to retrieve data from the system, listed in the table below.

API & Postback Type Method
api/status Response Returned GET Postback for request
/api/status/uid Response Returned GET Postback for transaction

Postback to url

(Provided by enterprise customer)

 Response Sent to Postback URL POST Postback for transaction and request
Note: You can search the information by using the UID that was passed in the Verify Request API.

Topics in this section: