Prometiam API documentation

REST API for official company data in Spain, France, the United Kingdom, Ireland, Poland and Norway. Base URL: https://api.prometiam.com/functions/v1/risk-api

Authentication

Every request needs a bearer API key: Authorization: Bearer rk_live_.... Keys are created at https://www.prometiam.com/signup (free tier: 1,000 calls a month, no credit card). Most read endpoints accept ?country=ES|FR|GB|IE|PL|NO; the default is ES.

Endpoints

Errors and limits

Errors return a JSON body of the shape {"error":{"code":"...","message":"...","status":N}}. 401 means a missing, malformed or revoked key; 403 means the key lacks the scope for that endpoint; 429 means a rate or quota limit was hit. Rate limits by plan are 10, 60, 300 and 600 requests per minute. Monthly quotas count successful requests only.

Machine-readable specification: https://www.prometiam.com/openapi.json — Postman collection: https://www.prometiam.com/prometiam.postman_collection.json

Query Parameters

Parameter Type Required Description
namestringone of sixCompany name — normalised pattern match (accent-insensitive, legal suffix stripped)
vatstringone of sixSpanish NIF/CIF (exact match, e.g. A28015865)
sirenstringone of sixFrench SIREN (9 digits, e.g. 552032534) — use with country=FR
siretstringone of sixFrench SIRET (14 digits). The first 9 digits are treated as SIREN.
company_numberstringone of sixRegistry registration number (exact match, e.g. M-15812)
event_typestringnoinsolvency, dissolution, liquidation, restructuring, status_change
date_fromstringnoFiling date range start (YYYY-MM-DD)
date_tostringnoFiling date range end (YYYY-MM-DD)
limitintegerno1–100, default 20
cursorstringnoPagination cursor (numeric ID) from previous response

Query Parameters

Parameter Type Required Description
countrystringyesOne of FR, DE, GB, AT, CH, NO, FI, US
namestringnoCompany name (fuzzy match)
limitintegerno1–100, default 20
cursorstringnoPagination cursor from the previous response

Query Parameters

Parameter Type Required Description
namestringone of sixCompany name (normalised pattern match)
nifstringone of sixSpanish NIF/CIF (exact match)
sirenstringone of sixFrench SIREN (9 digits) — pair with country=FR
siretstringone of sixFrench SIRET (14 digits)
founded_afterdateone of sevenYYYY-MM-DD — companies incorporated on/after this date. Works alone (no name needed): the newly-incorporated-companies feed
founded_beforedatenoYYYY-MM-DD — upper bound on incorporation date
cnaestringone of sevenCNAE-2009 activity code or prefix (e.g. 62 = all of programming/IT, 6201 = computer programming). Combine with founded_after for an activity-scoped new-company feed
has_risk_flagbooleanone of sevenSet to true to return only companies carrying a risk flag (currently Spanish AEAT large tax-debtor entries). Works alone — no name needed
risk_flag_typestringnoNarrow the flag filter to a single type, e.g. tax_debt
objetostringone of sevenKeyword in the company's objeto social (statutory business purpose), e.g. software, biotech. Min 3 chars. Best signal for startup/sector scouting
sort / orderstringnosort=founding_date with order=asc|desc (default desc) — applies in feed mode
limitintegerno1–100, default 20
cursorstringnoPagination cursor from previous response

Optional sections — ?include=

Value Adds
risk_flagsRisk flags on the company — currently Spanish AEAT large tax-debtor entries, with amount_eur, severity, reference_date, published_date and a link to the official source
insolvencyInsolvency proceedings linked to the company
procurementTop public-procurement awards
leiMatching GLEIF LEI record
prospectFirmographics and role-mapped appointments
allEvery optional block above

Query Parameters

Parameter Type Required Description
namestringyesPerson name (normalised pattern match). Minimum 2 characters
countrystringnoES (default), FR, GB, or NO. IE/PL are company-level and return no people
limitintegerno1–100, default 20
cursorstringnoPagination cursor from previous response

Query Parameters

Parameter Type Required Description
company_namestringone of twoCompany name (normalised pattern match)
company_numberstringone of twoRegistry registration number (exact match)
event_typestringnodissolution, director_change, capital_change, new_incorporation, name_change, address_change, liquidation, merger, demerger, status_change, insolvency
date_fromstringnoEvent date range start (YYYY-MM-DD)
date_tostringnoEvent date range end (YYYY-MM-DD)
limitintegerno1–100, default 20
cursorstringnoPagination cursor from previous response

Query Parameters

Parameter Type Required Description
company_numberstringone of twoRegistry registration number (exact match, recommended)
company_namestringone of twoCompany name (normalised pattern match)
limitintegerno1–200, default 50

Query Parameters

Parameter Type Required Description
namestringyesName to screen (person, company, or vessel)
thresholdintegernoMinimum match score 30–100, default 80. Lower it (50–60) to catch typos and spelling variants
liststringnoComma-separated list filter: EU, OFAC, UN, OFSI, FR_GELS
entity_typestringnoperson, company, or vessel
dobdatenoDisambiguator (YYYY-MM-DD). Excludes entities with a different known date of birth; entities with unknown DOB are never excluded
countrystringnoDisambiguator. Matches against listed country/nationality; entities with unknown country are never excluded
active_onlybooleannoDefault true. Set false to include delisted entities
include_pepbooleannoSet true to also screen against politically exposed persons. Results come back in a separate pep block so they never mix with sanctions hits — see the note below
pep_min_tierstringnonational, regional or local — only return PEP hits at or above that tier. Omit it and you get every hit, including people with no recorded office
limitintegerno1–100, default 20

