Skip to main content
POST
Get Onboarding Data (Deprecated)

Authorizations

x-api-key
string
header
required

Query Parameters

transliterate
boolean

If true, transliterates non-Latin strings in the response to Latin script.

Body

application/json
id
string
required

The company id. In some countries, this might be a concatenation of the registry and city (e.g., in Germany: "Augsburg HRB 34617"). The search function will always return a usable company number. Check the documentation to see which number format is used for each country.

Example:

"932884117"

countryCode
enum<string>
required

The country code in ISO 3166-1 alpha-2 format (e.g., "FR" for France, "DE" for Germany).

Available options:
AT,
BE,
BG,
CH,
CN,
CZ,
CY,
DE,
DK,
EE,
ES,
FI,
FR,
GB,
GG,
GR,
HK,
HR,
HU,
IE,
IS,
IT,
JE,
LI,
LU,
LV,
MC,
MT,
MU,
NL,
NO,
PL,
PT,
RO,
RU,
SE,
SG,
SI,
SK,
VG
Example:

"FR"

dataPoints
enum<string>[]

The data points to retrieve. Only companyProfile is supported for onboarding.

Available options:
companyProfile
metadata
object

Arbitrary key-value string pairs to associate with the request. Limits: max 50 keys, keys up to 40 chars (longer keys are skipped), values up to 500 chars (longer values are truncated).

Response

200 - application/json

Company onboarding information

request
object
required

The request

company
object

The main profile information of the company, including, if available, details such as name, registration number, address, and other core data.

ultimateBeneficialOwners
object[]

The persons of significant control of the company, including, if available, their name, nationality, and other relevant details.

The legal representatives of the company, which can be either individuals or companies.

shareholders
object[]

The shareholders of the company, which can be either individuals or companies.

subsidiaries
object[]

Companies in which the queried company holds equity (downstream participations). Includes any equity stake regardless of size — the relationship classification (controlled, associated, minority investment) is derived from sharePercentage by the consumer.

establishments
object[]

The establishments of the company, including physical locations where business activities are conducted.

otherKeyPersons
object[]

Other key persons associated with the company who do not have legal signing authority, such as board members, auditors, and compliance officers.

graph
object

Ownership graph: the entities (nodes) and ownership relationships (edges) discovered while traversing the company structure, plus a human-readable description, a mermaidDiagram rendering, and traversal metadata. Individual nodes carry UBO flags (flags.isUbo, flags.uboCalculationMethod) and totalOwnershipPercentage.

documents
object
companyRelationships
object[]
dataSources
object

Per-field data source provenance for each entity. Keys are field names, values describe the origin of the data.

enrichmentReport
string

Human-readable summary of enrichment results when agenticEnrichment was requested.