Client integration documentation

Results polling

Accepted applications return a results_url that the client polls using the same authentication headers.

Use the returned results URL

When an initial submission is accepted, the response contains results_url. Store that value and GET it exactly as returned.

Polling behaviour

Each polling request returns the current result state. If lenders are still outstanding, wait briefly and poll the same results_url again.

Do not modify results_url

Use the exact URL returned by the application response on every poll.

Polling request

curl --request GET 'RESULTS_URL_RETURNED_BY_POST' \
  --header 'X-AC-Client-ID: YOUR_CLIENT_ID' \
  --header 'x-api-key: YOUR_API_KEY'

When to stop polling

Read the response rather than assuming a fixed number of requests. In particular, monitor offer_results/awaiting_response. A value of 0 indicates no lenders remain outstanding in that response. Terminal no-offer results such as 21 or 22 should also stop the polling flow.