Get Onboarding Data

Authorizations

x-api-key

string

header

required

Headers

x-topograph-no-cache

string

required

Body

application/json

Option 1
Option 2

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,

CH,

CN,

CZ,

CY,

DE,

DK,

EE,

ES,

FI,

FR,

GB,

HU,

IE,

IT,

LU,

MT,

NL,

NO,

PL,

PT,

RO,

SE

Example:

"FR"

dataPoints

enum<string>[]

The data points to retrieve. Available data points are companyProfile, ultimateBeneficialOwners, availableDocuments, or establishments.

Available options:

companyProfile,

ultimateBeneficialOwners,

availableDocuments

Example:

["companyProfile"]

documents

string[]

There are two ways to retrieve documents:

Two-step process:
- First, request the "availableDocuments" data point to get a list of all available documents with their IDs
- Then, use these specific document IDs in a second request
Direct access using smart IDs:
- Use predefined smart IDs for quick access to common documents:
  - trade_register_extract: Latest trade register extract
  - certified_trade_register_extract: Latest certified trade register extract
    Refer to our country coverage documentation to check which smart IDs are available for each country.

Example:

["trade_register_extract"]

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).

Show child attributes

metadata.{key}

string

Maximum string length: 500

Response

200 - application/json

Company onboarding information

request

object

required

The request

Show child attributes

request.country

enum<string>

required

The requested country code.

Available options:

AT,

BE,

CH,

CN,

CZ,

CY,

DE,

DK,

EE,

ES,

FI,

FR,

GB,

HU,

IE,

IT,

LU,

MT,

NL,

NO,

PL,

PT,

RO,

SE

Example:

"FR"

request.dataPoints

string[]

required

request.documents

string[]

required

request.companyId

string

The requested company id.

Example:

"932884117"

request.requestId

string

The unique identifier for the request.

Example:

"request-12345"

request.dataStatus

object

Indicates the status of data points and documents associated with the company. It states if the data has been retrieved, if a job is in progress for asynchronous data, or if a job there was an error.

Show child attributes

request.dataStatus.dataPoints

object

required

Retrieval status of data points

Show child attributes

request.dataStatus.dataPoints.{key}

object

Option 1
Option 2
Option 3

Show child attributes

request.dataStatus.dataPoints.{key}.status

enum<string>

required

The data point completed successfully

Available options:

succeeded

Example:

"succeeded"

request.dataStatus.dataPoints.{key}.cost

number

The cost in credits for this data point or document

Example:

10

request.dataStatus.dataPoints.{key}.costMarkup

number

The percentage markup when final cost is not yet known

Example:

20

request.dataStatus.documents

object

required

Retrieval status of documents

Show child attributes

request.dataStatus.documents.{key}

object

Option 1
Option 2
Option 3

Show child attributes

request.dataStatus.documents.{key}.status

enum<string>

required

The data point completed successfully

Available options:

succeeded

Example:

"succeeded"

request.dataStatus.documents.{key}.cost

number

The cost in credits for this data point or document

Example:

10

request.dataStatus.documents.{key}.costMarkup

number

The percentage markup when final cost is not yet known

Example:

20

request.metadata

object

Arbitrary key-value string pairs provided at request creation time and echoed back in responses and webhooks.

Show child attributes

request.metadata.{key}

string

company

object

required

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

Show child attributes

company.id

string

required

The id of the company, see documentation.

Example:

"932884117"

company.countryCode

enum<string>

required

The ISO 3166-1 alpha-2 country code of the company registration country

Available options:

AF,

AX,

AL,

DZ,

AS,

AD,

AO,

AI,

AQ,

AG,

AR,

AM,

AW,

AU,

AT,

AZ,

BS,

BH,

BD,

BB,

BY,

BE,

BZ,

BJ,

BM,

BT,

BO,

BQ,

BA,

BW,

BV,

BR,

IO,

BN,

BG,

BF,

BI,

KH,

CM,

CA,

CV,

KY,

CF,

TD,

CL,

CN,

CX,

CC,

CO,

KM,

CG,

CD,

CK,

CR,

CI,

HR,

CU,

CW,

CY,

CZ,

DK,

DJ,

DM,

DO,

EC,

EG,

SV,

GQ,

ER,

EE,

ET,

FK,

FO,

FJ,

FI,

FR,

GF,

PF,

TF,

GA,

GM,

GE,

DE,

GH,

GI,

GR,

GL,

GD,

GP,

GU,

GT,

GG,

GN,

GW,

GY,

HT,

HM,

VA,

HN,

HK,

HU,

IS,

IN,

ID,

IR,

IQ,

IE,

IM,

IL,

IT,

JM,

JP,

JE,

JO,

KZ,

KE,

KI,

KR,

KP,

KW,

KG,

LA,

LV,

LB,

LS,

LR,

LY,

LI,

LT,

LU,

MO,

MK,

MG,

MW,

MY,

MV,

ML,

MT,

MH,

MQ,

MR,

MU,

YT,

MX,

FM,

MD,

MC,

MN,

ME,

MS,

MA,

MZ,

MM,

NA,

NR,

NP,

NL,

NC,

NZ,

NI,

NE,

NG,

NU,

NF,

MP,

NO,

OM,

PK,

PW,

PS,

PA,

PG,

PY,

PE,

PH,

PN,

PL,

PT,

PR,

QA,

RE,

RO,

RU,

RW,

BL,

SH,

KN,

LC,

MF,

PM,

VC,

WS,

SM,

ST,

SA,

SN,

RS,

SC,

SL,

SG,

SX,

SK,

SI,

SB,

SO,

ZA,

GS,

SS,

ES,

LK,

SD,

SR,

SJ,

SZ,

SE,

CH,

SY,

TW,

TJ,

TZ,

TH,

TL,

TG,

TK,

TO,

TT,

TN,

TR,

TM,

TC,

TV,

UG,

UA,

AE,

GB,

US,

UM,

UY,

UZ,

VU,

VE,

VN,

VG,

VI,

WF,

EH,

YE,

ZM,

ZW,

TEST

Example:

"FR"

company.identifiers

object

A dictionary of different identifiers for the company

Show child attributes

company.identifiers.{key}

string

Example:

{
  "SIREN": "932884117",
  "VAT": "FR42932884117"
}

company.legalName

string

The legal name of the company.

Example:

"Topograph"

company.legalNameInEnglish

string

The English translation or romanization of the legal name, commonly used for international business. Particularly relevant for companies registered with non-Latin alphabet names (e.g., Chinese, Japanese, Korean, etc.).

Example:

"Test Display Hong Kong Trading Limited"

company.commercialNames

string[]

An array of commercial names or trading names used by the company.

Example:

["Topograph", "TopographHQ"]

company.legacyLegalNames

string[]

An array of legacy legal names used by the company.

Example:

["Semaphore", "SemaphoreHQ"]

company.legacyCommercialNames

string[]

An array of legacy commercial names used by the company.

Example:

["Semaphore", "SemaphoreHQ"]

company.status

object

The status of the company, including local status and whether it is active.

Show child attributes

company.status.localName

string

required

The local status of the company in the local language

Example:

"active"

company.status.active

boolean

Indicates if the company is active.

Example:

true

company.status.statusDetailsBeta

object

Detailed status information including closure reasons and dates

Show child attributes

company.status.statusDetailsBeta.status

enum<string>

required

The standardized status of the company

Available options:

ACTIVE,

UNDER_INSOLVENCY_PROCEEDING,

CLOSED,

UNKNOWN

Example:

"ACTIVE"

company.status.statusDetailsBeta.closureReason

enum<string>

The reason for company closure, if applicable

Available options:

BANKRUPTCY,

LIQUIDATION,

MERGER,

ACQUISITION,

VOLUNTARY_DISSOLUTION,

ADMINISTRATIVE_DISSOLUTION,

COURT_ORDER,

OTHER,

UNKNOWN

Example:

"BANKRUPTCY"

company.status.statusDetailsBeta.closureDate

string

The date when the company was closed, if applicable

Example:

"2024-01-15"

company.status.statusDetailsBeta.insolvencyStartDate

string

The date when insolvency proceedings started, if applicable

Example:

"2023-12-01"

company.status.statusDetailsBeta.additionalInfo

string

Additional information about the status

Example:

"Company entered voluntary liquidation due to retirement of owner"

company.registrationDate

string

The registration date of the company with the trade register or other authorities.

Example:

"2024-04-22"

company.incorporationDate

string

The incorporation date when the company was legally incorporated or founded. This may differ from the registration date, as companies are often incorporated before being registered with trade authorities.

Example:

"2024-04-15"

company.legalForm

object

The legal form of the company, including local and standard forms.

Show child attributes

company.legalForm.localName

string

The local legal form of the company, in the local language

Example:

"EURL, entreprise unipersonnelle à responsabilité limitée"

company.legalForm.englishTranslation

string

The English translation of the local legal form.

Example:

"Single Member Limited Liability Company"

company.legalForm.semaphoreStandard

enum<string>

deprecated

The standardized legal form of the company.

Available options:

Sole Proprietorship,

Partnership,

Limited Liability Company,

Corporation,

Nonprofit Organization,

Cooperative,

Government-Owned Entity,

Branch or Representative Office,

Trust,

Other

Example:

"Limited Liability Company"

company.legalForm.standardized

enum<string>

The standardized legal form of the company.

Available options:

Sole Proprietorship,

Partnership,

Limited Liability Company,

Corporation,

Nonprofit Organization,

Cooperative,

Government-Owned Entity,

Branch or Representative Office,

Trust,

Other

Example:

"Limited Liability Company"

company.legalForm.iso20275Code

string

The ISO 20275 Entity Legal Form code for the company.

Example:

"F8DD"

company.capital

object

The share capital of the company.

Show child attributes

company.capital.amount

number

required

The numeric amount of money.

Example:

1000

company.capital.currency

string

required

The ISO 4217 currency code (e.g., EUR, USD).

Example:

"EUR"

company.capital.formatted

string

required

Formatted string representation of the monetary amount in the local format

Example:

"1000.00 €"

company.activities

object

A dictionary of activity classifications

Show child attributes

company.activities.{key}

object[]

Show child attributes

company.activities.{key}.code

string

required

The activity code

Example:

"62.01"

company.activities.{key}.description

string

required

The description of the activity

Example:

"Computer programming activities"

company.activities.{key}.isAIInferred

boolean

required

Indicates whether the activity code comes from an official source or has been inferred by AI

