API limits
The time, size and depth limits of the Kausate API, and what HTTP 429 and 503 responses ask you to do.
Request rate
Kausate sets no fixed request rate limit on your API key. Your orders are
queued fairly alongside other customers' orders. Mark bulk orders with
batch=true so that the orders a user is waiting for run first. See
Search.
Busy responses
| Response | Meaning | What to do |
|---|---|---|
HTTP 429, source.rate_limited | The register this request needs is temporarily refusing further requests. | Retry after the Retry-After interval, 60 seconds. |
| HTTP 503 from autocomplete | Autocomplete is briefly at capacity. | Retry after the Retry-After interval, 1 second. |
| HTTP 503 from other endpoints | The register is degraded or unreachable. | Retry after a longer backoff. |
A 429 concerns one register: orders for other jurisdictions are unaffected. See Errors for every code.
Time limits
| Call | Limit |
|---|---|
Any /sync endpoint | 300 seconds, then HTTP 408. Place the order asynchronously instead. |
| Prefill | 30 seconds, then HTTP 408. |
| An asynchronous order | No limit by default. Set globalTimeout in minutes, from 1 to 10,080 (7 days). |
| An asynchronous shareholder graph | 7 days by default. When globalTimeout ends, you receive the graph built so far. |
| Extending a shareholder graph | Up to about 30 days after the graph completed, then HTTP 410. |
Size and depth limits
| Input | Limit |
|---|---|
Autocomplete query | At least 2 characters. |
Autocomplete limit | 10 by default, at most 50. |
Shareholder graph maxDepth | 3 by default, at most 7. The synchronous endpoint accepts only 1. |
Shareholder graph additionalDepth | 1 by default, at most 7. |
customerId and customerReference | At most 150 characters: letters, digits, - and _. |
metadata | At most 4,096 bytes as JSON. |
| Webhook custom headers | At most 20, with names up to 256 and values up to 4,096 characters. |
| List monitors and monitor events | limit 100 by default, at most 500. Page with offset. |
A request over a size limit returns HTTP 422 with the field that failed, or
HTTP 400 for a header such as X-Customer-Id.
Monitors check a company at most once every 28 days by default. See Monitoring. PDF conversion of a download has its own limits, listed under Document downloads.
Download links
A document's downloadLink does not expire. Following it redirects to a
temporary address for the file that is valid for one hour, so follow the
downloadLink again for each download rather than storing the address it
redirects to.
Last updated on