Skip to content
Accquix Register
Esc
↑↓navigate↵open⌘Jpreview

What this instance offers

GET/v1/capabilities
Authorization
AuthorizationBearer token · headerrequired
Responses
200

OK

anonymousbooleanrequired

Anonymous access is enabled

apiVersionstringrequired
demobooleanrequired

true on a demo database: every answer holds fictional subjects, not register data

fuzzyCapabilitiesBodyFuzzyStructrequired
Show properties
concurrencyPerInstanceinteger<int64>
enabledbooleanrequired
notestringrequired
perKeyEverystring
timeoutstring
maxInFlightinteger<int64>required

Data requests this instance runs at once; beyond that, after a short wait, 503 with reason overloaded

mcpCapabilitiesBodyMCPStructrequired

The read-only MCP adapter for AI agents

Show properties
enabledbooleanrequired
pathstring
rateCapabilitiesBodyRateStructrequired

Per caller, per instance

Show properties
burstinteger<int64>required
perSecondnumber<double>required
searchCapabilitiesBodySearchStructrequired
Show properties
limitMaxinteger<int64>required
modesstring[] | nullrequired
taxpayerLookupbooleanrequired

Lookup of natural persons without an IČO by DIČ

versionstringrequired
401

Unauthorized

codestringrequired

Stable error code: invalid_request, invalid_identifier, unauthorized, forbidden, not_found, rate_limited, fuzzy_disabled, unavailable, internal

detailstring

Explanation specific to this occurrence

errorsErrorDetail[] | null

Validation details

Show properties
Array of ErrorDetail
locationstring

Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'

messagestring

Error message text

valueany

The value at the given location

reasonstring

For unavailable: bootstrapping, setup, source_stale, timeout, database, overloaded

statusinteger<int64>required

HTTP status code

titlestringrequired

Short summary of the problem type

typestring

A URI reference for the problem type

500

Internal Server Error

codestringrequired

Stable error code: invalid_request, invalid_identifier, unauthorized, forbidden, not_found, rate_limited, fuzzy_disabled, unavailable, internal

detailstring

Explanation specific to this occurrence

errorsErrorDetail[] | null

Validation details

Show properties
Array of ErrorDetail
locationstring

Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'

messagestring

Error message text

valueany

The value at the given location

reasonstring

For unavailable: bootstrapping, setup, source_stale, timeout, database, overloaded

statusinteger<int64>required

HTTP status code

titlestringrequired

Short summary of the problem type

typestring

A URI reference for the problem type

Request
curl -X GET 'http://localhost:8080/v1/capabilities' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
Response
{
  "anonymous": true,
  "apiVersion": "string",
  "demo": true,
  "fuzzy": {
    "concurrencyPerInstance": 0,
    "enabled": true,
    "note": "string",
    "perKeyEvery": "string",
    "timeout": "string"
  },
  "maxInFlight": 0,
  "mcp": {
    "enabled": true,
    "path": "string"
  },
  "rate": {
    "burst": 0,
    "perSecond": 0.1
  },
  "search": {
    "limitMax": 0,
    "modes": [
      "string"
    ]
  },
  "taxpayerLookup": true,
  "version": "string"
}