Example:

true

Example:

{
  "NACE": [
    {
      "code": "62.01",
      "description": "Computer programming activities"
    }
  ],
  "ISIC": [
    {
      "code": "J620",
      "description": "Computer programming, consultancy and related activities"
    }
  ]
}

company.activityDescription

string

A text description of the company activities

Example:

"Development of software solutions and IT consulting services"

company.legalAddress

object

The address of the company.

Show child attributes

company.legalAddress.addressLine1

string

required

First line of the address

Example:

"10 rue de la Fraternité"

company.legalAddress.city

string

required

City of the address

Example:

"Bagnolet"

company.legalAddress.postalCode

string

required

Postal code of the address

Example:

"93170"

company.legalAddress.region

string

required

Region of the address

Example:

"FR"

company.legalAddress.countryCode

string

required

Country of the address using ISO 3166-1 alpha-2 country code

Example:

"FR"

company.legalAddress.state

string

required

State of the address

Example:

"Île-de-France"

company.legalAddress.addressLine2

string

Second line of the address

Example:

"Topograph Building"

company.legalAddress.poBox

string

Post Office Box number

Example:

"PO Box 123"

company.legalAddress.careOf

string

Care of (c/o) recipient

Example:

"c/o John Doe"

company.phones

string[]

An array of phone numbers for the company in E.164 format (e.g., +33123456789 for France, +1234567890 for USA).

Example:

["+33123456789", "+33987654321"]

company.website

string

The official website URL of the company.

Example:

"https://www.example.com"

company.employeeCount

object

The employee count information for the company.

Show child attributes

company.employeeCount.exact

number

The exact number of employees, if known

Example:

150

company.employeeCount.min

number

The minimum number of employees in a range

Example:

100

company.employeeCount.max

number

The maximum number of employees in a range

Example:

200

company.employeeCount.lastUpdated

string

The date when the employee count was last updated

Example:

"2024-03-15"

company.employeeCount.isEstimate

boolean

Indicates if the employee count is an estimate

Example:

false

ultimateBeneficialOwners

object[]

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

Show child attributes

ultimateBeneficialOwners.gender

enum<string>

required

Gender of the person

Available options:

Male,

Female,

Other,

PreferNotToSay

Example:

"Female"

ultimateBeneficialOwners.name

object

required

Full name of the person

Show child attributes

ultimateBeneficialOwners.name.fullName

string

required

Full name of the person

ultimateBeneficialOwners.name.title

string

Title of the person (e.g., Mr., Mrs., Dr.)

ultimateBeneficialOwners.name.firstName

string

First name of the person

ultimateBeneficialOwners.name.middleName

string

Middle name of the person

ultimateBeneficialOwners.name.lastName

string

Last name of the person

ultimateBeneficialOwners.name.suffix

string

Suffix of the name (e.g., Jr., Sr., III)

Example:

{ "fullName": "John Doe" }

ultimateBeneficialOwners.birthDate

object

required

Birth date of the person

Show child attributes

ultimateBeneficialOwners.birthDate.day

number

Day of birth (1-31)

Example:

15

ultimateBeneficialOwners.birthDate.month

number

Month of birth (1-12), where January is 1

Example:

7

ultimateBeneficialOwners.birthDate.year

number

Year of birth

Example:

1980

Example:

{ "day": 15, "month": 7, "year": 1980 }

ultimateBeneficialOwners.birthAddress

object

required

Birth address of the person

Show child attributes

ultimateBeneficialOwners.birthAddress.addressLine1

string

required

First line of the address

Example:

"10 rue de la Fraternité"

ultimateBeneficialOwners.birthAddress.city

string

required

City of the address

Example:

"Bagnolet"

ultimateBeneficialOwners.birthAddress.postalCode

string

required

Postal code of the address

Example:

"93170"

ultimateBeneficialOwners.birthAddress.region

string

required

Region of the address

Example:

"FR"

ultimateBeneficialOwners.birthAddress.countryCode

string

required

Country of the address using ISO 3166-1 alpha-2 country code

Example:

"FR"

ultimateBeneficialOwners.birthAddress.state

string

required

State of the address

Example:

"Île-de-France"

ultimateBeneficialOwners.birthAddress.addressLine2

string

Second line of the address

Example:

"Topograph Building"

ultimateBeneficialOwners.birthAddress.poBox

string

Post Office Box number

Example:

"PO Box 123"

ultimateBeneficialOwners.birthAddress.careOf

string

Care of (c/o) recipient

Example:

"c/o John Doe"

Example:

{
  "country": "FR",
  "city": "Paris",
  "street": "1 Rue de Rivoli",
  "postalCode": "75001"
}

ultimateBeneficialOwners.nationality

string

required

Nationality ISO2 country code of the person

Example:

"US"

ultimateBeneficialOwners.residenceAddress

object

required

Residence address of the person

Show child attributes

ultimateBeneficialOwners.residenceAddress.addressLine1

string

required

First line of the address

Example:

"10 rue de la Fraternité"

ultimateBeneficialOwners.residenceAddress.city

string

required

City of the address

Example:

"Bagnolet"

ultimateBeneficialOwners.residenceAddress.postalCode

string

required

Postal code of the address

Example:

"93170"

ultimateBeneficialOwners.residenceAddress.region

string

required

Region of the address

Example:

"FR"

ultimateBeneficialOwners.residenceAddress.countryCode

string

required

Country of the address using ISO 3166-1 alpha-2 country code

Example:

"FR"

ultimateBeneficialOwners.residenceAddress.state

string

required

State of the address

Example:

"Île-de-France"

ultimateBeneficialOwners.residenceAddress.addressLine2

string

Second line of the address

Example:

"Topograph Building"

ultimateBeneficialOwners.residenceAddress.poBox

string

Post Office Box number

Example:

"PO Box 123"

ultimateBeneficialOwners.residenceAddress.careOf

string

Care of (c/o) recipient

Example:

"c/o John Doe"

ultimateBeneficialOwners.control

object

required

Details of control held by the beneficial owner

Show child attributes

ultimateBeneficialOwners.control.types

enum<string>[]

required

Types of control held by the beneficial owner

Available options:

ownership-of-shares,

voting-rights,

appoint-and-remove-directors,

significant-influence-or-control

Example:

["ownership-of-shares"]

ultimateBeneficialOwners.control.description

string

required

Description of why the person is of significant control

Example:

"The person holds more than 50% of the shares in the company."

ultimateBeneficialOwners.control.details

object[]

required

Details about the percentage of control

Show child attributes

ultimateBeneficialOwners.control.details.type

enum<string>

required

Type of percentage detail (shares, voting rights)

Available options:

shares,

voting-rights

Example:

"shares"

ultimateBeneficialOwners.control.details.percentageRange

object

required

Range of control as a lower and upper bound

Show child attributes

ultimateBeneficialOwners.control.details.percentageRange.lower

number

required

Lower bound of the range

Example:

25

ultimateBeneficialOwners.control.details.percentageRange.upper

number

required

Upper bound of the range

Example:

50

Example:

{ "lower": 25, "upper": 50 }

ultimateBeneficialOwners.control.details.percentageValue

number

required

Exact percentage of control

Example:

30

ultimateBeneficialOwners.control.details.monetaryAmount

object

required

Monetary amount of shares controlled

Show child attributes

ultimateBeneficialOwners.control.details.monetaryAmount.amount

number

required

The numeric amount of money.

Example:

1000

ultimateBeneficialOwners.control.details.monetaryAmount.currency

string

required

The ISO 4217 currency code (e.g., EUR, USD).

Example:

"EUR"

ultimateBeneficialOwners.control.details.monetaryAmount.formatted

string

required

Formatted string representation of the monetary amount in the local format

Example:

"1000.00 €"

ultimateBeneficialOwners.control.details.numberOfShares

number

Number of shares controlled

Example:

1000

ultimateBeneficialOwners.control.details.nature

enum<string>

Indicates whether the control is direct or indirect

Available options:

direct,

indirect

Example:

"direct"

Example:

{
  "controlType": "ownership-of-shares",
  "description": "The person holds more than 50% of the shares in the company.",
  "percentageDetails": [
    {
      "type": "shares",
      "range": { "lower": 50, "upper": 75 }
    }
  ],
  "additionalDetails": "Direct ownership of shares"
}

ultimateBeneficialOwners.identifiers

object[]

List of identifiers for the person (e.g., codice fiscale)

Show child attributes

ultimateBeneficialOwners.identifiers.type

string

ultimateBeneficialOwners.identifiers.value

string

legalRepresentatives

object[]

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

Show child attributes

legalRepresentatives.type

enum<string>

required

The type of the legal representative (individual or company)

Available options:

individual,

company

Example:

"individual"

legalRepresentatives.role

object

The role of the legal representative

Show child attributes

legalRepresentatives.role.standardized

enum<string>

required

The standardized role of the individual.

Available options:

Director,

Manager,

Employee,

Chief Executive Officer,

Chief Financial Officer,

Chief Operating Officer,

President,

Vice President,

Secretary,

Treasurer,

Legal Advisor,

General Counsel,

Partner,

Associate,

Other,

Chairman of the Board,

Board Member,

Managing Director,

Executive Director,

Non-Executive Director,

General Partner,

Managing Partner,

Limited Partner,

Administrator,

Liquidator,

Receiver,

Owner,

Chairman,

Auditor

Example:

"Director"

legalRepresentatives.role.localName

string

The local role name in the local language

Example:

"Directeur"

legalRepresentatives.role.englishTranslation

string

The role name in English

Example:

"Director"

legalRepresentatives.role.iso5009Code

string

The ISO 5009 role code

Example:

"GIDXNF"

legalRepresentatives.role.semaphoreStandard

enum<string>

deprecated

The standardized role of the individual.

Available options:

Director,

Manager,

Employee,

Chief Executive Officer,

Chief Financial Officer,

Chief Operating Officer,

President,

Vice President,

Secretary,

Treasurer,

Legal Advisor,

General Counsel,

Partner,

Associate,

Other,

Chairman of the Board,

Board Member,

Managing Director,

Executive Director,

Non-Executive Director,

General Partner,

Managing Partner,

Limited Partner,

Administrator,

Liquidator,

Receiver,

Owner,

Chairman,

Auditor

Example:

"Director"

legalRepresentatives.startDate

string

The start date of the legal representative's role

Example:

"2022-01-01"

legalRepresentatives.endDate

string

The end date of the legal representative's role (if applicable)

