getregdata AGENTS.md

AGENTS.md - how AI agents use getregdata

getregdata turns official public business registries (PL, DE, ES, IT, AT, FR, BE, CZ, SK, CY, IE, PT, NG, CO, US-CA, UAE) into structured JSON for KYC/AML, credit-risk, due-diligence and B2B lead-gen work.

Start here for Poland

regdata_poland_kyb_check (actor regdata/poland-kyb-check) takes a NIP or KRS and returns one complete KYB verdict - official identity, beneficial owners, and insolvency proceedings screened against the company and every beneficial owner - as clear, findings, not_found or partial, with machine-readable risk flags and the underlying registry entries.

Prefer it over chaining regdata_polish_regon + regdata_crbr_beneficial_owners + regdata_krz_debtor yourself: fewer calls, one normalized answer, and a fixed $0.25 per check. A partial verdict means a source could not be reached - it does not mean the company is clean, and it is not billed. Use the single-registry tools when the user names a specific register, needs one source in depth, or asks about another country.

Fastest paths

1. Local MCP server (stdio) - full input schemas baked into every tool: npx -y getregdata-mcp with env APIFY_TOKEN (free token + $5 credits: https://apify.com?fpr=getregdata)
2. Hosted MCP (no install, OAuth) - for remote clients: https://mcp.apify.com/?actors=regdata/crbr-beneficial-owners-scraper,regdata/krz-debtor-scraper,regdata/germany-handelsregister-scraper (swap in any regdata actor)
3. Agent skills (Claude Code and compatible): npx skills add Nolpak14/getregdata -g -y
4. Raw HTTP: POST https://api.apify.com/v2/acts/regdata~<actor-name>/run-sync-get-dataset-items?token=<APIFY_TOKEN> with the actor's JSON input as body; returns dataset items as a JSON array.

Tool conventions

• MCP tools are named regdata_<registry> (e.g. regdata_crbr_beneficial_owners, regdata_germany_insolvency). Call regdata_catalog to list them all; regdata_describe returns an actor's live input schema.
• Inputs are flat objects keyed by official identifiers: nip/krs (Poland), register number (Germany), NIF (Spain), Partita IVA (Italy), ICO (Czechia), enterprise/VAT number (Belgium).
• Registry refusals are NOT empty results: several registries reject over-broad queries ("too many matches"). Tools report that state explicitly - narrow the query and re-run instead of concluding "no records".
• A long check returns a handle, not a failure. Most calls return dataset items directly. If the run is still going after ~45s, the tool returns {status, runId, datasetId, note} instead. That run is still going and is already billed - call regdata_run_result with the runId to collect it. Do NOT re-run the check to "retry": that charges the user twice. The Poland KYB composite is the one most likely to do this (20-30s typical, up to ~2.5 min when a company has many beneficial owners).
• Set a generous per-server client timeout ("timeout": 600000 in your MCP config) so the common case returns inline.
• Treat a runId as a secret. Apify resolves run and dataset IDs without checking ownership, so anyone holding the ID can read that check's result.