Skip to main content
PATCH
Update a shareholder relation

Authorizations

X-API-Key
string
header
required

Your API key is available in the Production and Sandbox dashboards.

Path Parameters

shareholderId
string<uuid>
required

The shareholder ID

relationId
string<uuid>
required

The relation ID

Body

application/json
shares
number<float>
required

Updated number of shares represented by the relation

Required range: x >= 0.01
Example:

1500.5

Response

Shareholder Relation updated successfully

id
string<uuid>
required

Unique shareholder relation ID

Example:

"82cd9012-3456-7890-abcd-ef1234567890"

Entity connected to this shareholder relation

Example:

"/entities/91ab5678-1234-5678-9abc-def012345678"

shareholder
object
required

Shareholder connected by this relation

relationType
enum<string>
required

Direction of the ownership relation between the shareholder and entity

Available options:
shareholders,
shareholder_of
Example:

"shareholders"

sources
object[]
required

Sources that support this shareholder relation

shares
number<float>
required

Number of shares represented by this relation

Example:

1500.5

totalShares
number<float> | null
required

Total number of shares in the company, when known

Example:

10000

ownership
number<float> | null
required

Ownership ratio as a decimal value, for example 0.15 means 15%

Example:

0.15

createdAt
string
required

Date and time the resource was created

Example:

"2020-01-01T12:15:00.000Z"

updatedAt
string
required

Date and time the resource was last updated

Example:

"2020-01-01T12:15:00.000Z"

@id
string<iri-reference>

ShareholderRelation IRI reference

Example:

"/shareholders/91ab5678-1234-5678-9abc-def012345678/relations/82cd9012-3456-7890-abcd-ef1234567890"

@type
string
default:ShareholderRelation