Example:

"2023-12-31"

legalRepresentatives.individual

object

Details of the individual legal representative

Show child attributes

legalRepresentatives.individual.gender

enum<string>

required

Gender of the person

Available options:

Male,

Female,

Other,

PreferNotToSay

Example:

"Female"

legalRepresentatives.individual.name

object

required

Full name of the person

Show child attributes

legalRepresentatives.individual.name.fullName

string

required

Full name of the person

legalRepresentatives.individual.name.title

string

Title of the person (e.g., Mr., Mrs., Dr.)

legalRepresentatives.individual.name.firstName

string

First name of the person

legalRepresentatives.individual.name.middleName

string

Middle name of the person

legalRepresentatives.individual.name.lastName

string

Last name of the person

legalRepresentatives.individual.name.suffix

string

Suffix of the name (e.g., Jr., Sr., III)

Example:

{ "fullName": "John Doe" }

legalRepresentatives.individual.birthDate

object

required

Birth date of the person

Show child attributes

legalRepresentatives.individual.birthDate.day

number

Day of birth (1-31)

Example:

15

legalRepresentatives.individual.birthDate.month

number

Month of birth (1-12), where January is 1

Example:

7

legalRepresentatives.individual.birthDate.year

number

Year of birth

Example:

1980

Example:

{ "day": 15, "month": 7, "year": 1980 }

legalRepresentatives.individual.birthAddress

object

required

Birth address of the person

Show child attributes

legalRepresentatives.individual.birthAddress.addressLine1

string

required

First line of the address

Example:

"10 rue de la Fraternité"

legalRepresentatives.individual.birthAddress.city

string

required

City of the address

Example:

"Bagnolet"

legalRepresentatives.individual.birthAddress.postalCode

string

required

Postal code of the address

Example:

"93170"

legalRepresentatives.individual.birthAddress.region

string

required

Region of the address

Example:

"FR"

legalRepresentatives.individual.birthAddress.countryCode

string

required

Country of the address using ISO 3166-1 alpha-2 country code

Example:

"FR"

legalRepresentatives.individual.birthAddress.state

string

required

State of the address

Example:

"Île-de-France"

legalRepresentatives.individual.birthAddress.addressLine2

string

Second line of the address

Example:

"Topograph Building"

legalRepresentatives.individual.birthAddress.poBox

string

Post Office Box number

Example:

"PO Box 123"

legalRepresentatives.individual.birthAddress.careOf

string

Care of (c/o) recipient

Example:

"c/o John Doe"

Example:

{
  "country": "FR",
  "city": "Paris",
  "street": "1 Rue de Rivoli",
  "postalCode": "75001"
}

legalRepresentatives.individual.nationality

string

required

Nationality ISO2 country code of the person

Example:

"US"

legalRepresentatives.individual.residenceAddress

object

required

Residence address of the person

Show child attributes

legalRepresentatives.individual.residenceAddress.addressLine1

string

required

First line of the address

Example:

"10 rue de la Fraternité"

legalRepresentatives.individual.residenceAddress.city

string

required

City of the address

Example:

"Bagnolet"

legalRepresentatives.individual.residenceAddress.postalCode

string

required

Postal code of the address

Example:

"93170"

legalRepresentatives.individual.residenceAddress.region

string

required

Region of the address

Example:

"FR"

legalRepresentatives.individual.residenceAddress.countryCode

string

required

Country of the address using ISO 3166-1 alpha-2 country code

Example:

"FR"

legalRepresentatives.individual.residenceAddress.state

string

required

State of the address

Example:

"Île-de-France"

legalRepresentatives.individual.residenceAddress.addressLine2

string

Second line of the address

Example:

"Topograph Building"

legalRepresentatives.individual.residenceAddress.poBox

string

Post Office Box number

Example:

"PO Box 123"

legalRepresentatives.individual.residenceAddress.careOf

string

Care of (c/o) recipient

Example:

"c/o John Doe"

legalRepresentatives.individual.identifiers

object[]

List of identifiers for the person (e.g., codice fiscale)

Show child attributes

legalRepresentatives.individual.identifiers.type

string

legalRepresentatives.individual.identifiers.value

string

legalRepresentatives.company

object

Details of the company legal representative

Show child attributes

legalRepresentatives.company.id

string

required

The id of the company, see documentation.

Example:

"932884117"

legalRepresentatives.company.countryCode

enum<string>

required

The ISO 3166-1 alpha-2 country code of the company registration country

Available options:

AF,

AX,

AL,

DZ,

AS,

AD,

AO,

AI,

AQ,

AG,

AR,

AM,

AW,

AU,

AT,

AZ,

BS,

BH,

BD,

BB,

BY,

BE,

BZ,

BJ,

BM,

BT,

BO,

BQ,

BA,

BW,

BV,

BR,

IO,

BN,

BG,

BF,

BI,

KH,

CM,

CA,

CV,

KY,

CF,

TD,

CL,

CN,

CX,

CC,

CO,

KM,

CG,

CD,

CK,

CR,

CI,

HR,

CU,

CW,

CY,

CZ,

DK,

DJ,

DM,

DO,

EC,

EG,

SV,

GQ,

ER,

EE,

ET,

FK,

FO,

FJ,

FI,

FR,

GF,

PF,

TF,

GA,

GM,

GE,

DE,

GH,

GI,

GR,

GL,

GD,

GP,

GU,

GT,

GG,

GN,

GW,

GY,

HT,

HM,

VA,

HN,

HK,

HU,

IS,

IN,

ID,

IR,

IQ,

IE,

IM,

IL,

IT,

JM,

JP,

JE,

JO,

KZ,

KE,

KI,

KR,

KP,

KW,

KG,

LA,

LV,

LB,

LS,

LR,

LY,

LI,

LT,

LU,

MO,

MK,

MG,

MW,

MY,

MV,

ML,

MT,

MH,

MQ,

MR,

MU,

YT,

MX,

FM,

MD,

MC,

MN,

ME,

MS,

MA,

MZ,

MM,

NA,

NR,

NP,

NL,

NC,

NZ,

NI,

NE,

NG,

NU,

NF,

MP,

NO,

OM,

PK,

PW,

PS,

PA,

PG,

PY,

PE,

PH,

PN,

PL,

PT,

PR,

QA,

RE,

RO,

RU,

RW,

BL,

SH,

KN,

LC,

MF,

PM,

VC,

WS,

SM,

ST,

SA,

SN,

RS,

SC,

SL,

SG,

SX,

SK,

SI,

SB,

SO,

ZA,

GS,

SS,

ES,

LK,

SD,

SR,

SJ,

SZ,

SE,

CH,

SY,

TW,

TJ,

TZ,

TH,

TL,

TG,

TK,

TO,

TT,

TN,

TR,

TM,

TC,

TV,

UG,

UA,

AE,

GB,

US,

UM,

UY,

UZ,

VU,

VE,

VN,

VG,

VI,

WF,

EH,

YE,

ZM,

ZW,

TEST

Example:

"FR"

legalRepresentatives.company.identifiers

object

A dictionary of different identifiers for the company

Show child attributes

legalRepresentatives.company.identifiers.{key}

string

Example:

{
  "SIREN": "932884117",
  "VAT": "FR42932884117"
}

legalRepresentatives.company.legalName

string

The legal name of the company.

Example:

"Topograph"

legalRepresentatives.company.legalNameInEnglish

string

Example:

"Test Display Hong Kong Trading Limited"

legalRepresentatives.company.commercialNames

string[]

An array of commercial names or trading names used by the company.

Example:

["Topograph", "TopographHQ"]

legalRepresentatives.company.legacyLegalNames

string[]

An array of legacy legal names used by the company.

Example:

["Semaphore", "SemaphoreHQ"]

legalRepresentatives.company.legacyCommercialNames

string[]

An array of legacy commercial names used by the company.

Example:

["Semaphore", "SemaphoreHQ"]

legalRepresentatives.company.status

object

The status of the company, including local status and whether it is active.

Show child attributes

legalRepresentatives.company.status.localName

string

required

The local status of the company in the local language

Example:

"active"

legalRepresentatives.company.status.active

boolean

Indicates if the company is active.

Example:

true

legalRepresentatives.company.status.statusDetailsBeta

object

Detailed status information including closure reasons and dates

Show child attributes

legalRepresentatives.company.status.statusDetailsBeta.status

enum<string>

required

The standardized status of the company

Available options:

ACTIVE,

UNDER_INSOLVENCY_PROCEEDING,

CLOSED,

UNKNOWN

Example:

"ACTIVE"

legalRepresentatives.company.status.statusDetailsBeta.closureReason

enum<string>

The reason for company closure, if applicable

Available options:

BANKRUPTCY,

LIQUIDATION,

MERGER,

ACQUISITION,

VOLUNTARY_DISSOLUTION,

ADMINISTRATIVE_DISSOLUTION,

COURT_ORDER,

OTHER,

UNKNOWN

Example:

"BANKRUPTCY"

legalRepresentatives.company.status.statusDetailsBeta.closureDate

string

The date when the company was closed, if applicable

Example:

"2024-01-15"

legalRepresentatives.company.status.statusDetailsBeta.insolvencyStartDate

string

The date when insolvency proceedings started, if applicable

Example:

"2023-12-01"

legalRepresentatives.company.status.statusDetailsBeta.additionalInfo

string

Additional information about the status

Example:

"Company entered voluntary liquidation due to retirement of owner"

legalRepresentatives.company.registrationDate

string

The registration date of the company with the trade register or other authorities.

Example:

"2024-04-22"

legalRepresentatives.company.incorporationDate

string

Example:

"2024-04-15"

legalRepresentatives.company.legalForm

object

The legal form of the company, including local and standard forms.

Show child attributes

legalRepresentatives.company.legalForm.localName

string

The local legal form of the company, in the local language

Example:

"EURL, entreprise unipersonnelle à responsabilité limitée"

legalRepresentatives.company.legalForm.englishTranslation

string

The English translation of the local legal form.

Example:

"Single Member Limited Liability Company"

legalRepresentatives.company.legalForm.semaphoreStandard

enum<string>

deprecated

The standardized legal form of the company.

Available options:

Sole Proprietorship,

Partnership,

Limited Liability Company,

Corporation,

Nonprofit Organization,

Cooperative,

Government-Owned Entity,

Branch or Representative Office,

Trust,

Other

Example:

"Limited Liability Company"

legalRepresentatives.company.legalForm.standardized

