search
tradevest.ai

v.2.0.0 – Test Environment

2026-03-17 - Planned deployment to Live

2026-03-03 - Test Environment

Major Release Notice: API Version 2.0

Please be advised that this release marks version 2.0 of the Tradevest Partner API. As part of this major update, all endpoints, fields, and features that were previously marked as deprecated have been permanently removed.

This release is backwards incompatible. Partners must ensure their integrations are updated and no longer rely on any deprecated functionality prior to the live deployment date.

Added

Corporate Actions: Retrieval Endpoints

To increase transparency of the corporate action lifecycle and enable partners to independently manage event handling, we have introduced new retrieval endpoints:

  • Get Corporate Action Details: GET /corporate-actions/{corporateActionId}

    • Returns authoritative information about a specific event required for customer decision workflows.

    • Payload includes: corporateActionId, instrumentIdentifier, eventType, importantDates (Ex-Date, Record-Date, Deadline), and available options (if applicable).

  • Get Corporate Actions for Customer: GET /corporate-actions/{customerId}

    • Returns a list of corporate actions applicable to instruments held by the specified customer.

    • Features: Supports historical entries and filtering by date range (date-only precision), corporate action type, and customer ID. Intended for reporting, reconciliation, and customer history presentation.

Corporate Actions: SWIFT Simulator Endpoints

To support integration testing and partner-side validation, we have added SWIFT mock simulation endpoints. (Note: These are subject to change as the simulator evolves).

  • Publish Mock MT564: POST /corporate-actions/swift-mock/publishMT564

    • Simulates a SWIFT MT564 message announcing a future corporate action event to test announcement flows and downstream processing.

  • Publish Mock MT566: POST /corporate-actions/swift-mock/publishMT566

    • Simulates a SWIFT MT566 message triggering the execution of a corporate action to test settlement and booking scenarios.

User Management: MFA Type Exposure

  • Read MFA Type: We have exposed the mfaType field on the GET /users/{id} endpoint.

    • Note: For performance and scalability reasons (to prevent excessive external API calls), this field is intentionally omitted from the bulk GET /users list endpoint.

Changed

Corporate Action Instruction Submission

We have streamlined the endpoint path used to submit customer instructions for corporate actions. There are no changes to the underlying business logic.

  • Previous Path: POST /traditional/corporate-actions/{corporateActionId}/instructions

  • New Path: POST /corporate-actions/{corporateActionId}/instructions

  • Documentation: Moved to API REFERENCE → Trading → Corporate Actions.

Webhook Schema: Corporate Action Notification

  • Added Field: accounts.documentId

  • Details: Included within each object in the accounts array. This enables unambiguous identification of the associated document directly from the corporate action notification webhook.

Last updated