Skip to main content
GET
Get a corporate action

Authorizations

Authorization
string
header
required

OAuth 2.0 client credentials. Exchange the client id and secret Securitize issued you for a bearer token at the token URL, with grant_type=client_credentials; the token lasts 2 hours and goes in the Authorization: Bearer header of every request. No scope is needed.

Path Parameters

sourceCaId
string
required

The corporate action's id. Stable for its whole lifecycle.

Pattern: ^ca_[0-9A-HJKMNP-TV-Z]{26}$

Response

The latest version.

A corporate action as the endpoints return it. The same object travels in the data of its events, plus the stream's tokenId there.

sourceCaId
string
required

Stable for the whole lifecycle, through corrections, postponements and cancellation.

Example:

"ca_01K7Q3ZVB8M2N4P6R8T0V2X4Z6"

version
integer
required

From 1; one more on every change.

Required range: x >= 1
assetId
string
required
Example:

"c0a8e2f4-1b3d-4e5f-8a9b-0c1d2e3f4a5b"

caType
enum<string>
required

The kind of corporate action. Treat a value you do not know as informational.

Available options:
CASH_DIVIDEND,
SPECIAL_DIVIDEND,
RETURN_OF_CAPITAL,
STOCK_SPLIT,
REVERSE_SPLIT,
STOCK_DIVIDEND,
SPIN_OFF,
MERGER,
LIQUIDATION,
DELISTING,
NAME_OR_IDENTIFIER_CHANGE,
DIVIDEND_OPTION,
TENDER_OFFER,
EXCHANGE_OFFER,
RIGHTS_ISSUE,
WARRANT_EXERCISE,
APPRAISAL,
MEETING,
CONSENT,
IST_CONVERSION
caCategory
enum<string>
required
Available options:
MANDATORY,
MANDATORY_WITH_OPTIONS,
VOLUNTARY
status
enum<string>
required
Available options:
ANNOUNCED,
CONFIRMED,
ELECTION_OPEN,
ENTITLEMENTS_FIXED,
SETTLING,
COMPLETED,
POSTPONED,
CANCELLED
dataCompleteness
enum<string>
required

PRELIMINARY: some terms are not known yet and are null.

Available options:
PRELIMINARY,
COMPLETE
dates
object
required

Every key is always present; null when not applicable or not known yet. Market dates are YYYY-MM-DD on the New York calendar; instants are ISO 8601 UTC.

terms
object
required

Type-specific terms. Amounts are decimal strings. For cash distributions and splits every key is present, null when not known.

Example:
options
object[]
required

Holder options. Empty for mandatory corporate actions.

venueActions
object
required

What the venue needs to do, so you never infer it from the type. Keys appear when relevant.

Linked corporate actions, for example a merger and its appraisal option.

documents
object[]
required

The holder notice and issuer materials.

isoEventCode
string | null

Indicative ISO 15022 event code.

Example:

"DVCA"

supersedesCaId
string | null

The corporate action this one replaces.

supersededByCaId
string | null

The corporate action that replaced this one.

correctionReason
string | null

On a ca.action.corrected version.

cancellationReason
string | null

On a ca.action.cancelled version.

description
string | null
Example:

"Quarterly cash dividend of USD 0.26 per share"

settlement
object | null

On a COMPLETED corporate action. Aggregate figures for the asset only; individual payments are read on chain.