Public API changes - September 2025
7 days ago
š 1. Release Notes
[FundSub] Allow fetching collaboratorsā company info during order creation
- Summary: Customers can fetch collaboratorsā company details (ID and name) when creating an order. Note: The CS team must enable the switch āEnable Organization Field when inviting collaboratorsā in the admin tool before this feature becomes available.
- Area of impact:
- Released date: September 9, 2025
- Specs: collaboratorOrgs ā array of objects in body params
organizationId
ā string ā custom ID of the organizationorganizationName
ā string ā name of the organization
[FundSub] Retrieve collaboratorsā company info in order workflow data
- Summary: Customers can use the API to retrieve collaboratorsā company ID as part of order workflow data.
- Area of impact: FS API
- Released date: September 9, 2025
- Specs: collaboratorOrganizationInfo ā object
organizationId
- string: Custom ID of the collaboratorās organization
[FundSub] Allow sending a custom email to the main investor or collaborators of an order.
- Summary: We introduce a flexible email API that lets customers send custom reminder or invite emails when they choose.
- Area of impact: New FS API
- Released date: September 23, 2025
- Customizable Areas
- When fund managers send a custom email to investors or collaborators using this API, they can configure the following:
Subject - string:
The subject line of the email.Message - string
: The body content of the email.CTA Button - object:
A call-to-action element, with the option to set the button label (string).
- When fund managers send a custom email to investors or collaborators using this API, they can configure the following:
The CTA button will redirect investors and collaborators to the specific subscription defined by the order-id
provided in the API path parameter.
[IDM] New Contact APIs to retrieve contacts by client or investment entity
- Summary: Customers can now retrieve the list of contacts assigned to a specific client or investment entity.
- Area of impact: New contact APIs
- Released: September 5th, 2025
[IDM] Grant/update contactās permission when assigned to client or investment entity
- Summary: When assigning a contact to a client or investment entity, customers can now:
- Grant profile access permissions
- Allow document request permissions
- Trigger invitation emails for the contact
- Area of impact: Updated Contact APIs
- Released date: September 5th, 2025
- Specs:
- Assign contact to client: New body params
receiveInvitationEmail
- string: Indicate whether the contact should receive invitation emails for this client and investment entities.receiveDocumentRequest
- string: Indicate whether the contact should receive document requests for this client and investment entities.profileAccess
- string: Indicate whether the contact should have access to the profile of investment entities of this client.
- Assign contact to investment entity: New body params
-
profileAccess
- string: Indicates whether the contact should have access to the profile of this investment entity.If this setting is already defined at the Client level, attempting to set it at the Investment Entity level will result in an error.
-
[IDM] Allow lookup of contacts by email
- Summary: Customers can now look up contacts by email using the list contacts API
- Area of impact: Update contact APIs
- Released date: September 11th, 2025
- Specs:
- New query parameter in List contacts APIs
- email: string - The unique, case-insensitive email address used to look up a specific contact.
- New query parameter in List contacts APIs
[IDM] Add AML/KYC status to investment entity object
- Summary: Add new AML/KYC status to investment entity object
- Area of impact: Investment entity APIs:
- Released date: September 30th, 2025
- Specs:
New field in Investment entity object:
- amlKycStatus: string - AML/KYC status of the investment entity. You can retrieve and modify the list of AML/KYC statuses in the firm setting.
- [IDM] New webhook events: Fund subscription order linked/unlinked
-
Summary: Add two new webhook events to notify when a fund subscription order is linked to/unlinked from an investment entity
-
Area of impact: IDM webhook
-
Released: September 30th, 2025
-
Specs:
When a fund subscription order is linked to an investment entity:
{ "event": "funddata.order.investment_entity.linked", "createdAt": "2025-09-04T08:04:20.237994Z", "firmId": "fdfmjw061ynko36o", // ID of the firm "fundId": "txnre92r2p4xylno.fsb4833", // ID of the FS "id": "txnre92r2p4xylno.fsb4833.lppzgd0j4l" // ID of the FS order }
When a fund subscription order is unlinked from an investment entity:
{ "event": "funddata.order.investment_entity.unlinked", "createdAt": "2025-09-04T08:04:20.237994Z", "firmId": "fdfmjw061ynko36o", // ID of the firm "fundId": "txnre92r2p4xylno.fsb4833", // ID of the FS "id": "txnre92r2p4xylno.fsb4833.lppzgd0j4l" // ID of the FS order }
-
[IDM] New orders API: Get order
- Summary: Add a new API to retrieve a single order object.
- Area of impact: IDM order APIs
- Released date: September 30th, 2025
[DataRoom] Webhook Event: Group Created/Deleted
- Summary: This new webhook event allows a client's endpoint to be notified whenever a new group is created or an existing group is deleted within a registered dataroom.
- Area of impact: New events for dataroom webhook
- Released date: September 9, 2025
- Specs
- A new group is created
{ "event": "dataroom.group.created", "createdAt": "2025-08-28T09:34:47.566289Z", "dataRoomId": "txn2kq9qdw2kq5d1.dtrk31v", "groupId": "txn2kq9qdw2kq5d1.dtrk31v.drg4xzlwr" }
- An existing group is removed
{ "event": "dataroom.group.deleted", "createdAt": "2025-08-28T09:34:54.738103Z", "dataRoomId": "txn2kq9qdw2kq5d1.dtrk31v", "groupId": "txn2kq9qdw2kq5d1.dtrk31v.drg4xzlwr" }
š ļø 2. Planned Items
[IDM] Retire IDM legacy webhooks
- Summary: We will retire the legacy webhooks of IDM by March 31st, 2026. Please use the new webhook instead.
- Area of impact: legacy webhook APIs
- ETA: March 31st, 2026