API product catalogCorporate Actions & Shareholder Governance

Get record-date corporate-action entitlement

Corporate Actions & Shareholder Governance

GET

/users/{userId}/corporate-actions/{actionId}/entitlement

Sandbox availablegetCorporateActionEntitlement

Parameters

userIdstringpathRequired

actionIdstringpathRequired

Headers

AuthorizationstringRequired

Bearer sk_sandbox_<your_key> for sandbox requests.

Response fields

corporateActionIdstring

eligibleboolean

entitlementobject | null

electionunion

Response codes

200Eligibility, eligible units, election, and custodian evidence.

Sandbox playground

Read-only sandbox request

userId Required · pathactionId Required · pathSandbox API keyYour key stays in this page’s memory.

https://mystocks.africa/api/sandbox/v1/partner/users/%7BuserId%7D/corporate-actions/%7BactionId%7D/entitlement

Open in API Tester API Reference

Response schema

{
  "type": "object",
  "properties": {
    "corporateActionId": {
      "type": "string"
    },
    "eligible": {
      "type": "boolean"
    },
    "entitlement": {
      "type": [
        "object",
        "null"
      ]
    },
    "election": {
      "anyOf": [
        {
          "type": "object",
          "properties": {
            "status": {
              "type": "string",
              "enum": [
                "PENDING_CUSTODIAN",
                "ACCEPTED",
                "REJECTED"
              ]
            },
            "revision": {
              "type": "integer",
              "minimum": 1
            },
            "submittedAt": {
              "type": [
                "string",
                "null"
              ],
              "format": "date-time"
            },
            "amendedAt": {
              "type": [
                "string",
                "null"
              ],
              "format": "date-time"
            },
            "custodianReference": {
              "type": [
                "string",
                "null"
              ]
            },
            "custodianReason": {
              "type": [
                "string",
                "null"
              ]
            },
            "acceptedAt": {
              "type": [
                "string",
                "null"
              ],
              "format": "date-time"
            },
            "confirmationDocumentUrl": {
              "type": [
                "string",
                "null"
              ],
              "format": "uri"
            }
          }
        },
        {
          "type": "null"
        }
      ]
    }
  }
}

curl -X GET 'https://mystocks.africa/api/sandbox/v1/partner/users/%7BuserId%7D/corporate-actions/%7BactionId%7D/entitlement' \
  -H "Authorization: Bearer $MYSTOCKS_SANDBOX_API_KEY"

POST /users/{userId}/corporate-actions/{actionId}/elections

GET /users/{userId}/shareholder-meetings/{meetingId}/ballot