Skip to main content
GET
Retrieve a shareholder relation source

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

sourceId
string<uuid>
required

The source ID

Response

Shareholder Relation Source

id
string<uuid>
required

Unique shareholder relation source ID

Example:

"73de0123-4567-8901-bcde-f23456789012"

relation
object
required

Shareholder relation supported by this source

shareholder
object
required

Shareholder described by this source

sourceName
enum<string>
required

Source that provided the shareholder information

Available options:
manual,
rpc_socio,
company_verification
Example:

"manual"

sourceId
string<uuid>
required

ID of the source record that provided this information

Example:

"64ef1234-5678-9012-cdef-345678901234"

shares
number<float>
required

Number of shares reported by this source

Example:

1500.5

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>

ShareholderRelationsSource IRI reference

Example:

"/shareholders/91ab5678-1234-5678-9abc-def012345678/relations/82cd9012-3456-7890-abcd-ef1234567890/sources/73de0123-4567-8901-bcde-f23456789012"

@type
string
default:ShareholderRelationsSource