enum<string>

The standardized legal form of the company.

Available options:

Sole Proprietorship,

Partnership,

Limited Liability Company,

Corporation,

Nonprofit Organization,

Cooperative,

Government-Owned Entity,

Branch or Representative Office,

Trust,

Other

Example:

"Limited Liability Company"

legalRepresentatives.company.legalForm.iso20275Code

string

The ISO 20275 Entity Legal Form code for the company.

Example:

"F8DD"

legalRepresentatives.company.capital

object

The share capital of the company.

Show child attributes

legalRepresentatives.company.capital.amount

number

required

The numeric amount of money.

Example:

1000

legalRepresentatives.company.capital.currency

string

required

The ISO 4217 currency code (e.g., EUR, USD).

Example:

"EUR"

legalRepresentatives.company.capital.formatted

string

required

Formatted string representation of the monetary amount in the local format

Example:

"1000.00 €"

legalRepresentatives.company.activities

object

A dictionary of activity classifications

Show child attributes

legalRepresentatives.company.activities.{key}

object[]

Show child attributes

legalRepresentatives.company.activities.{key}.code

string

required

The activity code

Example:

"62.01"

legalRepresentatives.company.activities.{key}.description

string

required

The description of the activity

Example:

"Computer programming activities"

legalRepresentatives.company.activities.{key}.isAIInferred

boolean

required

Indicates whether the activity code comes from an official source or has been inferred by AI

Example:

true

Example:

{
  "NACE": [
    {
      "code": "62.01",
      "description": "Computer programming activities"
    }
  ],
  "ISIC": [
    {
      "code": "J620",
      "description": "Computer programming, consultancy and related activities"
    }
  ]
}

legalRepresentatives.company.activityDescription

string

A text description of the company activities

Example:

"Development of software solutions and IT consulting services"

legalRepresentatives.company.legalAddress

object

The address of the company.

Show child attributes

legalRepresentatives.company.legalAddress.addressLine1

string

required

First line of the address

Example:

"10 rue de la Fraternité"

legalRepresentatives.company.legalAddress.city

string

required

City of the address

Example:

"Bagnolet"

legalRepresentatives.company.legalAddress.postalCode

string

required

Postal code of the address

Example:

"93170"

legalRepresentatives.company.legalAddress.region

string

required

Region of the address

Example:

"FR"

legalRepresentatives.company.legalAddress.countryCode

string

required

Country of the address using ISO 3166-1 alpha-2 country code

Example:

"FR"

legalRepresentatives.company.legalAddress.state

string

required

State of the address

Example:

"Île-de-France"

legalRepresentatives.company.legalAddress.addressLine2

string

Second line of the address

Example:

"Topograph Building"

legalRepresentatives.company.legalAddress.poBox

string

Post Office Box number

Example:

"PO Box 123"

legalRepresentatives.company.legalAddress.careOf

string

Care of (c/o) recipient

Example:

"c/o John Doe"

legalRepresentatives.company.phones

string[]

An array of phone numbers for the company in E.164 format (e.g., +33123456789 for France, +1234567890 for USA).

Example:

["+33123456789", "+33987654321"]

legalRepresentatives.company.website

string

The official website URL of the company.

Example:

"https://www.example.com"

legalRepresentatives.company.employeeCount

object

The employee count information for the company.

Show child attributes

legalRepresentatives.company.employeeCount.exact

number

The exact number of employees, if known

Example:

150

legalRepresentatives.company.employeeCount.min

number

The minimum number of employees in a range

Example:

100

legalRepresentatives.company.employeeCount.max

number

The maximum number of employees in a range

Example:

200

legalRepresentatives.company.employeeCount.lastUpdated

string

The date when the employee count was last updated

Example:

"2024-03-15"

legalRepresentatives.company.employeeCount.isEstimate

boolean

Indicates if the employee count is an estimate

Example:

false

shareholders

object[]

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

Show child attributes

shareholders.type

enum<string>

required

The type of the shareholder (individual or company)

Available options:

individual,

company

Example:

"individual"

shareholders.individual

object

Details of the individual shareholder

Show child attributes

shareholders.individual.gender

enum<string>

required

Gender of the person

Available options:

Male,

Female,

Other,

PreferNotToSay

Example:

"Female"

shareholders.individual.name

object

required

Full name of the person

Show child attributes

shareholders.individual.name.fullName

string

required

Full name of the person

shareholders.individual.name.title

string

Title of the person (e.g., Mr., Mrs., Dr.)

shareholders.individual.name.firstName

string

First name of the person

shareholders.individual.name.middleName

string

Middle name of the person

shareholders.individual.name.lastName

string

Last name of the person

shareholders.individual.name.suffix

string

Suffix of the name (e.g., Jr., Sr., III)

Example:

{ "fullName": "John Doe" }

shareholders.individual.birthDate

object

required

Birth date of the person

Show child attributes

shareholders.individual.birthDate.day

number

Day of birth (1-31)

Example:

15

shareholders.individual.birthDate.month

number

Month of birth (1-12), where January is 1

Example:

7

shareholders.individual.birthDate.year

number

Year of birth

Example:

1980

Example:

{ "day": 15, "month": 7, "year": 1980 }

shareholders.individual.birthAddress

object

required

Birth address of the person

Show child attributes

shareholders.individual.birthAddress.addressLine1

string

required

First line of the address

Example:

"10 rue de la Fraternité"

shareholders.individual.birthAddress.city

string

required

City of the address

Example:

"Bagnolet"

shareholders.individual.birthAddress.postalCode

string

required

Postal code of the address

Example:

"93170"

shareholders.individual.birthAddress.region

string

required

Region of the address

Example:

"FR"

shareholders.individual.birthAddress.countryCode

string

required

Country of the address using ISO 3166-1 alpha-2 country code

Example:

"FR"

shareholders.individual.birthAddress.state

string

required

State of the address

Example:

"Île-de-France"

shareholders.individual.birthAddress.addressLine2

string

Second line of the address

Example:

"Topograph Building"

shareholders.individual.birthAddress.poBox

string

Post Office Box number

Example:

"PO Box 123"

shareholders.individual.birthAddress.careOf

string

Care of (c/o) recipient

Example:

"c/o John Doe"

Example:

{
  "country": "FR",
  "city": "Paris",
  "street": "1 Rue de Rivoli",
  "postalCode": "75001"
}

shareholders.individual.nationality

string

required

Nationality ISO2 country code of the person

Example:

"US"

shareholders.individual.residenceAddress

object

required

Residence address of the person

Show child attributes

shareholders.individual.residenceAddress.addressLine1

string

required

First line of the address

Example:

"10 rue de la Fraternité"

shareholders.individual.residenceAddress.city

string

required

City of the address

Example:

"Bagnolet"

shareholders.individual.residenceAddress.postalCode

string

required

Postal code of the address

Example:

"93170"

shareholders.individual.residenceAddress.region

string

required

Region of the address

Example:

"FR"

shareholders.individual.residenceAddress.countryCode

string

required

Country of the address using ISO 3166-1 alpha-2 country code

Example:

"FR"

shareholders.individual.residenceAddress.state

string

required

State of the address

Example:

"Île-de-France"

shareholders.individual.residenceAddress.addressLine2

string

Second line of the address

Example:

"Topograph Building"

shareholders.individual.residenceAddress.poBox

string

Post Office Box number

Example:

"PO Box 123"

shareholders.individual.residenceAddress.careOf

string

Care of (c/o) recipient

Example:

"c/o John Doe"

shareholders.individual.identifiers

object[]

List of identifiers for the person (e.g., codice fiscale)

Show child attributes

shareholders.individual.identifiers.type

string

shareholders.individual.identifiers.value

string

shareholders.company

object

Details of the company shareholder

Show child attributes

shareholders.company.id

string

required

The id of the company, see documentation.

Example:

"932884117"

shareholders.company.countryCode

enum<string>

required

The ISO 3166-1 alpha-2 country code of the company registration country

Available options:

AF,

AX,

AL,

DZ,

AS,

AD,

AO,

AI,

AQ,

AG,

AR,

AM,

AW,

AU,

AT,

AZ,

BS,

BH,

BD,

BB,

BY,

BE,

BZ,

BJ,

BM,

BT,

BO,

BQ,

BA,

BW,

BV,

BR,

IO,

BN,

BG,

BF,

BI,

KH,

CM,

CA,

CV,

KY,

CF,

TD,

CL,

CN,

CX,

CC,

CO,

KM,

CG,

CD,

CK,

CR,

CI,

HR,

CU,

CW,

CY,

CZ,

DK,

DJ,

DM,

DO,

EC,

EG,

SV,

GQ,

ER,

EE,

ET,

FK,

FO,

FJ,

FI,

FR,

GF,

PF,

TF,

GA,

GM,

GE,

DE,

GH,

GI,

GR,

GL,

GD,

GP,

GU,

GT,

GG,

GN,

GW,

GY,

HT,

HM,

VA,

HN,

HK,

HU,

IS,

IN,

ID,

IR,

IQ,

IE,

IM,

IL,

IT,

JM,

JP,

JE,

JO,

KZ,

KE,

KI,

KR,

KP,

KW,

KG,

LA,

LV,

LB,

LS,

LR,

LY,

LI,

LT,

LU,

MO,

MK,

MG,

MW,

MY,

MV,

ML,

MT,

MH,

MQ,

MR,

MU,

YT,

MX,

FM,

MD,

MC,

MN,

ME,

MS,

MA,

MZ,

MM,

NA,

NR,

NP,

NL,

NC,

NZ,

NI,

NE,

NG,

NU,

NF,

MP,

NO,

OM,

PK,

PW,

PS,

PA,

PG,

PY,

PE,

PH,

PN,

PL,

PT,

PR,

QA,

RE,

RO,

RU,

RW,

BL,

SH,

KN,

LC,

MF,

PM,

VC,

WS,

SM,

ST,

SA,

SN,

RS,

SC,

SL,

SG,

SX,

SK,

SI,

SB,

SO,

ZA,

GS,

SS,

ES,

LK,

SD,

SR,

SJ,

SZ,

SE,

CH,

SY,

TW,

TJ,

TZ,

TH,

TL,

TG,

TK,

TO,

TT,

TN,

TR,

TM,

TC,

TV,

UG,

UA,

AE,

GB,

US,

UM,

UY,

UZ,

VU,

VE,

VN,

VG,

VI,

WF,

EH,

YE,

ZM,

ZW,

