Knowledge Base

Asynchronous calls allow an API request to be sent without waiting for an immediate response. The system continues processing other tasks while the request is handled in the background.

When using one of the asynchronous call methods you have three options for getting the data:

(a) provide an endpoint and ask for the data to be sent to it
(b) provide an endpoint and receive a notification – then run the original query to get the data
(c) keep polling the endpoint to get the data

A 202 Accepted response indicates that the server has received and accepted your request for processing but the action has not yet been completed, allowing for asynchronous handling of the operation.

Once received you can monitor progress by polling the status endpoint or listening for a callback (such as a webhook) until the request is completed and a non 202 response is returned, at which point the endpoint should be called again to obtain the 200 response.

Example 202 response without providing a callBackUrl:
Status: 202 Accepted or 202 In Progress

Example 202 response when providing a callBackUrl:
Status: 202 Accepted or 202 In Progress