Skip to content
API Reference/Corporate Actions/
Corporate action events

Upvest Investment API (1.75.0)

Upvest Investment API.

Download OpenAPI description
api.json
api.yaml
Overview
URL

https://docs.upvest.co

Upvest API Support

api@upvest.co

License

Apache 2.0

Languages
Servers
Sandbox environment

https://sandbox.upvest.co/

Live environment

https://api.upvest.co/

Access Tokens

All authentication related paths.

Operations

Users

All user related paths.

OperationsWebhooks

User Identifiers

All user identifiers related paths.

Operations

User Checks

All user checks related paths.

OperationsWebhooks

Accounts

All accounts related paths

OperationsWebhooks

Account Groups

All account groups related paths

OperationsWebhooks

Tax Residencies

All tax residencies related paths.

Operations

Corporate Actions

All Corporate Action related paths.

Webhooks

Corporate action eventsWebhook

Request

Corporate action events

Bodyapplication/json
idstring(uuid)required

Event unique identifier

created_atstring(date-time)required

Date and time when the event was created. RFC 3339-5, ISO8601 UTC

typestringrequired

Event type

Value"CORPORATE_ACTION.UPDATED"
objectobjectrequired

Object representing corporate action and its related processing status

idstring(uuid)required

Unique internal identifier assigned to a corporate action by Upvest

iso_typestringrequired

The identifier of a corporate action type ISO Code

instrumentobjectrequired

Entity representing the financial instrument.

uuidstring(uuid)

Name of the instrument.

isinstring^[A-Z]{2}[A-Z0-9]{9}[0-9]$

International securities identification number defined by ISO 6166.

namestring

Name of the instrument.

namestring

Name of the corporate action type

currency_denominationstring

Currency in which a financial instrument is currently denominated. ISO.

Default "UNSPECIFIED"
Enum"UNSPECIFIED""EUR""USD""GBP""SEK""JPY""CHF""CNY""AUD""CAD"
mandatory_voluntary_indicatorstring

Indicates whether a corporate action is mandatory, voluntary or choosable.

Default "UNSPECIFIED"
Enum"UNSPECIFIED""MANDATORY""VOLUNTARY""CHOOSABLE"
announcement_statusstring

Indicates the completeness of the announcement of a corporate action ISO.

Default "UNSPECIFIED"
Enum"UNSPECIFIED""COMPLETE""COMPLETE_UNCONFIRMED""WITH_ENTITLEMENT""PRELIMINARY_ANNOUNCEMENT_CONFIRMED""PRELIMINARY_ANNOUNCEMENT_UNCONFIRMED"
function_of_messagestring

The function of the message is specified in this field. More details under ISO definitions.

Default "UNSPECIFIED"
Enum"UNSPECIFIED""ADDITIONAL_BUSINESS_PROCESS""CANCELLATION_ADVICE""NEW""ELIGIBLE_BALANCE_NOTIFICATION""REPLACEMENT""REMINDER""WITHDRAWAL"
announcement_datestring(date)

Date on which a company announces a corporate event. RFC 3339-5, ISO8601 UTC

ex_datestring(date)

The date up to which a particular share is eligible for the upcoming corporate action. If buyers purchase a share on the ex-date, they are not entitled to participate in the upcoming corporate action; but the seller still would be. RFC 3339-5, ISO8601 UTC

record_datestring(date)

Date on which the issuer reviews its records to determine its authorised shareholders. The authorised shareholders are those who are affected by the respective corporate action. RFC 3339-5, ISO8601 UTC

optionsArray of objectsnon-empty

Available corporate action options.

additional_textstring

Provides additional information or specifies in more detail the content of a message.

webhook_idstring(uuid)required

Webhook unique identifier.

application/json
{
  "id": "d0cb44d6-d61f-4272-b0f5-a8c7349b8b9a",
  "created_at": "2024-09-05T12:03:43.201937702Z",
  "type": "CORPORATE_ACTION.UPDATED",
  "object": {
    "id": "b96b1ee7-d491-43eb-b5e4-4833af9c9c2f",
    "instrument": { … },
    "name": "CASH_DIVIDEND",
    "iso_type": "DVCA",
    "currency_denomination": "EUR",
    "mandatory_voluntary_indicator": "MANDATORY",
    "announcement_status": "PRELIMINARY_ANNOUNCEMENT_CONFIRMED",
    "function_of_message": "NEW",
    "announcement_date": "2023-11-09",
    "ex_date": "2023-12-04",
    "record_date": "2023-12-05",
    "options": [ … ]
  },
  "webhook_id": "dbebe0ac-a407-4d43-a404-b8fe846eb691"
}

Responses

Request has been processed successfully.

Tax Exemptions

All tax exemptions related paths

OperationsWebhooks

Tax Collections

All tax collections related paths

Webhooks

Tax Wrappers

All tax wrappers related paths

OperationsWebhooks

Instruments

All instrument related paths.

OperationsWebhooks

Price Data

All price data related paths.

Operations

Orders

All order related paths.

OperationsWebhooks

Portfolios

All portfolios related paths.

Operations

Portfolios Rebalancing

All portfolios rebalancing related paths.

OperationsWebhooks

Savings Plans

All savings plans related paths.

OperationsWebhooks

Liquidations

All accounts liquidations related paths.

OperationsWebhooks

Direct Debits

All direct debits related paths

OperationsWebhooks

Top-ups

All top-ups related paths

OperationsWebhooks

Withdrawals

All withdrawals related paths

OperationsWebhooks

Reference Accounts

All reference account related paths

Operations

Mandates

All direct debit mandates related paths

Operations

Cash Balances

All cash balance related paths

OperationsWebhooks

Positions

All positions related paths.

OperationsWebhooks

Valuations

All valuations related paths.

OperationsWebhooks

Returns

All accounts returns related paths.

OperationsWebhooks

Virtual Cash Balances

All virtual cash balances related paths

OperationsWebhooks

Fees

All fees related paths.

OperationsWebhooks

Fees Configurations

All fees configurations related paths.

Operations

Reports

All reports related paths.

OperationsWebhooks

Treasury Reports

All treasury reports related paths.

Webhooks

Transactions

All transactions related paths.

OperationsWebhooks

Files

All files API related paths.

Operations

Webhook Subscriptions

All webhook subscriptions related paths.

Operations

Virtual Bank Accounts

All virtual bank accounts related paths

OperationsWebhooks

Tests

All test related paths.

Operations