API documentation
API authentication: keys, scopes and plans
Every request carries an API key in the Authorization: Bearer header; keys start with rk_live_ and come from your dashboard. What a key may call depends on its plan: a call outside the plan answers 403 upgrade_required and names the plan that includes it.
Card required, nothing charged for 14 days. 500 credits over the trial.
Send the key
Authorization: Bearer rk_live_your_api_key_hereAPI keys start with rk_live_ and are provisioned from your dashboard or through the free-trial signup. The base URL is https://api.prometiam.com/functions/v1/risk-api/; responses are JSON and timestamps are ISO 8601 UTC.
Scopes by plan
Trial keys include the search, records and coverage scopes across all covered countries. Starter adds people, company_events and sanctions_watch (monitoring). Professional keys carry every scope including full sanctions screening, except financials (company financial statements), which Scale and above add.
When the key or the plan is not enough
| Status | Code | Meaning |
|---|---|---|
| 401 | unauthorized | The key is missing, invalid, expired or revoked. |
| 403 | forbidden | The key has no access to the requested country. |
| 403 | upgrade_required | The scope is not in your plan, or your free trial allowance for it is used up. The body names the plan that includes it (included_in), its price, upgrade_url and, when relevant, trial_allowance. |
Trial keys get 25 calls a month on each of sanctions screening, people search and company events; allowed calls carry meta.trial_allowance with used, limit and resets_on.
Keep the key safe
A key in browser code is visible to every visitor: call the API from your server. Usage and limits are counted per account, every key included.
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.
- 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. - 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.