# CorporateActions Handles all Security Token Corporate Actions related functionality ## Hierarchy * Namespace‹[SecurityToken](/polymesh-sdk-api-reference/docs-v5/classes/securitytoken.md)› ↳ **CorporateActions** ## Index ### Properties * [context](/polymesh-sdk-api-reference/docs-v5/classes/corporateactions.md#protected-context) * [distributions](/polymesh-sdk-api-reference/docs-v5/classes/corporateactions.md#distributions) * [parent](/polymesh-sdk-api-reference/docs-v5/classes/corporateactions.md#protected-parent) * [remove](/polymesh-sdk-api-reference/docs-v5/classes/corporateactions.md#remove) * [removeAgent](/polymesh-sdk-api-reference/docs-v5/classes/corporateactions.md#removeagent) * [setAgent](/polymesh-sdk-api-reference/docs-v5/classes/corporateactions.md#setagent) * [setDefaults](/polymesh-sdk-api-reference/docs-v5/classes/corporateactions.md#setdefaults) ### Methods * [getAgent](/polymesh-sdk-api-reference/docs-v5/classes/corporateactions.md#getagent) * [getDefaults](/polymesh-sdk-api-reference/docs-v5/classes/corporateactions.md#getdefaults) ## Properties ### `Protected` context • **context**: [*Context*](/polymesh-sdk-api-reference/docs-v5/classes/context.md) *Inherited from void* *Defined in* [*src/api/entities/Namespace.ts:11*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/api/entities/Namespace.ts#L11) ### distributions • **distributions**: [*Distributions*](/polymesh-sdk-api-reference/docs-v5/classes/distributions.md) *Defined in* [*src/api/entities/SecurityToken/CorporateActions/index.ts:35*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/api/entities/SecurityToken/CorporateActions/index.ts#L35) ### `Protected` parent • **parent**: [*SecurityToken*](/polymesh-sdk-api-reference/docs-v5/classes/securitytoken.md) *Inherited from void* *Defined in* [*src/api/entities/Namespace.ts:9*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/api/entities/Namespace.ts#L9) ### remove • **remove**: *ProcedureMethod‹*[*RemoveCorporateActionParams*](/polymesh-sdk-api-reference/docs-v5/interfaces/removecorporateactionparams.md)*, void›* *Defined in* [*src/api/entities/SecurityToken/CorporateActions/index.ts:109*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/api/entities/SecurityToken/CorporateActions/index.ts#L109) Remove a Corporate Action **`note`** required role: * Corporate Actions Agent ### removeAgent • **removeAgent**: *ProcedureMethod‹void, void›* *Defined in* [*src/api/entities/SecurityToken/CorporateActions/index.ts:101*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/api/entities/SecurityToken/CorporateActions/index.ts#L101) Remove the Corporate Actions Agent of the Security Token **`note`** this action will leave the Security Token owner as the Corporate Actions Agent **`note`** required role: * Security Token Owner ### setAgent • **setAgent**: *ProcedureMethod‹*[*ModifyCorporateActionsAgentParams*](/polymesh-sdk-api-reference/docs-v5/interfaces/modifycorporateactionsagentparams.md)*, void›* *Defined in* [*src/api/entities/SecurityToken/CorporateActions/index.ts:91*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/api/entities/SecurityToken/CorporateActions/index.ts#L91) Assign a new Corporate Actions Agent for the Security Token **`param`** identity to be set as Corporate Actions Agent **`param`** date at which the authorization request to modify the Corporate Actions Agent expires (optional, never expires if a date is not provided) **`note`** this may create AuthorizationRequests which have to be accepted by the corresponding Account. An Account or Identity can fetch its pending Authorization Requests by calling `authorizations.getReceived` **`note`** required role: * Security Token Owner ### setDefaults • **setDefaults**: *ProcedureMethod‹*[*ModifyCaDefaultsParams*](/polymesh-sdk-api-reference/docs-v5/globals.md#modifycadefaultsparams)*, void›* *Defined in* [*src/api/entities/SecurityToken/CorporateActions/index.ts:76*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/api/entities/SecurityToken/CorporateActions/index.ts#L76) Assign default values for targets, global tax withholding percentage and per-identity tax withholding perecentages. **`note`** These values are applied to every Corporate Action that is created until they are modified. Modifying these values does not impact existing Corporate Actions. When creating a Corporate Action, values passed explicitly will override these defaults ## Methods ### getAgent ▸ **getAgent**(): *Promise‹*[*Identity*](/polymesh-sdk-api-reference/docs-v5/classes/identity.md)*›* *Defined in* [*src/api/entities/SecurityToken/CorporateActions/index.ts:114*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/api/entities/SecurityToken/CorporateActions/index.ts#L114) Retrieve the Security Token's Corporate Actions agent **Returns:** *Promise‹*[*Identity*](/polymesh-sdk-api-reference/docs-v5/classes/identity.md)*›* ### getDefaults ▸ **getDefaults**(): *Promise‹*[*CorporateActionDefaults*](/polymesh-sdk-api-reference/docs-v5/interfaces/corporateactiondefaults.md)*›* *Defined in* [*src/api/entities/SecurityToken/CorporateActions/index.ts:146*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/api/entities/SecurityToken/CorporateActions/index.ts#L146) Retrieve default values for targets, global tax withholding percentage and per-identity tax withholding perecentages. **`note`** These values are applied to every Corporate Action that is created until they are modified. Modifying these values does not impact existing Corporate Actions. When creating a Corporate Action, values passed explicitly will override these defaults **Returns:** *Promise‹*[*CorporateActionDefaults*](/polymesh-sdk-api-reference/docs-v5/interfaces/corporateactiondefaults.md)*›* --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/classes/corporateactions.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.