/krs/companies

POST /api/krs/companies

Price: 20 credits

Get Polish company details by KRS registration number

How to use it

Get full registry details for a Polish company, association or foundation by its KRS number. Set register to S for associations and foundations, P for companies.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• krs string required — KRS registration number (examples: "0000028860", "28860")
• register string — Register section: P for companies, S for associations and foundations (default: "P"; one of: "P", "S")

Response

• @type string (default: "KrsCompany")
• id string required
• name string required
• register_type string nullable
• legal_form string nullable
• regon string nullable
• nip string nullable
• is_opp boolean nullable
• registered_at string nullable
• last_entry_at string nullable
• state_as_of string nullable
• registered_office_address object nullable
  • @type string (default: "KrsAddress")
  • country string nullable
  • voivodeship string nullable
  • county string nullable
  • commune string nullable
  • locality string nullable
  • street string nullable
  • building_number string nullable
  • apartment_number string nullable
  • postal_code string nullable
  • post_office string nullable
• email string nullable
• website string nullable
• share_capital object nullable
  • @type string (default: "KrsMoney")
  • value number nullable
  • currency string nullable
• paid_capital object nullable
  • @type string (default: "KrsMoney")
  • value number nullable
  • currency string nullable
• purpose string nullable
• activities array
  • @type string (default: "KrsActivity")
  • description string nullable
  • pkd_code string nullable
• representation object nullable
  • @type string (default: "KrsRepresentation")
  • organ_name string nullable
  • representation_method string nullable
  • members array
    • @type string (default: "KrsOfficer")
    • name string nullable
    • role string nullable
    • proxy_type string nullable
    • is_suspended boolean nullable
• supervisory_bodies array
  • @type string (default: "KrsSupervisoryBody")
  • name string nullable
  • members array
    • @type string (default: "KrsOfficer")
    • name string nullable
    • role string nullable
    • proxy_type string nullable
    • is_suspended boolean nullable
• proxies array
  • @type string (default: "KrsOfficer")
  • name string nullable
  • role string nullable
  • proxy_type string nullable
  • is_suspended boolean nullable

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — KRS number not found in the selected register Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.