Sign up

API documentation

API quickstart: your first company call in five steps

Send your key as a bearer token and call GET /companies/search with a name and a country; the answer is JSON with the payload in data. The public demo key lets you try it without signing up, and a key of your own comes with the 14-day free trial.

Sign upFull reference

Card required, nothing charged for 14 days. 500 credits over the trial.

1. Get a key

To try the API without signing up, use the public demo key rk_live_demo_publichn: shared, 30 calls a minute and 1,000 a day; company search, records, VAT, LEI, insolvency and coverage only (sanctions screening, people and company events answer 403 upgrade_required). For a key of your own, start the free trial and create the key on your dashboard. Send it as a bearer token on every request.

Authorization: Bearer rk_live_demo_publichn

2. Make a call

Search a company by name. Every path is relative to the base URL and every response is JSON.

curl "https://api.prometiam.com/functions/v1/risk-api/companies/search?name=inditex&country=ES&limit=1" \
  -H "Authorization: Bearer rk_live_demo_publichn"

3. Read the response

The payload is in data (a list for searches, an object for one company); lists add pagination and meta. A company has the same keys in every country, null where the register publishes no value. Every response also carries X-Credits-Cost (what the call cost) and the X-RateLimit-* headers.

{
  "data": [
    {
      "country": "ES",
      "company_number": "A15075062",
      "company_name": "INDUSTRIA DE DISEÑO TEXTIL, S.A",
      "identifiers": [{ "type": "nif", "value": "A15075062" }, { "type": "vat", "value": "ESA15075062" }],
      "legal_form": "SA",
      "status": "active"
    }
  ],
  "pagination": { "count": 1, "has_more": true, "next_cursor": "o:1" },
  "meta": { "search_mode": "name", "country": "ES" }
}

4. Look up by identifier

Every country takes its own register number in company_number, written as the register prints it. With a VAT number or an LEI you need no country at all: GET /companies/by-identifier works out the country and answers like a company record (1 credit).

curl "https://api.prometiam.com/functions/v1/risk-api/companies/by-identifier?type=vat&value=ESA15075062" \
  -H "Authorization: Bearer rk_live_demo_publichn"

5. Costs and limits

A successful call costs credits and an error costs nothing. Credits are counted per account, every key included; the per-minute limit counts requests. GET /account shows the key's plan, limits and credits left, and costs nothing.

A successful callCredits
Account, coverage, managing monitored companies and the sanctions watchlist0
Company search, company record, batch lookup item, VAT check, LEI1
Corporate events, people and officers, director network, insolvency, procurement2
Sanctions screening, per name (beta)3
Financial statements of one company (Scale)25

Limits

  • The free trial lasts 14 days, needs a card, charges nothing during it and then becomes Starter at EUR 9.99 a month unless you cancel; it includes 500 credits in total plus 25-call allowances on sanctions screening, people search and company events.
  • 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 429 batch_exceeds_quota and max_items_now.
  • Sanctions screening is in beta. PEP data is in beta and covers Spain only.
  • Company financial statements (GET /companies/{id}/financials) need the Scale plan or above and cost 25 credits a call; Starter, Professional and trial keys get 10 such calls a month.

This page is a short guide; the full reference has every parameter and response, and openapi.json is the machine-readable specification.