API documentation
Company search API: GET /companies/search
GET /companies/search finds structured company profiles in every live country by name or by national identifier, one credit a call. A malformed identifier is a 400 with an X-Error-Code header, never a 200 with no rows.
Card required, nothing charged for 14 days. 500 credits over the trial.
A first search
curl "https://api.prometiam.com/functions/v1/risk-api/companies/search?name=inditex&country=ES&limit=1" \
-H "Authorization: Bearer rk_live_demo_publichn"It returns richer company metadata than the plain /search: legal form, region, activity code, registered capital, status and registry identifiers.
Main parameters
| Parameter | What it does |
|---|---|
name | Company name (normalised pattern match). |
company_number | Registry identifier, exact match, resolved per country (see the identifiers topic). |
vat | The VAT number as you write it, with or without its country prefix; each resolves to the same company as its identifier. |
status | The standard status every company object carries, the same list in every country. Outside ES it must be combined with name or company_number. |
founded_after / founded_before | YYYY-MM-DD bounds on the incorporation date. |
limit | Integer from 1 to 100, default 20; a value outside the range is a 400, never clamped. |
cursor / offset | Pagination. A name search issues o:<n>; pass it back unchanged. |
At least one of name, nif, siren, siret, company_number, vat, abn, business_number, lei, register_number, founded_after, cnae, has_risk_flag or objeto is required. The full table, with every country's identifier rules, is in the reference.
Paging a name search
A name search ranks a pool of up to about 700 candidates and pages through it. While has_more is true, pass next_cursor back unchanged as cursor. Every page costs 1 credit; a name that matches thousands of companies is best narrowed (more of the name, a status, a company number) instead of paged.
Limits
- For Finland, Sweden, Croatia, Belgium, Denmark, Estonia, Slovakia, Switzerland, Latvia, Cyprus, Romania, Lithuania, Canada, Australia, Japan, Israel, Brazil, Colombia, Singapore, Taiwan, the Czech Republic and Germany only some filters are supported (name, company_number, vat, founded_after, founded_before, status and local_status, plus a few country-specific ones); any other filter is refused with a 400 that lists what is supported.
- Each country's scope, register and credit are in the full reference and the country guides.
- The batch endpoints (
POST /companies/lookup,POST /sanctions/screen,POST /insolvency/check) count every item as one request; a batch that does not fit in your remaining quota is refused up front with 429batch_exceeds_quotaandmax_items_now.
This page is a short guide; the full reference has every parameter and response, and openapi.json is the machine-readable specification.