Query Parameters

Parameter Type Required Description
sincedatenoYYYY-MM-DD or ISO timestamp, default 30 days ago
liststringnoComma-separated list filter
change_typestringnolisted, delisted, relisted, or renamed
limitintegerno1–500, default 100

Path Parameter

Parameter Type Required Description
vatNumberstringyesFull VAT number including the 2-letter country prefix, e.g. IE6388047V or DE811569869. Spaces and punctuation are ignored.

Error Handling

Status Code Description
400validation_errorMissing or invalid parameters (e.g. no search term, invalid country)
401unauthorizedMissing, invalid, or expired API key
403forbiddenKey lacks required scope or country access
404not_foundRecord or endpoint not found
429rate_limit_exceededPer-minute or daily limit exceeded — check Retry-After header (seconds)
429quota_exceededMonthly quota exhausted (incl. 10% paid-tier grace) — resets at month start; upgrade or contact support
500internal_errorServer error — safe to retry with exponential backoff

Rate Limits & Quotas

Tier Requests/month Requests/min Requests/day (fair use) Watchlists Price
Free1,00010200EUR 0/mo
Starter10,000602,00010EUR 9.99/mo
Professional100,00030020,000100EUR 29.99/mo
Scale1,000,000600200,0001,000EUR 99/mo
EnterpriseCustomCustomCustomCustomContact sales

Frequently asked questions

What is the Prometiam Risk Intelligence API?
A commercial REST API that unifies EU + UK company registry data — Spain (BORME), France (BODACC), the United Kingdom (Companies House), Ireland (CRO), Poland (KRS), and Norway (Enhetsregisteret) — under one schema, with daily updates, sanctions and US export-control screening (EU, UN, OFAC, UK OFSI, French Registre des gels, plus the US Consolidated Screening List), and corporate-event monitoring. Authentication is a Bearer rk_live_ API key.
Is there a free tier for the Prometiam Risk API?
Yes. The Free tier provides 1,000 calls per month and includes the search, records, and coverage scopes across all six live countries. No credit card required to receive an rk_live_ API key.
How much does the Prometiam Risk API cost?
Public tiers: Free (€0, 1,000 calls/month), Starter (€9.99/mo, 10,000 calls/month with people, company events, and sanctions monitoring), Professional (€29.99/mo, 100,000 calls/month with full scopes including sanctions screening and 100 watchlists), Scale (€99.99/mo, 1,000,000 calls/month), and Enterprise (custom). Monthly quotas count successful requests only; paid plans include a 10% overage buffer.
Which countries does the API cover?
Six countries are live. Spain (BORME) is fully live with daily updates. France (BODACC), the United Kingdom (Companies House), Ireland (CRO), Poland (KRS), and Norway (Enhetsregisteret, from Brønnøysundregistrene) are also covered via the same endpoints. The country parameter is ?country=ES, ?country=FR, ?country=GB, ?country=IE, ?country=PL, or ?country=NO. Spain, France, the UK, and Norway include officers and directors; Ireland and Poland are company-level (Poland adds NIP, REGON, PKD code, and capital), and directors and UBO are not yet included for IE/PL. Norway has no corporate-event gazette, so the company-event endpoints return nothing for NO.
Which company identifiers does the API accept?
Spain: ?vat= (NIF, 9 chars starting with a letter, e.g. A28015865). France: ?siren= (9 digits) or ?siret= (14 digits). United Kingdom: ?company_number= (8 chars; numeric for England & Wales/Scotland; alphabetic prefixes such as SC, NI, OC, LP, FC, OE for special types).
How fresh is the data?
Spanish (BORME) and French (BODACC) data is ingested daily from the official national gazettes. UK Companies House is monthly bulk plus daily delta from the official Companies House feed. Irish (CRO) company data is refreshed from the CRO Open Data release. Norwegian data is refreshed daily from Brønnøysundregistrene (Enhetsregisteret, open data under the NLOD licence). The /coverage endpoint returns the latest_filing date per country.
How does authentication work?
Every request requires a Bearer token via the Authorization header: Authorization: Bearer rk_live_your_api_key. Keys are provisioned via the free signup and tied to a tier (rate limits), a list of scopes, and a list of allowed countries.
Where is the data hosted?
In the European Union (AWS eu-central-1, Frankfurt). No data leaves the EU. Aligned with GDPR and ISO 27001; SOC 2 Type II is in progress.
How does Prometiam compare to Creditsafe, Iberinform, Pappers, and OpenCorporates?
Prometiam ships a single REST endpoint covering Spain (BORME), France (BODACC), the UK (Companies House), Ireland (CRO), Poland (KRS), and Norway (Enhetsregisteret) with daily updates, transparent public pricing from €9.99/month, sanctions and US export-control screening across six sources (EU, OFAC, UN, UK OFSI, French gels, plus the US Consolidated Screening List) with daily refresh and scored fuzzy matching, and explainable risk fields. Most competitors fragment by country, hide pricing, or charge much more for comparable coverage.