Skip to main content

The register's current view of the subject's beneficial ownership. The subject is the company or legal arrangement the profile describes. Delivered by GET /v2/orders/{orderId}/download once the order's status is Success; both order endpoints belong to the Company V2 API. Throughout the profile, an omitted property means the same as that property with a null value; the one exception is heldAs, which means Self when omitted. Enumerated values can grow as registers are added, so treat a value you don't recognise as unknown rather than as an error.

_payloadType
enum<string>
required

Discriminator field identifying the payload schema. Always BOProfile_v2. Used to deserialize polymorphic payloads returned by GET /v2/orders/{orderId}/download.

Available options:
BOProfile_v2
subject
Subject · object
required

The entity or arrangement this profile is about. Not necessarily a company: a trust or other legal arrangement can be a subject too.

registryInfo
BORegistryInfo · object
required

Information about the BO registry and data currency

interestedParties
Party · object[]
required

Every party the register declares as holding an interest in the subject, as one flat list. A party appears exactly once, carrying all of its interests.

schemaVersion
string

Version of the profile schema this profile follows, as a semantic version (major.minor.patch). _payloadType identifies the payload family and stays BOProfile_v2. The API reference's own version number describes the documentation of the whole API, not an individual profile.

Example:

"1.0.0"

registerStatements
Statement · object[] | null

Statements the register makes about this subject's beneficial ownership declaration, distinct from the declaration itself. Present alongside interestedParties, not instead of it.