Skip to main content
POST
companies.lei.search

Authorizations

Authorization
string
header
required

API key: sk_live_…. The approvals routes and GET /v1/members/me also take a member token: an OAuth access token an app gets when its member signs in to Pramaan and allows pramaan:approve (see the approvals guide).

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
companyName
string
required

Company name, or part of it, to search the legal entity register for.

Required string length: 1 - 256
country
string

Only entities whose legal address is in this country, two-letter code.

Pattern: ^[A-Z]{2}$
limit
number

How many matches to return, 1 to 50. Default 10.

Required range: x >= 1

Response

The result

results
object[]
required

Matching entities, best match first. An empty list means none matched.

totalMatches
number

How many entities matched in all, when known.