TEST

Example:

"FR"

shareholders.company.identifiers

object

A dictionary of different identifiers for the company

Show child attributes

shareholders.company.identifiers.{key}

string

Example:

{
  "SIREN": "932884117",
  "VAT": "FR42932884117"
}

shareholders.company.legalName

string

The legal name of the company.

Example:

"Topograph"

shareholders.company.legalNameInEnglish

string

Example:

"Test Display Hong Kong Trading Limited"

shareholders.company.commercialNames

string[]

An array of commercial names or trading names used by the company.

Example:

["Topograph", "TopographHQ"]

shareholders.company.legacyLegalNames

string[]

An array of legacy legal names used by the company.

Example:

["Semaphore", "SemaphoreHQ"]

shareholders.company.legacyCommercialNames

string[]

An array of legacy commercial names used by the company.

Example:

["Semaphore", "SemaphoreHQ"]

shareholders.company.status

object

The status of the company, including local status and whether it is active.

Show child attributes

shareholders.company.status.localName

string

required

The local status of the company in the local language

Example:

"active"

shareholders.company.status.active

boolean

Indicates if the company is active.

Example:

true

shareholders.company.status.statusDetailsBeta

object

Detailed status information including closure reasons and dates

Show child attributes

shareholders.company.status.statusDetailsBeta.status

enum<string>

required

The standardized status of the company

Available options:

ACTIVE,

UNDER_INSOLVENCY_PROCEEDING,

CLOSED,

UNKNOWN

Example:

"ACTIVE"

shareholders.company.status.statusDetailsBeta.closureReason

enum<string>

The reason for company closure, if applicable

Available options:

BANKRUPTCY,

LIQUIDATION,

MERGER,

ACQUISITION,

VOLUNTARY_DISSOLUTION,

ADMINISTRATIVE_DISSOLUTION,

COURT_ORDER,

OTHER,

UNKNOWN

Example:

"BANKRUPTCY"

shareholders.company.status.statusDetailsBeta.closureDate

string

The date when the company was closed, if applicable

Example:

"2024-01-15"

shareholders.company.status.statusDetailsBeta.insolvencyStartDate

string

The date when insolvency proceedings started, if applicable

Example:

"2023-12-01"

shareholders.company.status.statusDetailsBeta.additionalInfo

string

Additional information about the status

Example:

"Company entered voluntary liquidation due to retirement of owner"

shareholders.company.registrationDate

string

The registration date of the company with the trade register or other authorities.

Example:

"2024-04-22"

shareholders.company.incorporationDate

string

Example:

"2024-04-15"

shareholders.company.legalForm

object

The legal form of the company, including local and standard forms.

Show child attributes

shareholders.company.legalForm.localName

string

The local legal form of the company, in the local language

Example:

"EURL, entreprise unipersonnelle à responsabilité limitée"

shareholders.company.legalForm.englishTranslation

string

The English translation of the local legal form.

Example:

"Single Member Limited Liability Company"

shareholders.company.legalForm.semaphoreStandard

enum<string>

deprecated

The standardized legal form of the company.

Available options:

Sole Proprietorship,

Partnership,

Limited Liability Company,

Corporation,

Nonprofit Organization,

Cooperative,

Government-Owned Entity,

Branch or Representative Office,

Trust,

Other

Example:

"Limited Liability Company"

shareholders.company.legalForm.standardized

enum<string>

The standardized legal form of the company.

Available options:

Sole Proprietorship,

Partnership,

Limited Liability Company,

Corporation,

Nonprofit Organization,

Cooperative,

Government-Owned Entity,

Branch or Representative Office,

Trust,

Other

Example:

"Limited Liability Company"

shareholders.company.legalForm.iso20275Code

string

The ISO 20275 Entity Legal Form code for the company.

Example:

"F8DD"

shareholders.company.capital

object

The share capital of the company.

Show child attributes

shareholders.company.capital.amount

number

required

The numeric amount of money.

Example:

1000

shareholders.company.capital.currency

string

required

The ISO 4217 currency code (e.g., EUR, USD).

Example:

"EUR"

shareholders.company.capital.formatted

string

required

Formatted string representation of the monetary amount in the local format

Example:

"1000.00 €"

shareholders.company.activities

object

A dictionary of activity classifications

Show child attributes

shareholders.company.activities.{key}

object[]

Show child attributes

shareholders.company.activities.{key}.code

string

required

The activity code

Example:

"62.01"

shareholders.company.activities.{key}.description

string

required

The description of the activity

Example:

"Computer programming activities"

shareholders.company.activities.{key}.isAIInferred

boolean

required

Indicates whether the activity code comes from an official source or has been inferred by AI

Example:

true

Example:

{
  "NACE": [
    {
      "code": "62.01",
      "description": "Computer programming activities"
    }
  ],
  "ISIC": [
    {
      "code": "J620",
      "description": "Computer programming, consultancy and related activities"
    }
  ]
}

shareholders.company.activityDescription

string

A text description of the company activities

Example:

"Development of software solutions and IT consulting services"

shareholders.company.legalAddress

object

The address of the company.

Show child attributes

shareholders.company.legalAddress.addressLine1

string

required

First line of the address

Example:

"10 rue de la Fraternité"

shareholders.company.legalAddress.city

string

required

City of the address

Example:

"Bagnolet"

shareholders.company.legalAddress.postalCode

string

required

Postal code of the address

Example:

"93170"

shareholders.company.legalAddress.region

string

required

Region of the address

Example:

"FR"

shareholders.company.legalAddress.countryCode

string

required

Country of the address using ISO 3166-1 alpha-2 country code

Example:

"FR"

shareholders.company.legalAddress.state

string

required

State of the address

Example:

"Île-de-France"

shareholders.company.legalAddress.addressLine2

string

Second line of the address

Example:

"Topograph Building"

shareholders.company.legalAddress.poBox

string

Post Office Box number

Example:

"PO Box 123"

shareholders.company.legalAddress.careOf

string

Care of (c/o) recipient

Example:

"c/o John Doe"

shareholders.company.phones

string[]

An array of phone numbers for the company in E.164 format (e.g., +33123456789 for France, +1234567890 for USA).

Example:

["+33123456789", "+33987654321"]

shareholders.company.website

string

The official website URL of the company.

Example:

"https://www.example.com"

shareholders.company.employeeCount

object

The employee count information for the company.

Show child attributes

shareholders.company.employeeCount.exact

number

The exact number of employees, if known

Example:

150

shareholders.company.employeeCount.min

number

The minimum number of employees in a range

Example:

100

shareholders.company.employeeCount.max

number

The maximum number of employees in a range

Example:

200

shareholders.company.employeeCount.lastUpdated

string

The date when the employee count was last updated

Example:

"2024-03-15"

shareholders.company.employeeCount.isEstimate

boolean

Indicates if the employee count is an estimate

Example:

false

The percentage of shares owned by the shareholder

Example:

25.5

shareholders.numberOfShares

number

The absolute number of shares owned by the shareholder

Example:

1000

shareholders.nominalCapitalHeld

object

Total nominal (stated) capital value held by this shareholder. This is the face value or par value of all shares owned, calculated as numberOfShares × parValuePerShare. For example, if a shareholder owns 1000 shares with a par value of €10 each, nominalCapitalHeld would be €10,000. This value represents the legal capital contribution recorded in company documents, not the market value or actual amount paid.

Show child attributes

shareholders.nominalCapitalHeld.amount

number

required

The numeric amount of money.

Example:

1000

shareholders.nominalCapitalHeld.currency

string

required

The ISO 4217 currency code (e.g., EUR, USD).

Example:

"EUR"

shareholders.nominalCapitalHeld.formatted

string

required

Formatted string representation of the monetary amount in the local format

Example:

"1000.00 €"

shareholders.paidInAmount

object

Total actual amount paid by the shareholder for their shares, including any share premium over the nominal/par value. This represents the real money invested. For example, if shares with €10,000 nominal value were purchased for €15,000, the paidInAmount would be €15,000. In Italy this corresponds to "valore versato", in Germany to "eingezahltes Kapital". This field captures the actual capital contribution to the company.

Show child attributes

shareholders.paidInAmount.amount

number

required

The numeric amount of money.

Example:

1000

shareholders.paidInAmount.currency

string

required

The ISO 4217 currency code (e.g., EUR, USD).

Example:

"EUR"

shareholders.paidInAmount.formatted

string

required

Formatted string representation of the monetary amount in the local format

Example:

"1000.00 €"

shareholders.source

string

Description of how the shareholder was found and from which document

Example:

"Found in financial statements (Jahresabschluss 2023) - control relationship indicated by Konzernzugehörigkeit"

establishments

object[]

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

Show child attributes

establishments.name

string

required

The name of the establishment

Example:

"Main Office"

establishments.id

string

Unique identifier for the establishment

Example:

"EST-001"

establishments.creationDate

string

The creation date of the establishment

Example:

"2020-01-15"

establishments.endDate

string

The closing date of the establishment (if applicable)

Example:

"2023-12-31"

establishments.active

boolean

Whether the establishment is currently active

Example:

true

establishments.address

object

The address of the establishment

Show child attributes

establishments.address.addressLine1

string

required

First line of the address

Example:

"10 rue de la Fraternité"

establishments.address.city

string

required

City of the address

Example:

"Bagnolet"

establishments.address.postalCode

string

required

Postal code of the address

Example:

"93170"

establishments.address.region

string

required

Region of the address

Example:

"FR"

establishments.address.countryCode

string

required

Country of the address using ISO 3166-1 alpha-2 country code

Example:

"FR"

establishments.address.state

string

required

State of the address

Example:

"Île-de-France"

establishments.address.addressLine2

string

Second line of the address

Example:

"Topograph Building"

establishments.address.poBox

string

Post Office Box number

Example:

"PO Box 123"

establishments.address.careOf

string

Care of (c/o) recipient

Example:

"c/o John Doe"

otherKeyPersons

object[]

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

Show child attributes

otherKeyPersons.type

enum<string>

required

The type of the other key person (individual or company)

Available options:

individual,

company

Example:

"individual"

otherKeyPersons.role

object

The role of the other key person

Show child attributes

otherKeyPersons.role.standardized

enum<string>

required

The standardized role of the individual.

Available options:

Board Member,

Non-Executive Director,

Independent Director,

Advisory Board Member,

Board Observer,

Auditor,

Compliance Officer,

Data Protection Officer,

Money Laundering Reporting Officer,

