Features
Transactions

Transaction Routes

transactions/issuance/stock

  • Description: Records a stock issuance transaction.
  • Method: POST
  • Parameters (body):
    • issuerId: The ID of the issuer (string).
    • data: The stock issuance data (object with the following fields):
      • stakeholder_id: The ID of the stakeholder (string).
      • stock_class_id: The ID of the stock class (string).
      • quantity: The number of shares issued (string).
      • share_price: The price per share (object with currency and amount).
      • stock_legend_ids: List of stock legend IDs (array of strings).
      • stock_plan_id: The ID of the stock plan (string).
      • vesting_terms_id: The ID of the vesting terms (string).
      • cost_basis: The cost basis (object with currency and amount).
      • issuance_type: The type of issuance (string).
      • comments: Additional comments (array of strings).
      • custom_id: A custom ID for the issuance (string).
      • consideration_text: The consideration text (string).
      • security_law_exemptions: List of security law exemptions (array of strings).

transactions/transfer/stock

  • Description: Records a stock transfer transaction.
  • Method: POST
  • Parameters (body):
    • issuerId: The ID of the issuer (string).
    • data: The stock transfer data (object with the following fields):
      • quantity: The number of shares transferred (string).
      • transferorId: The ID of the transferor stakeholder (string).
      • transfereeId: The ID of the transferee stakeholder (string).
      • stockClassId: The ID of the stock class (string).
      • isBuyerVerified: Whether the buyer is verified (boolean).
      • sharePrice: The price per share (string).

transactions/issuance/equity-compensation

  • Description: Records an equity compensation issuance transaction.
  • Method: POST
  • Parameters (body):
    • issuerId: The ID of the issuer (string).
    • data: The equity compensation issuance data (object with the following fields):
      • stakeholder_id: The ID of the stakeholder (string).
      • stock_class_id: The ID of the stock class (string).
      • quantity: The number of shares issued (string).
      • price_per_share: The price per share (object with currency and amount).
      • vesting_terms_id: The ID of the vesting terms (string).
      • cost_basis: The cost basis (object with currency and amount).
      • issuance_type: The type of issuance (string).
      • comments: Additional comments (array of strings).
      • custom_id: A custom ID for the issuance (string).

transactions/cancel/stock

  • Description: Records a stock cancellation transaction.
  • Method: POST
  • Parameters (body):
    • issuerId: The ID of the issuer (string).
    • data: The stock cancellation data (object with the following fields):
      • stakeholderId: The ID of the stakeholder (string).
      • stockClassId: The ID of the stock class (string).
      • quantity: The number of shares to cancel (string).
      • reason_text: The reason for cancellation (string).
      • comments: Additional comments (array of strings).

transactions/retract/stock

  • Description: Records a stock retraction transaction. Retracts a previously issued stock position.
  • Method: POST
  • Parameters (body):
    • issuerId: The ID of the issuer (string).
    • data: The stock retraction data (object with the following fields):
      • stakeholderId: The ID of the stakeholder (string).
      • stockClassId: The ID of the stock class (string).
      • security_id: The security ID of the position to retract (string).
      • reason_text: The reason for retraction (string).
      • comments: Additional comments (array of strings).

transactions/reissue/stock

  • Description: Records a stock reissuance transaction. Reissues a previously retracted or cancelled stock position.
  • Method: POST
  • Parameters (body):
    • issuerId: The ID of the issuer (string).
    • data: The stock reissuance data (object with the following fields):
      • stakeholderId: The ID of the stakeholder (string).
      • stockClassId: The ID of the stock class (string).
      • resulting_security_ids: List of new security IDs created by the reissuance (array of strings).
      • security_id: The original security ID being reissued (string).
      • comments: Additional comments (array of strings).

transactions/repurchase/stock

  • Description: Records a stock repurchase transaction.
  • Method: POST
  • Parameters (body):
    • issuerId: The ID of the issuer (string).
    • data: The stock repurchase data (object with the following fields):
      • stakeholderId: The ID of the stakeholder (string).
      • stockClassId: The ID of the stock class (string).
      • quantity: The number of shares to repurchase (string).
      • price: The repurchase price per share (object with currency and amount).
      • security_id: The security ID of the position being repurchased (string).
      • comments: Additional comments (array of strings).

transactions/accept/stock

  • Description: Records a stock acceptance transaction. Marks a stock position as accepted by the stakeholder.
  • Method: POST
  • Parameters (body):
    • issuerId: The ID of the issuer (string).
    • data: The stock acceptance data (object with the following fields):
      • stakeholderId: The ID of the stakeholder (string).
      • stockClassId: The ID of the stock class (string).
      • security_id: The security ID of the position being accepted (string).
      • comments: Additional comments (array of strings).

transactions/adjust/issuer/authorized-shares

  • Description: Adjusts the total authorized shares for an issuer.
  • Method: POST
  • Parameters (body):
    • issuerId: The ID of the issuer (string).
    • data: The adjustment data (object with the following fields):
      • issuer_id: The ID of the issuer (string).
      • new_shares_authorized: The new total authorized shares (string).
      • comments: Additional comments (array of strings).

transactions/adjust/stock-class/authorized-shares

  • Description: Adjusts the authorized shares for a specific stock class.
  • Method: POST
  • Parameters (body):
    • issuerId: The ID of the issuer (string).
    • data: The adjustment data (object with the following fields):
      • stockClassId: The ID of the stock class (string).
      • stock_class_id: The OCF stock class ID (string).
      • new_shares_authorized: The new authorized shares for the stock class (string).
      • comments: Additional comments (array of strings).

transactions/issuance/convertible

  • Description: Records a convertible issuance transaction.
  • Method: POST
  • Parameters (body):
    • issuerId: The ID of the issuer (string).
    • data: The convertible issuance data (object with the following fields):
      • security_law_exemptions: List of security law exemptions (array of objects with description and jurisdiction).
      • board_approval_date: The board approval date (string, format: YYYY-MM-DD).
      • stakeholder_id: The ID of the stakeholder (string).
      • consideration_text: The consideration text (string).
      • custom_id: A custom ID for the issuance (string).
      • convertible_type: The type of convertible (string).
      • investment_amount: The investment amount (object with amount and currency).
      • conversion_triggers: List of conversion triggers (array of objects with fields trigger_id, nickname, trigger_description, type, trigger_condition, conversion_right).
      • seniority: The seniority of the convertible (string).
      • pro_rata: The pro rata amount (string).
      • comments: Additional comments (array of strings).
StakeholderHistorical Transactions