Integrations

Prometiam in Postman

One request per endpoint, ready to run. Open the collection in Postman, or import the OpenAPI 3.0 file into Postman, Insomnia or any client that reads it.

Requests 37
OpenAPI 3.0

Run in Postman Download the collection Download OpenAPI 3.0

Set up

Open the collection in Postman with Run in Postman, or import the downloaded file.
Set the collection variable api_key to your key. The collection sends it as a Bearer token.
Send any request. The response header X-Credits-Cost shows what the call cost.

api_key = rk_live_your_key_here

No key yet? Use the public demo key from the docs for company search, with a shared limit of about 30 calls an hour.

OpenAPI 3.0

The specification lists every path, parameter and response. Generate a client in the language you use, or let a tool read it.

https://www.prometiam.com/openapi.json

Your first request in Postman

After you import the collection, open the Companies folder and the request Search companies. It is GET {{base_url}}/companies/search: the collection variable base_url already holds https://api.prometiam.com/functions/v1/risk-api. Fill the query parameters name and country, press Send, and the collection’s Bearer authentication adds your api_key. This is the same call as:

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

The answer is a JSON envelope with data, pagination and meta. This is a real response, trimmed: a company object also carries the activity, employees, website and registry details.

{
  "data": [
    {
      "id": 1741526,
      "match_score": 100,
      "country": "ES",
      "company_number": "A15075062",
      "company_name": "INDUSTRIA DE DISEÑO TEXTIL, S.A",
      "identifiers": [
        { "type": "nif", "value": "A15075062" },
        { "type": "vat", "value": "ESA15075062" }
      ],
      "vat_number_source": "rule",
      "legal_form": "SA",
      "status": "active",
      "founding_date": "1985-06-12",
      "city": "ARTEIXO",
      "capital_amount": 93499560,
      "capital_currency": "EUR"
    }
  ],
  "pagination": { "count": 1, "has_more": true, "next_cursor": "o:1" },
  "meta": { "query_ms": 116, "search_mode": "name", "country": "ES" }
}

Read the response headers as well: X-Credits-Cost states what the call cost (1 credit for a company search) and X-Request-Id identifies the call if you write to support. The allowance you have left is in meta.rate_limit.

Variables and authentication

base_url: the API address, https://api.prometiam.com/functions/v1/risk-api. Leave it as it is.
api_key: your key, which starts with rk_live_. The collection sends it as Authorization: Bearer <key> on every request, so no request needs its own authorization setting.
Put the key in the Current value of api_key, not the Initial value: the initial value travels with the collection when you share or sync it, the current value stays on your machine.

What the 37 requests cover

The collection follows the API: one folder per resource and one request for every endpoint.

Companies: search, get by ID, get by registry number, find by any identifier, batch lookup of up to 100 companies in one call, and a company’s annual financial statements.
People and director network: search people by name, get a person, and the director network graph. Officers are served for Spain, France, the United Kingdom, Norway and Poland only (Polish natural persons are masked by the register); every other country is company records only.
Corporate events: search events or read a country’s event feed, get one event, and a company’s timeline.
Insolvency: search notices, get a notice by ID, and check up to 100 counterparties in one call. Corporate insolvency only, in sixteen markets.
Sanctions (beta): screen one name, screen up to 50 names, entity details, your watchlist and the list change feed.
VAT and LEI: validate an EU VAT number through VIES, look up an LEI, its ownership relationships, and search the LEI register by name.
Monitoring: list, subscribe, read and stop monitoring a company.
Procurement (beta): buyer risk profiles for Spain and France, and procurement awards.
Coverage and account: dataset coverage and your plan, limits and usage. These cost no credits.

What a request costs

A request sent from Postman is a real API call and spends the same credits as one sent from code. A successful call costs credits; an error costs nothing.

1 credit: a company search or record, an item of a batch lookup, a VAT check, an LEI lookup.
2 credits: corporate events, people search, the director network, an insolvency search.
3 credits per name: a sanctions screen (beta).
25 credits: the financial statements of one company, on the Scale plan and above (Starter, Professional and free trial keys get 10 such calls a month).
0 credits: account, coverage and monitoring management.

Per-minute limits by plan: free trial 10 requests, Starter 60, Professional 120, Scale 300. Over the limit the API answers 429 with a Retry-After header. A batch request counts every item as one request; a batch that does not fit in your remaining credits is refused up front with 429 batch_exceeds_quota and max_items_now. Batch sanctions screening needs a paid plan: the free trial screens one name at a time.

Reading an error in Postman

Status	What it means and what to check
400	`validation_error`: a parameter is malformed, for example a company number that fails its check digit or a `limit` outside 1 to 100. The `X-Error-Code` header repeats it.
401	No key or a key the API does not know. Check that `api_key` is set and the request inherits the collection’s authorization.
403	The key’s plan or country does not include this call. `upgrade_required` names the plan that does.
404	No record for that ID or number.
429	Rate limit or `batch_exceeds_quota`. Wait for the seconds in `Retry-After`.

When to use the collection

To explore the API before you write code: change parameters, read real answers and copy the request into your language.
To reproduce a problem: send the exact request that failed in your application and compare the X-Request-Id and the body.
To show a colleague or a customer-success team what the API returns, without code.
Not for production traffic. In code use the SDKs, in a workflow the n8n node, from an AI assistant the MCP server. All of them call the same API with the same key and the same credits.
To generate a client in another language, import openapi.json into a generator instead.

Questions

Do I need an API key to use the collection?

Yes for most requests. The 14-day free trial gives a key (card required, nothing charged for 14 days, 500 credits in total). Without a key, the public demo key in the docs runs company search with a shared limit of about 30 calls an hour.

Does a request in Postman use credits?

Yes, the same as any other client: 1 credit for a company search or record, 2 for events, people, the director network and insolvency, 3 per name for a sanctions screen, 25 for a company’s financial statements. Errors are free, and the account and coverage requests cost nothing.

Can I use the OpenAPI file instead of the collection?

Yes. The file is OpenAPI 3.0 and imports into Postman, Insomnia or any client that reads it. The collection adds ready-made requests and the authentication wiring, and the file stays the reference for every path and parameter.

How do I get new requests when the API grows?

Open Run in Postman again, or download the collection file and import it. The OpenAPI file lists every path and parameter at any time.

Limits that apply everywhere

Sanctions screening is beta. PEP screening is beta and Spain only.
Insolvency notices are corporate only, in sixteen markets.
Monitoring covers every live country except France and Chile.
Officers are served for Spain, France, the United Kingdom, Norway and Poland (Polish natural persons are masked by the register). Every other country is company records only.

Contains CVR data (Erhvervsstyrelsen), CC BY 4.0.

Start your 14-day free trial →Card required. Nothing charged for 14 days.