Look up up to 100 identifiers

fields=versions returns only the section versions, for daily change checks.

POST/v1/lookup:batch

Autorizácia

AuthorizationBearer token · headerpovinné

Telo požiadavky

povinnéapplication/json

fieldsstring

versions returns only each section's state and version

predvolené: "all"

Povolené hodnoty:allversions

idsstring[] | nullpovinné

min. počet položiek 1 · max. počet položiek 100

Odpovede

200

attributionstring[] | nullpovinné

itemsBatchItem[] | nullpovinné

Zobraziť vlastnosti

Pole typu BatchItem

codestring

idstringpovinné

resultLookupBody

Zobraziť vlastnosti

attributionstring[] | nullpovinné

subjectsSubject[] | nullpovinné

One subject; several for a VAT group (IČ DPH)

Zobraziť vlastnosti

Pole typu Subject

icostring

identityIdentitypovinné

Zobraziť vlastnosti

activeboolean

addressAddress

Zobraziť vlastnosti

buildingNumberstring

countrystring

municipalitystring

postalCodestring

streetstring

establishedOnstring

icoChecksumValidboolean

The IČO check digit; a warning only, real IČOs exist that fail it

kindstring

Povolené hodnoty:legal_personsole_traderpublic_bodyother

legalFormstring

legalFormCodestring

namestring

registrationsRegistration[] | null

Zobraziť vlastnosti

Pole typu Registration

activebooleanpovinné

namestring

The subject's name in this record

numberstring

Registration number (oddiel/vložka or trade licence number)

officestring

Registration court or office

registerstring

Source register, e.g. Obchodný register

registerCodestring

terminatedOnstring

validFromstring

sourceSourceRefpovinné

statestringpovinné

Povolené hodnoty:presentabsentunknown

terminatedOnstring

riskRiskpovinné

Zobraziť vlastnosti

entriesListEntry[] | null

ds_dphz (grounds to cancel VAT registration), ds_dphv (removed from that list), ds_dpho (special scheme)

Zobraziť vlastnosti

Pole typu ListEntry

attrsobject

datasetstringpovinné

reliabilityIndexstring

ds_iz_ran: vysoko spoľahlivý, spoľahlivý, menej spoľahlivý

sourceSourceRefpovinné

statestringpovinné

Povolené hodnoty:presentabsentunknown

taxTaxpovinné

Zobraziť vlastnosti

dicstring

sourceSourceRefpovinné

statestringpovinné

Povolené hodnoty:presentabsentunknown

vatVATpovinné

Zobraziť vlastnosti

icDphstring

namestring

Name as registered for VAT

paragraphstring

§7 and §7a are registered but are not VAT payers

Povolené hodnoty:§4§4b§5§7§7a

payerboolean | nullpovinné

true/false only from fresh data; null when unknown

payerFromstring

Always null for §7 and §7a

registeredOnstring

sourceSourceRefpovinné

statestringpovinné

Povolené hodnoty:presentabsentunknown

typeChangedOnstring

taxpayerTaxpayer

A natural person without an IČO, found by DIČ (authenticated callers only)

Zobraziť vlastnosti

dicstringpovinné

municipalitystring

namestring

sourceSourceRefpovinné

Zobraziť vlastnosti

asOfstring

As-of date of the dataset (the agency's date)

changedAtstring<date-time>

When the register last saw this content change

datasetstringpovinné

stalebooleanpovinné

versionstring

Content hash of the section; compare to detect changes

typestringpovinné

Povolené hodnoty:icodicic_dph

statusinteger<int64>povinné

HTTP status this id would get from /v1/lookup/{id}

versionsobject[] | null

Per subject: section → state and version

400

Bad Request

codestringpovinné

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

Zobraziť vlastnosti

Pole typu 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>povinné

HTTP status code

titlestringpovinné

Short summary of the problem type

typestring

A URI reference for the problem type

401

Unauthorized

codestringpovinné

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

Zobraziť vlastnosti

Pole typu 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>povinné

HTTP status code

titlestringpovinné

Short summary of the problem type

typestring

A URI reference for the problem type

422

Unprocessable Entity

codestringpovinné

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

Zobraziť vlastnosti

Pole typu 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>povinné

HTTP status code

titlestringpovinné

Short summary of the problem type

typestring

A URI reference for the problem type

429

Too Many Requests

codestringpovinné

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

Zobraziť vlastnosti

Pole typu 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>povinné

HTTP status code

titlestringpovinné

Short summary of the problem type

typestring

A URI reference for the problem type

500

Internal Server Error

codestringpovinné

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

Zobraziť vlastnosti

Pole typu 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>povinné

HTTP status code

titlestringpovinné

Short summary of the problem type

typestring

A URI reference for the problem type

503

Service Unavailable

codestringpovinné

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

Zobraziť vlastnosti

Pole typu 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>povinné

HTTP status code

titlestringpovinné

Short summary of the problem type

typestring

A URI reference for the problem type

Požiadavka

curl -X POST 'http://localhost:8080/v1/lookup:batch' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "fields": "all",
  "ids": [
    "string"
  ]
}'