Secretary,

Supervisor,

Supervisory Board Member,

C-Level Executive,

Other

Example:

"Board Member"

otherKeyPersons.role.localName

string

The local role name in the local language

Example:

"Commissaire aux comptes"

otherKeyPersons.role.englishTranslation

string

The role name in English

Example:

"Auditor"

otherKeyPersons.role.semaphoreStandard

enum<string>

deprecated

The standardized role of the individual.

Available options:

Board Member,

Non-Executive Director,

Independent Director,

Advisory Board Member,

Board Observer,

Auditor,

Compliance Officer,

Data Protection Officer,

Money Laundering Reporting Officer,

Secretary,

Supervisor,

Supervisory Board Member,

C-Level Executive,

Other

Example:

"Board Member"

otherKeyPersons.startDate

string

The start date of the role

Example:

"2022-01-01"

otherKeyPersons.endDate

string

The end date of the role (if applicable)

Example:

"2023-12-31"

otherKeyPersons.individual

object

Details if the other key person is an individual

Show child attributes

otherKeyPersons.individual.gender

enum<string>

required

Gender of the person

Available options:

Male,

Female,

Other,

PreferNotToSay

Example:

"Female"

otherKeyPersons.individual.name

object

required

Full name of the person

Show child attributes

otherKeyPersons.individual.name.fullName

string

required

Full name of the person

otherKeyPersons.individual.name.title

string

Title of the person (e.g., Mr., Mrs., Dr.)

otherKeyPersons.individual.name.firstName

string

First name of the person

otherKeyPersons.individual.name.middleName

string

Middle name of the person

otherKeyPersons.individual.name.lastName

string

Last name of the person

otherKeyPersons.individual.name.suffix

string

Suffix of the name (e.g., Jr., Sr., III)

Example:

{ "fullName": "John Doe" }

otherKeyPersons.individual.birthDate

object

required

Birth date of the person

Show child attributes

otherKeyPersons.individual.birthDate.day

number

Day of birth (1-31)

Example:

15

otherKeyPersons.individual.birthDate.month

number

Month of birth (1-12), where January is 1

Example:

7

otherKeyPersons.individual.birthDate.year

number

Year of birth

Example:

1980

Example:

{ "day": 15, "month": 7, "year": 1980 }

otherKeyPersons.individual.birthAddress

object

required

Birth address of the person

Show child attributes

otherKeyPersons.individual.birthAddress.addressLine1

string

required

First line of the address

Example:

"10 rue de la Fraternité"

otherKeyPersons.individual.birthAddress.city

string

required

City of the address

Example:

"Bagnolet"

otherKeyPersons.individual.birthAddress.postalCode

string

required

Postal code of the address

Example:

"93170"

otherKeyPersons.individual.birthAddress.region

string

required

Region of the address

Example:

"FR"

otherKeyPersons.individual.birthAddress.countryCode

string

required

Country of the address using ISO 3166-1 alpha-2 country code

Example:

"FR"

otherKeyPersons.individual.birthAddress.state

string

required

State of the address

Example:

"Île-de-France"

otherKeyPersons.individual.birthAddress.addressLine2

string

Second line of the address

Example:

"Topograph Building"

otherKeyPersons.individual.birthAddress.poBox

string

Post Office Box number

Example:

"PO Box 123"

otherKeyPersons.individual.birthAddress.careOf

string

Care of (c/o) recipient

Example:

"c/o John Doe"

Example:

{
  "country": "FR",
  "city": "Paris",
  "street": "1 Rue de Rivoli",
  "postalCode": "75001"
}

otherKeyPersons.individual.nationality

string

required

Nationality ISO2 country code of the person

Example:

"US"

otherKeyPersons.individual.residenceAddress

object

required

Residence address of the person

Show child attributes

otherKeyPersons.individual.residenceAddress.addressLine1

string

required

First line of the address

Example:

"10 rue de la Fraternité"

otherKeyPersons.individual.residenceAddress.city

string

required

City of the address

Example:

"Bagnolet"

otherKeyPersons.individual.residenceAddress.postalCode

string

required

Postal code of the address

Example:

"93170"

otherKeyPersons.individual.residenceAddress.region

string

required

Region of the address

Example:

"FR"

otherKeyPersons.individual.residenceAddress.countryCode

string

required

Country of the address using ISO 3166-1 alpha-2 country code

Example:

"FR"

otherKeyPersons.individual.residenceAddress.state

string

required

State of the address

Example:

"Île-de-France"

otherKeyPersons.individual.residenceAddress.addressLine2

string

Second line of the address

Example:

"Topograph Building"

otherKeyPersons.individual.residenceAddress.poBox

string

Post Office Box number

Example:

"PO Box 123"

otherKeyPersons.individual.residenceAddress.careOf

string

Care of (c/o) recipient

Example:

"c/o John Doe"

otherKeyPersons.individual.identifiers

object[]

List of identifiers for the person (e.g., codice fiscale)

Show child attributes

otherKeyPersons.individual.identifiers.type

string

otherKeyPersons.individual.identifiers.value

string

otherKeyPersons.company

object

Details if the other key person is a company

Show child attributes

otherKeyPersons.company.id

string

required

The id of the company, see documentation.

Example:

"932884117"

otherKeyPersons.company.countryCode

enum<string>

required

The ISO 3166-1 alpha-2 country code of the company registration country

Available options:

AF,

AX,

AL,

DZ,

AS,

AD,

AO,

AI,

AQ,

AG,

AR,

AM,

AW,

AU,

AT,

AZ,

BS,

BH,

BD,

BB,

BY,

BE,

BZ,

BJ,

BM,

BT,

BO,

BQ,

BA,

BW,

BV,

BR,

IO,

BN,

BG,

BF,

BI,

KH,

CM,

CA,

CV,

KY,

CF,

TD,

CL,

CN,

CX,

CC,

CO,

KM,

CG,

CD,

CK,

CR,

CI,

HR,

CU,

CW,

CY,

CZ,

DK,

DJ,

DM,

DO,

EC,

EG,

SV,

GQ,

ER,

EE,

ET,

FK,

FO,

FJ,

FI,

FR,

GF,

PF,

TF,

GA,

GM,

GE,

DE,

GH,

GI,

GR,

GL,

GD,

GP,

GU,

GT,

GG,

GN,

GW,

GY,

HT,

HM,

VA,

HN,

HK,

HU,

IS,

IN,

ID,

IR,

IQ,

IE,

IM,

IL,

IT,

JM,

JP,

JE,

JO,

KZ,

KE,

KI,

KR,

KP,

KW,

KG,

LA,

LV,

LB,

LS,

LR,

LY,

LI,

LT,

LU,

MO,

MK,

MG,

MW,

MY,

MV,

ML,

MT,

MH,

MQ,

MR,

MU,

YT,

MX,

FM,

MD,

MC,

MN,

ME,

MS,

MA,

MZ,

MM,

NA,

NR,

NP,

NL,

NC,

NZ,

NI,

NE,

NG,

NU,

NF,

MP,

NO,

OM,

PK,

PW,

PS,

PA,

PG,

PY,

PE,

PH,

PN,

PL,

PT,

PR,

QA,

RE,

RO,

RU,

RW,

BL,

SH,

KN,

LC,

MF,

PM,

VC,

WS,

SM,

ST,

SA,

SN,

RS,

SC,

SL,

SG,

SX,

SK,

SI,

SB,

SO,

ZA,

GS,

SS,

ES,

LK,

SD,

SR,

SJ,

SZ,

SE,

CH,

SY,

TW,

TJ,

TZ,

TH,

TL,

TG,

TK,

TO,

TT,

TN,

TR,

TM,

TC,

TV,

UG,

UA,

AE,

GB,

US,

UM,

UY,

UZ,

VU,

VE,

VN,

VG,

VI,

WF,

EH,

YE,

ZM,

ZW,

TEST

Example:

"FR"

otherKeyPersons.company.identifiers

object

A dictionary of different identifiers for the company

Show child attributes

otherKeyPersons.company.identifiers.{key}

string

Example:

{
  "SIREN": "932884117",
  "VAT": "FR42932884117"
}

otherKeyPersons.company.legalName

string

The legal name of the company.

Example:

"Topograph"

otherKeyPersons.company.legalNameInEnglish

string

Example:

"Test Display Hong Kong Trading Limited"

otherKeyPersons.company.commercialNames

string[]

An array of commercial names or trading names used by the company.

Example:

["Topograph", "TopographHQ"]

otherKeyPersons.company.legacyLegalNames

string[]

An array of legacy legal names used by the company.

Example:

["Semaphore", "SemaphoreHQ"]

otherKeyPersons.company.legacyCommercialNames

string[]

An array of legacy commercial names used by the company.

Example:

["Semaphore", "SemaphoreHQ"]

otherKeyPersons.company.status

object

The status of the company, including local status and whether it is active.

Show child attributes

otherKeyPersons.company.status.localName

string

required

The local status of the company in the local language

Example:

"active"

otherKeyPersons.company.status.active

boolean

Indicates if the company is active.

Example:

true

otherKeyPersons.company.status.statusDetailsBeta

object

Detailed status information including closure reasons and dates

Show child attributes

otherKeyPersons.company.status.statusDetailsBeta.status

enum<string>

required

The standardized status of the company

Available options:

ACTIVE,

UNDER_INSOLVENCY_PROCEEDING,

CLOSED,

UNKNOWN

Example:

"ACTIVE"

otherKeyPersons.company.status.statusDetailsBeta.closureReason

enum<string>

The reason for company closure, if applicable

Available options:

BANKRUPTCY,

LIQUIDATION,

MERGER,

ACQUISITION,

VOLUNTARY_DISSOLUTION,

ADMINISTRATIVE_DISSOLUTION,

COURT_ORDER,

OTHER,

UNKNOWN

Example:

"BANKRUPTCY"

otherKeyPersons.company.status.statusDetailsBeta.closureDate

string

The date when the company was closed, if applicable

Example:

"2024-01-15"

otherKeyPersons.company.status.statusDetailsBeta.insolvencyStartDate

string

The date when insolvency proceedings started, if applicable

Example:

"2023-12-01"

otherKeyPersons.company.status.statusDetailsBeta.additionalInfo

string

Additional information about the status

Example:

"Company entered voluntary liquidation due to retirement of owner"

otherKeyPersons.company.registrationDate

string

The registration date of the company with the trade register or other authorities.

Example:

"2024-04-22"

