API status
  • Corporate Actions

Corporate Actions

All Corporate Action related paths.

webhook

Corporate action events

idstring

required

Event unique identifier

Format
uuid
created_atstring

required

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

Format
date-time
typestring

required

Event type

Enum
  • CORPORATE_ACTION.UPDATED
objectobject (Corporate Action)

required

Object representing corporate action and its related processing status

idstring

required

Unique internal identifier assigned to a corporate action by Upvest

Format
uuid
instrumentobject (Instrument)

required

Entity representing the financial instrument.

iso_typestring

required

The identifier of a corporate action type ISO Code

namestring

Name of the corporate action type

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 on which a company announces a corporate event. RFC 3339-5, ISO8601 UTC

Format
date
ex_datestring

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

Format
date
record_datestring

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

Format
date
optionsarray

Available corporate action options.

webhook_idstring

required

Webhook unique identifier.

Format
uuid

Responses

Request examples

{
  "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": {
      "uuid": "48b798b7-3a62-4f30-8307-ee94d35b21b7",
      "isin": "FR0010524777",
      "name": "Lyxor MSCI New Energy ESG Filtered (DR) ETF"
    },
    "iso_type": "DVCA",
    "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": [
      {
        "option_number": "001",
        "option_type": "CASH",
        "option_details": {
          "default_option": "TRUE"
        },
        "movements": [
          {
            "movement_type": "CASH",
            "movement_details": {
              "credit_debit_indicator": "CREDIT",
              "payment_date": "2023-12-10",
              "gross_dividend": "0.54",
              "withholding_tax": "0.30",
              "currency": "EUR"
            }
          }
        ]
      }
    ]
  },
  "webhook_id": "dbebe0ac-a407-4d43-a404-b8fe846eb691"
}

Response examples

Request has been processed successfully.

Empty response

Was this page helpful?