const response = await fetch("http://localhost:8080/v1/lookup:batch", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Accept": "application/json",
    "Content-Type": "application/json"
  },
  body: "{\n  \"fields\": \"all\",\n  \"ids\": [\n    \"string\"\n  ]\n}"
});

import requests

response = requests.post(
    "http://localhost:8080/v1/lookup:batch",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Accept": "application/json",
        "Content-Type": "application/json"
    },
    data="{\n  \"fields\": \"all\",\n  \"ids\": [\n    \"string\"\n  ]\n}",
)

Odpoveď

{
  "attribution": [
    "string"
  ],
  "items": [
    {
      "code": "string",
      "id": "string",
      "result": {
        "attribution": [
          "string"
        ],
        "subjects": [
          {
            "ico": "string",
            "identity": {
              "active": true,
              "address": {
                "buildingNumber": "string",
                "country": "string",
                "municipality": "string",
                "postalCode": "string",
                "street": "string"
              },
              "establishedOn": "string",
              "icoChecksumValid": true,
              "kind": "legal_person",
              "legalForm": "string",
              "legalFormCode": "string",
              "name": "string",
              "registrations": [
                {
                  "active": true,
                  "name": "string",
                  "number": "string",
                  "office": "string",
                  "register": "string",
                  "registerCode": "string",
                  "terminatedOn": "string",
                  "validFrom": "string"
                }
              ],
              "source": {
                "asOf": "string",
                "changedAt": "2019-08-24T14:15:22Z",
                "dataset": "string",
                "stale": true,
                "version": "string"
              },
              "state": "present",
              "terminatedOn": "string"
            },
            "risk": {
              "entries": [
                {
                  "attrs": {
                    "property1": "string",
                    "property2": "string"
                  },
                  "dataset": "string"
                }
              ],
              "reliabilityIndex": "string",
              "source": {
                "asOf": "string",
                "changedAt": "2019-08-24T14:15:22Z",
                "dataset": "string",
                "stale": true,
                "version": "string"
              },
              "state": "present"
            },
            "tax": {
              "dic": "string",
              "source": {
                "asOf": "string",
                "changedAt": "2019-08-24T14:15:22Z",
                "dataset": "string",
                "stale": true,
                "version": "string"
              },
              "state": "present"
            },
            "vat": {
              "icDph": "string",
              "name": "string",
              "paragraph": "§4",
              "payer": true,
              "payerFrom": "string",
              "registeredOn": "string",
              "source": {
                "asOf": "string",
                "changedAt": "2019-08-24T14:15:22Z",
                "dataset": "string",
                "stale": true,
                "version": "string"
              },
              "state": "present",
              "typeChangedOn": "string"
            }
          }
        ],
        "taxpayer": {
          "dic": "string",
          "municipality": "string",
          "name": "string",
          "source": {
            "asOf": "string",
            "changedAt": "2019-08-24T14:15:22Z",
            "dataset": "string",
            "stale": true,
            "version": "string"
          }
        },
        "type": "ico"
      },
      "status": 0,
      "versions": [
        {
          "property1": {
            "state": "string",
            "version": "string"
          },
          "property2": {
            "state": "string",
            "version": "string"
          }
        }
      ]
    }
  ]
}

{
  "code": "string",
  "detail": "string",
  "errors": [
    {
      "location": "string",
      "message": "string",
      "value": null
    }
  ],
  "reason": "string",
  "status": 0,
  "title": "string",
  "type": "string"
}

{
  "code": "string",
  "detail": "string",
  "errors": [
    {
      "location": "string",
      "message": "string",
      "value": null
    }
  ],
  "reason": "string",
  "status": 0,
  "title": "string",
  "type": "string"
}

{
  "code": "string",
  "detail": "string",
  "errors": [
    {
      "location": "string",
      "message": "string",
      "value": null
    }
  ],
  "reason": "string",
  "status": 0,
  "title": "string",
  "type": "string"
}

{
  "code": "string",
  "detail": "string",
  "errors": [
    {
      "location": "string",
      "message": "string",
      "value": null
    }
  ],
  "reason": "string",
  "status": 0,
  "title": "string",
  "type": "string"
}

{
  "code": "string",
  "detail": "string",
  "errors": [
    {
      "location": "string",
      "message": "string",
      "value": null
    }
  ],
  "reason": "string",
  "status": 0,
  "title": "string",
  "type": "string"
}

{
  "code": "string",
  "detail": "string",
  "errors": [
    {
      "location": "string",
      "message": "string",
      "value": null
    }
  ],
  "reason": "string",
  "status": 0,
  "title": "string",
  "type": "string"
}