API documentation

Testing the API and the demo key

You can try the API without a key of your own: the public demo key works for company search, records, VAT, LEI, insolvency and coverage, and the MCP server and the web tools run the same calls. For your own tests, the 14-day free trial gives a real key with 500 credits.

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

The public demo key

rk_live_demo_publichn is shared: 30 calls a minute and 1,000 a day. It covers company search, records, VAT, LEI, insolvency and coverage only; sanctions screening, people and company events answer 403 upgrade_required.

curl "https://api.prometiam.com/functions/v1/risk-api/coverage" \
  -H "Authorization: Bearer rk_live_demo_publichn"

Other ways to try it with no card

  • The MCP server runs the same calls in an AI assistant without a key.
  • The web tools on the site call the API on the demo key.
  • The dashboard's sample console, for a signed-in account with no key yet: 10 lookups per account, counted in the browser, on the demo key's countries.

Testing with a key of your own

The free trial gives a real key: 14 days, 500 credits in total, 10 requests a minute, a card required and nothing charged during it. Errors cost nothing, so a test that fails on a bad parameter uses no credits. GET /account is free and shows the plan, limits and credits left; read X-Credits-Cost on each response to see what a call cost.

What to check before you go live

  • The error envelope and the 429 handling: wait the Retry-After seconds.
  • Pagination: pass next_cursor back unchanged until it is null.
  • For a batch, send an Idempotency-Key so a retry after a dropped connection is not counted twice.
  • For monitoring, verify the X-Prometiam-Signature of a webhook before you trust it.

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 demo key is shared and rate limited, and covers only the endpoints named above.
  • 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.

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