Skip to main content
POST
Private Company Overview

Authorizations

X-API-KEY
string
header
required

Body

application/json
identifier
Identifier · object
required

Object specifying which identifier you are using to request private company data. Supply one type and its corresponding value or a list of values (max 50).

Example:

Response

Successful Response

results
PublicPrivateCompanyOverview · object[]
required

One overview per requested ID, in request order. A company with no overview to serve carries only its rp_entity_id, which covers a company we cannot map, a mapped company with no record, and a lookup that failed.

metadata
Metadata · object
required
errors
ErrorDetail · object[] | null