otherKeyPersons.company.incorporationDate

string

Example:

"2024-04-15"

otherKeyPersons.company.legalForm

object

The legal form of the company, including local and standard forms.

Show child attributes

otherKeyPersons.company.legalForm.localName

string

The local legal form of the company, in the local language

Example:

"EURL, entreprise unipersonnelle à responsabilité limitée"

otherKeyPersons.company.legalForm.englishTranslation

string

The English translation of the local legal form.

Example:

"Single Member Limited Liability Company"

otherKeyPersons.company.legalForm.semaphoreStandard

enum<string>

deprecated

The standardized legal form of the company.

Available options:

Sole Proprietorship,

Partnership,

Limited Liability Company,

Corporation,

Nonprofit Organization,

Cooperative,

Government-Owned Entity,

Branch or Representative Office,

Trust,

Other

Example:

"Limited Liability Company"

otherKeyPersons.company.legalForm.standardized

enum<string>

The standardized legal form of the company.

Available options:

Sole Proprietorship,

Partnership,

Limited Liability Company,

Corporation,

Nonprofit Organization,

Cooperative,

Government-Owned Entity,

Branch or Representative Office,

Trust,

Other

Example:

"Limited Liability Company"

otherKeyPersons.company.legalForm.iso20275Code

string

The ISO 20275 Entity Legal Form code for the company.

Example:

"F8DD"

otherKeyPersons.company.capital

object

The share capital of the company.

Show child attributes

otherKeyPersons.company.capital.amount

number

required

The numeric amount of money.

Example:

1000

otherKeyPersons.company.capital.currency

string

required

The ISO 4217 currency code (e.g., EUR, USD).

Example:

"EUR"

otherKeyPersons.company.capital.formatted

string

required

Formatted string representation of the monetary amount in the local format

Example:

"1000.00 €"

otherKeyPersons.company.activities

object

A dictionary of activity classifications

Show child attributes

otherKeyPersons.company.activities.{key}

object[]

Show child attributes

otherKeyPersons.company.activities.{key}.code

string

required

The activity code

Example:

"62.01"

otherKeyPersons.company.activities.{key}.description

string

required

The description of the activity

Example:

"Computer programming activities"

otherKeyPersons.company.activities.{key}.isAIInferred

boolean

required

Indicates whether the activity code comes from an official source or has been inferred by AI

Example:

true

Example:

{
  "NACE": [
    {
      "code": "62.01",
      "description": "Computer programming activities"
    }
  ],
  "ISIC": [
    {
      "code": "J620",
      "description": "Computer programming, consultancy and related activities"
    }
  ]
}

otherKeyPersons.company.activityDescription

string

A text description of the company activities

Example:

"Development of software solutions and IT consulting services"

otherKeyPersons.company.legalAddress

object

The address of the company.

Show child attributes

otherKeyPersons.company.legalAddress.addressLine1

string

required

First line of the address

Example:

"10 rue de la Fraternité"

otherKeyPersons.company.legalAddress.city

string

required

City of the address

Example:

"Bagnolet"

otherKeyPersons.company.legalAddress.postalCode

string

required

Postal code of the address

Example:

"93170"

otherKeyPersons.company.legalAddress.region

string

required

Region of the address

Example:

"FR"

otherKeyPersons.company.legalAddress.countryCode

string

required

Country of the address using ISO 3166-1 alpha-2 country code

Example:

"FR"

otherKeyPersons.company.legalAddress.state

string

required

State of the address

Example:

"Île-de-France"

otherKeyPersons.company.legalAddress.addressLine2

string

Second line of the address

Example:

"Topograph Building"

otherKeyPersons.company.legalAddress.poBox

string

Post Office Box number

Example:

"PO Box 123"

otherKeyPersons.company.legalAddress.careOf

string

Care of (c/o) recipient

Example:

"c/o John Doe"

otherKeyPersons.company.phones

string[]

An array of phone numbers for the company in E.164 format (e.g., +33123456789 for France, +1234567890 for USA).

Example:

["+33123456789", "+33987654321"]

otherKeyPersons.company.website

string

The official website URL of the company.

Example:

"https://www.example.com"

otherKeyPersons.company.employeeCount

object

The employee count information for the company.

Show child attributes

otherKeyPersons.company.employeeCount.exact

number

The exact number of employees, if known

Example:

150

otherKeyPersons.company.employeeCount.min

number

The minimum number of employees in a range

Example:

100

otherKeyPersons.company.employeeCount.max

number

The maximum number of employees in a range

Example:

200

otherKeyPersons.company.employeeCount.lastUpdated

string

The date when the employee count was last updated

Example:

"2024-03-15"

otherKeyPersons.company.employeeCount.isEstimate

boolean

Indicates if the employee count is an estimate

Example:

false

graph

object

documents

object

Show child attributes

documents.tradeRegisterExtract

object

required

Show child attributes

documents.tradeRegisterExtract.id

string

required

documents.tradeRegisterExtract.name

string

required

Document name in the local language of the country where it was issued

documents.tradeRegisterExtract.format

string

required

documents.tradeRegisterExtract.description

string

Document description in English

documents.tradeRegisterExtract.estimatedDeliverySeconds

number

documents.tradeRegisterExtract.url

string

documents.tradeRegisterExtract.blobName

string

documents.tradeRegisterExtract.price

number

Fixed price in cents

documents.tradeRegisterExtract.priceMarkup

number

Price markup percentage

documents.tradeRegisterExtract.date

string

documents.certifiedTradeRegisterExtract

object

required

Show child attributes

documents.certifiedTradeRegisterExtract.id

string

required

documents.certifiedTradeRegisterExtract.name

string

required

Document name in the local language of the country where it was issued

documents.certifiedTradeRegisterExtract.format

string

required

documents.certifiedTradeRegisterExtract.description

string

Document description in English

documents.certifiedTradeRegisterExtract.estimatedDeliverySeconds

number

documents.certifiedTradeRegisterExtract.url

string

documents.certifiedTradeRegisterExtract.blobName

string

documents.certifiedTradeRegisterExtract.price

number

Fixed price in cents

documents.certifiedTradeRegisterExtract.priceMarkup

number

Price markup percentage

documents.certifiedTradeRegisterExtract.date

string

documents.financialStatements

object[]

required

Show child attributes

documents.financialStatements.id

string

required

documents.financialStatements.name

string

required

Document name in the local language of the country where it was issued

documents.financialStatements.format

string

required

documents.financialStatements.description

string

Document description in English

documents.financialStatements.estimatedDeliverySeconds

number

documents.financialStatements.url

string

documents.financialStatements.blobName

string

documents.financialStatements.price

number

Fixed price in cents

documents.financialStatements.priceMarkup

number

Price markup percentage

documents.financialStatements.date

string

documents.financialStatements.period

object

Show child attributes

documents.financialStatements.period.startDate

object

Show child attributes

documents.financialStatements.period.startDate.year

number

documents.financialStatements.period.startDate.month

number

documents.financialStatements.period.startDate.day

number

documents.financialStatements.period.endDate

object

Show child attributes

documents.financialStatements.period.endDate.year

number

documents.financialStatements.period.endDate.month

number

documents.financialStatements.period.endDate.day

number

documents.articlesOfAssociation

object[]

required

Show child attributes

documents.articlesOfAssociation.id

string

required

documents.articlesOfAssociation.name

string

required

Document name in the local language of the country where it was issued

documents.articlesOfAssociation.format

string

required

documents.articlesOfAssociation.description

string

Document description in English

documents.articlesOfAssociation.estimatedDeliverySeconds

number

documents.articlesOfAssociation.url

string

documents.articlesOfAssociation.blobName

string

documents.articlesOfAssociation.price

number

Fixed price in cents

documents.articlesOfAssociation.priceMarkup

number

Price markup percentage

documents.articlesOfAssociation.date

string

documents.ultimateBeneficialOwnersCertificate

object[]

required

Show child attributes

documents.ultimateBeneficialOwnersCertificate.id

string

required

documents.ultimateBeneficialOwnersCertificate.name

string

required

Document name in the local language of the country where it was issued

documents.ultimateBeneficialOwnersCertificate.format

string

required

documents.ultimateBeneficialOwnersCertificate.description

string

Document description in English

documents.ultimateBeneficialOwnersCertificate.estimatedDeliverySeconds

number

documents.ultimateBeneficialOwnersCertificate.url

string

documents.ultimateBeneficialOwnersCertificate.blobName

string

documents.ultimateBeneficialOwnersCertificate.price

number

Fixed price in cents

documents.ultimateBeneficialOwnersCertificate.priceMarkup

number

Price markup percentage

documents.ultimateBeneficialOwnersCertificate.date

string

documents.lastFiscalYearFinancialStatement

object

required

Show child attributes

documents.lastFiscalYearFinancialStatement.id

string

required

documents.lastFiscalYearFinancialStatement.name

string

required

Document name in the local language of the country where it was issued

documents.lastFiscalYearFinancialStatement.format

string

required

documents.lastFiscalYearFinancialStatement.description

string

Document description in English

documents.lastFiscalYearFinancialStatement.estimatedDeliverySeconds

number

documents.lastFiscalYearFinancialStatement.url

string

documents.lastFiscalYearFinancialStatement.blobName

string

documents.lastFiscalYearFinancialStatement.price

number

Fixed price in cents

documents.lastFiscalYearFinancialStatement.priceMarkup

number

Price markup percentage

documents.lastFiscalYearFinancialStatement.date

string

documents.officialPublications

object[]

Show child attributes

documents.officialPublications.id

string

required

documents.officialPublications.name

string

required

Document name in the local language of the country where it was issued

documents.officialPublications.format

string

required

documents.officialPublications.description

string

Document description in English

documents.officialPublications.estimatedDeliverySeconds

number

documents.officialPublications.url

string

documents.officialPublications.blobName

string

documents.officialPublications.price

number

Fixed price in cents

documents.officialPublications.priceMarkup

number

Price markup percentage

documents.officialPublications.date

string

documents.otherDocuments

object[]

Show child attributes

documents.otherDocuments.id

string

required

documents.otherDocuments.name

string

required

Document name in the local language of the country where it was issued

documents.otherDocuments.format

string

required

documents.otherDocuments.description

string

Document description in English

documents.otherDocuments.estimatedDeliverySeconds

number

documents.otherDocuments.url

string

documents.otherDocuments.blobName

string

documents.otherDocuments.price

number

Fixed price in cents

documents.otherDocuments.priceMarkup

