Corporate Actions
Download SpecAll Corporate Action related paths.
Corporate action events
id
string
uuid
required
Event unique identifier
created_at
string
date-time
required
Date and time when the event was created. RFC 3339-5, ISO8601 UTC
type
string
required
Event type
- Enum
-
- CORPORATE_ACTION.UPDATED
object
object (object)
required
Object representing corporate action and its related processing status
id
string
uuid
required
Unique internal identifier assigned to a corporate action by Upvest
instrument
object (instrument)
required
Entity representing financial instrument
uuid
string
uuid
String representing instrument internal identifier
isin
string
^[A-Z]{2}[A-Z0-9]{9}[0-9]$
International securities identification number defined by ISO 6166.
name
string
String representing name of the instrument
iso_type
string
required
The identifier of a corporate action type ISO Code
name
string
Name of the corporate action type
mandatory_voluntary_indicator
string
Indicates whether a corporate action is mandatory, voluntary or choosable.
- Default
- "UNSPECIFIED"
- Enum
-
- UNSPECIFIED
- MANDATORY
- VOLUNTARY
- CHOOSABLE
announcement_status
string
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_message
string
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_date
string
date
Date on which a company announces a corporate event. RFC 3339-5, ISO8601 UTC
ex_date
string
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_date
string
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
options
array[object (Option)]
Available corporate action options.
Option
object (Option)
Corporate action option.
option_number
string
Number to identify the available options for corporate actions.
option_type
string
Type of option based on ISO CAOP.
- Default
- "UNSPECIFIED"
- Enum
-
- UNSPECIFIED
- ABSTAIN
- VOTE_AGAINST_MANAGEMENT
- BENEFICIAL_OWNER_BREAKDOWN_REQUEST
- BONUS_SHARE_PLAN
- BUY_UP
- CASH_AND_SECURITIES
- CASH
- CONSENT_AND_EXCHANGE
- CONSENT_DENIED
- CONSENT_GRANTED
- CONSENT_AND_TENDER
- EXERCISE
- LAPSE
- VOTE_WITH_MANAGEMENT
- RETAIN
- NO_ACTION
- NON_QUALIFIED_INVESTOR
- PROPOSED_RATE
- OTHER
- OVERSUBSCRIBE
- PROXY_CARD
- UNKNOWN_PROCEEDS
- QUALIFIED_INVESTOR
- SECURITIES_OPTION
- SELL_ENTITLEMENT
- SPLIT_INSTRUCTION
option_details
object (option_details)
Details of the corporate action option.
default_option
string
Indicates whether the option is the default option.
- Enum
-
- TRUE
- FALSE
movements
array[object (Movement)]
Movements in corporate action option.
Movement
object (Movement)
Movement information for corporate action option.
movement_type
string
Type of the movement.
- Default
- "UNSPECIFIED"
- Enum
-
- UNSPECIFIED
- CASH
- SECURITIES_OPTION
movement_details
object (movement_details)
Details of the movement.
credit_debit_factor
string
Indicates whether the movement is a credit or a debit.
- Default
- "UNSPECIFIED"
- Enum
-
- UNSPECIFIED
- CREDIT
- DEBIT
payment_date
string
date
Date on which the movement is due to take place (cash and/or securities). RFC 3339-5, ISO8601 UTC
gross_dividend
string
Stringised value that represents an amount of money.
withholding_tax
string
Withholding tax rate.
currency
string
Alphabetic three-letter ISO 4217 currency code.
- EUR - Euro
- Default
- "EUR"
- Enum
-
- EUR
webhook_id
string
uuid
required
Webhook unique identifier.
Request
{
"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
Request has been processed successfully.
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
No schema
Was this page helpful?