number

Price markup percentage

documents.otherDocuments.date

string

companyRelationships

object[]

Show child attributes

companyRelationships.relation

enum<string>

required

Available options:

mergedFrom,

mergedInto,

acquired,

acquiredBy,

demergedFrom,

demergedTo,

spunOffFrom,

spunOffTo,

assetTransferFrom,

assetTransferTo,

other

companyRelationships.company

object

required

Show child attributes

companyRelationships.company.id

string

required

The id of the company, see documentation.

Example:

"932884117"

companyRelationships.company.countryCode

enum<string>

required

The ISO 3166-1 alpha-2 country code of the company registration country

Available options:

AF,

AX,

AL,

DZ,

AS,

AD,

AO,

AI,

AQ,

AG,

AR,

AM,

AW,

AU,

AT,

AZ,

BS,

BH,

BD,

BB,

BY,

BE,

BZ,

BJ,

BM,

BT,

BO,

BQ,

BA,

BW,

BV,

BR,

IO,

BN,

BG,

BF,

BI,

KH,

CM,

CA,

CV,

KY,

CF,

TD,

CL,

CN,

CX,

CC,

CO,

KM,

CG,

CD,

CK,

CR,

CI,

HR,

CU,

CW,

CY,

CZ,

DK,

DJ,

DM,

DO,

EC,

EG,

SV,

GQ,

ER,

EE,

ET,

FK,

FO,

FJ,

FI,

FR,

GF,

PF,

TF,

GA,

GM,

GE,

DE,

GH,

GI,

GR,

GL,

GD,

GP,

GU,

GT,

GG,

GN,

GW,

GY,

HT,

HM,

VA,

HN,

HK,

HU,

IS,

IN,

ID,

IR,

IQ,

IE,

IM,

IL,

IT,

JM,

JP,

JE,

JO,

KZ,

KE,

KI,

KR,

KP,

KW,

KG,

LA,

LV,

LB,

LS,

LR,

LY,

LI,

LT,

LU,

MO,

MK,

MG,

MW,

MY,

MV,

ML,

MT,

MH,

MQ,

MR,

MU,

YT,

MX,

FM,

MD,

MC,

MN,

ME,

MS,

MA,

MZ,

MM,

NA,

NR,

NP,

NL,

NC,

NZ,

NI,

NE,

NG,

NU,

NF,

MP,

NO,

OM,

PK,

PW,

PS,

PA,

PG,

PY,

PE,

PH,

PN,

PL,

PT,

PR,

QA,

RE,

RO,

RU,

RW,

BL,

SH,

KN,

LC,

MF,

PM,

VC,

WS,

SM,

ST,

SA,

SN,

RS,

SC,

SL,

SG,

SX,

SK,

SI,

SB,

SO,

ZA,

GS,

SS,

ES,

LK,

SD,

SR,

SJ,

SZ,

SE,

CH,

SY,

TW,

TJ,

TZ,

TH,

TL,

TG,

TK,

TO,

TT,

TN,

TR,

TM,

TC,

TV,

UG,

UA,

AE,

GB,

US,

UM,

UY,

UZ,

VU,

VE,

VN,

VG,

VI,

WF,

EH,

YE,

ZM,

ZW,

TEST

Example:

"FR"

companyRelationships.company.identifiers

object

A dictionary of different identifiers for the company

Show child attributes

companyRelationships.company.identifiers.{key}

string

Example:

{
  "SIREN": "932884117",
  "VAT": "FR42932884117"
}

companyRelationships.company.legalName

string

The legal name of the company.

Example:

"Topograph"

companyRelationships.company.legalNameInEnglish

string

Example:

"Test Display Hong Kong Trading Limited"

companyRelationships.company.commercialNames

string[]

An array of commercial names or trading names used by the company.

Example:

["Topograph", "TopographHQ"]

companyRelationships.company.legacyLegalNames

string[]

An array of legacy legal names used by the company.

Example:

["Semaphore", "SemaphoreHQ"]

companyRelationships.company.legacyCommercialNames

string[]

An array of legacy commercial names used by the company.

Example:

["Semaphore", "SemaphoreHQ"]

companyRelationships.company.status

object

The status of the company, including local status and whether it is active.

Show child attributes

companyRelationships.company.status.localName

string

required

The local status of the company in the local language

Example:

"active"

companyRelationships.company.status.active

boolean

Indicates if the company is active.

Example:

true

companyRelationships.company.status.statusDetailsBeta

object

Detailed status information including closure reasons and dates

Show child attributes

companyRelationships.company.status.statusDetailsBeta.status

enum<string>

required

The standardized status of the company

Available options:

ACTIVE,

UNDER_INSOLVENCY_PROCEEDING,

CLOSED,

UNKNOWN

Example:

"ACTIVE"

companyRelationships.company.status.statusDetailsBeta.closureReason

enum<string>

The reason for company closure, if applicable

Available options:

BANKRUPTCY,

LIQUIDATION,

MERGER,

ACQUISITION,

VOLUNTARY_DISSOLUTION,

ADMINISTRATIVE_DISSOLUTION,

COURT_ORDER,

OTHER,

UNKNOWN

Example:

"BANKRUPTCY"

companyRelationships.company.status.statusDetailsBeta.closureDate

string

The date when the company was closed, if applicable

Example:

"2024-01-15"

companyRelationships.company.status.statusDetailsBeta.insolvencyStartDate

string

The date when insolvency proceedings started, if applicable

Example:

"2023-12-01"

companyRelationships.company.status.statusDetailsBeta.additionalInfo

string

Additional information about the status

Example:

"Company entered voluntary liquidation due to retirement of owner"

companyRelationships.company.registrationDate

string

The registration date of the company with the trade register or other authorities.

Example:

"2024-04-22"

companyRelationships.company.incorporationDate

string

Example:

"2024-04-15"

companyRelationships.company.legalForm

object

The legal form of the company, including local and standard forms.

Show child attributes

companyRelationships.company.legalForm.localName

string

The local legal form of the company, in the local language

Example:

"EURL, entreprise unipersonnelle à responsabilité limitée"

companyRelationships.company.legalForm.englishTranslation

string

The English translation of the local legal form.

Example:

"Single Member Limited Liability Company"

companyRelationships.company.legalForm.semaphoreStandard

enum<string>

deprecated

The standardized legal form of the company.

Available options:

Sole Proprietorship,

Partnership,

Limited Liability Company,

Corporation,

Nonprofit Organization,

Cooperative,

Government-Owned Entity,

Branch or Representative Office,

Trust,

Other

Example:

"Limited Liability Company"

companyRelationships.company.legalForm.standardized

enum<string>

The standardized legal form of the company.

Available options:

Sole Proprietorship,

Partnership,

Limited Liability Company,

Corporation,

Nonprofit Organization,

Cooperative,

Government-Owned Entity,

Branch or Representative Office,

Trust,

Other

Example:

"Limited Liability Company"

companyRelationships.company.legalForm.iso20275Code

string

The ISO 20275 Entity Legal Form code for the company.

Example:

"F8DD"

companyRelationships.company.capital

object

The share capital of the company.

Show child attributes

companyRelationships.company.capital.amount

number

required

The numeric amount of money.

Example:

1000

companyRelationships.company.capital.currency

string

required

The ISO 4217 currency code (e.g., EUR, USD).

Example:

"EUR"

companyRelationships.company.capital.formatted

string

required

Formatted string representation of the monetary amount in the local format

Example:

"1000.00 €"

companyRelationships.company.activities

object

A dictionary of activity classifications

Show child attributes

companyRelationships.company.activities.{key}

object[]

Show child attributes

companyRelationships.company.activities.{key}.code

string

required

The activity code

Example:

"62.01"

companyRelationships.company.activities.{key}.description

string

required

The description of the activity

Example:

"Computer programming activities"

companyRelationships.company.activities.{key}.isAIInferred

boolean

required

Indicates whether the activity code comes from an official source or has been inferred by AI

Example:

true

Example:

{
  "NACE": [
    {
      "code": "62.01",
      "description": "Computer programming activities"
    }
  ],
  "ISIC": [
    {
      "code": "J620",
      "description": "Computer programming, consultancy and related activities"
    }
  ]
}

companyRelationships.company.activityDescription

string

A text description of the company activities

Example:

"Development of software solutions and IT consulting services"

companyRelationships.company.legalAddress

object

The address of the company.

Show child attributes

companyRelationships.company.legalAddress.addressLine1

string

required

First line of the address

Example:

"10 rue de la Fraternité"

companyRelationships.company.legalAddress.city

string

required

City of the address

Example:

"Bagnolet"

companyRelationships.company.legalAddress.postalCode

string

required

Postal code of the address

Example:

"93170"

companyRelationships.company.legalAddress.region

string

required

Region of the address

Example:

"FR"

companyRelationships.company.legalAddress.countryCode

string

required

Country of the address using ISO 3166-1 alpha-2 country code

Example:

"FR"

companyRelationships.company.legalAddress.state

string

required

State of the address

Example:

"Île-de-France"

companyRelationships.company.legalAddress.addressLine2

string

Second line of the address

Example:

"Topograph Building"

companyRelationships.company.legalAddress.poBox

string

Post Office Box number

Example:

"PO Box 123"

companyRelationships.company.legalAddress.careOf

string

Care of (c/o) recipient

Example:

"c/o John Doe"

companyRelationships.company.phones

string[]

An array of phone numbers for the company in E.164 format (e.g., +33123456789 for France, +1234567890 for USA).

Example:

["+33123456789", "+33987654321"]

companyRelationships.company.website

string

The official website URL of the company.

Example:

"https://www.example.com"

companyRelationships.company.employeeCount

object

The employee count information for the company.

Show child attributes

companyRelationships.company.employeeCount.exact

number

The exact number of employees, if known

Example:

150

companyRelationships.company.employeeCount.min

number

The minimum number of employees in a range

Example:

100

companyRelationships.company.employeeCount.max

number

The maximum number of employees in a range

Example:

200

companyRelationships.company.employeeCount.lastUpdated

string

The date when the employee count was last updated

Example:

"2024-03-15"

companyRelationships.company.employeeCount.isEstimate

boolean

Indicates if the employee count is an estimate

Example:

false

companyRelationships.effectiveDate

string

Legal effective date if known (YYYY-MM-DD)

companyRelationships.description

string

Search

Data

Pricing

Monitors

Get Onboarding Data

Authorizations

Headers

Body

Response