Introduction

Welcome to the IDM Public API documentation webpage, where we guide you through harnessing the power of IDM Public APIs to seamlessly integrate data between your Client's CRM system and Anduin's Investor Data Management (IDM) application.

This page serves as a guide, leading you through the primary components you will engage with using REST API.

Leveraging our public APIs enables the automation of crucial tasks:

Monitor investor data, including investment entities, contacts, documents and profile
Create Fund Subscription orders using IDM data from your CRM system or sync IDM updates to your CRM (See Supported workflow)

Data models

The following graph displays the data models of IDM:

Firm

Represents your organization on Anduin IDM.

Field Name	Field Description	Data Type
id	The system-generated ID provided at creation	String
name	The name of the Firm	String

Client group

Represents categorized groups of investors.

Field Name	Field Description	Data Type
id	The system-generated ID provided at creation	String
name	The name of the Client Group	String

Client

Represents an investor in IDM. A client can have multiple Investment Entities (IEs).

Field Name	Field Description	Data Type
id	The system-generated ID provided at the creation	String
name	The name of the Client	String
trackingId	The custom unique ID set by the user	String
tags	The user-generated tags of the Client	String
clientGroupId	The ID of the client group that the Client belongs to in IDM	String
note	The user-generated note about the Client	String

Investment Entity (IE)

Represent an investment vehicle of an Investor (Client). Each IE will contain a profile, a list of AML/KYC documents, and a list of contacts.

Field Name	Field Description	Data Type
id	The system-generated ID provided at creation	String
trackingId	The custom unique ID set by the user	String
name	The name of the Investment Entity	String
jurisdiction	The jurisdiction of the Investment Entity	String
amlKycStatus	AML/KYC compliance status	String
type	The type of the Investment Entity	String
riskLevel	The risk level of the Investment Entity	String
note	The user-generated note about the IE	String

Profile

Stores profile data for an investment entity. Each IE has one profile. Each Firm has a profile structure applied across all its investment entities, but IDM supports custom templates so you can map the data structure with your own system.

Field Name	Field Description	Data Type
investmentEntityId	The system-generated ID provided at creation	String
investmentEntityTrackingId	The custom unique ID of the IE that owns the profile	String
data	The data fields captured from the profile template.	Object

Document

Stores documents related to an investment entity, such as legal or compliance files.

Field Name	Field Description	Data Type
id	The system-generated ID provided at creation	String
name	The name of the Document	String
documentType	The type of the Document	String
note	Notes about the Document	String
signedAt	Date the Document was signed	Date
expiredAt	Expiration date of the Document	Date

Contact

A contact of the Firm, representing a contact point associated with an investor or a prospect.

Field Name	Field Description	Data Type
id	The system-generated ID provided at creation	String
trackingId	The unique ID set by the user	String
firstName	First name of the contact	String
lastName	Last name of the contact	String
prefix	Prefix of the contact (e.g., Mr., Ms., Dr.)	String
suffix	Suffix of the contact (e.g., Jr., Sr.)	String
email	Email of the contact	String
phone	Phone number of the contact	String
country	A part of the contact's street address: Country	String
numberAndStreet	A part of the contact's street address: Number and Street	String
city	A part of the contact's street address: City	String
state	A part of the contact's street address: State	String
zipCode	A part of the contact's street address: Zip Code	String
company	Company of the contact	String
title	Title of the contact	String
note	Notes about the contact	String
assignedClients	Clients assigned to this contact. This includes the Contact's Client-Level Permissions.	List[Object]
assignedInvestmentEntities	Investment Entities related to this contact. This includes the Contact's IE-Level Permission	List[Object]

Contact's Client-Level Permissions

Defines the permissions a contact has when associated with specific clients, including whether they receive invitations, document requests, and access to investor profiles.

Field Name	Field Description	Data Type
id	The system-generated ID of the client that is assigned to the contact	String
receiveInvitationEmail	Indicates whether the contact is pre-filled as a recipient for FundSub invitation emails.	String
receiveDocumentRequest	Indicates if the contact is pre-filled as a recipient for document request notifications	String
profileAccess	Indicates if the client has access to the Client's IE profiles	String

Contact's IE-Level Permission

Defines the permissions a contact has when associated with specific IEs, including whether they receive invitations, document requests, and access to investor profiles.

Field Name	Field Description	Data Type
id	The system-generated ID of the IE that is assigned to the contact	String
receiveInvitationEmail	Indicates whether the contact is pre-filled as a recipient for FundSub invitation emails.	String
receiveDocumentRequest	Indicates if the contact is pre-filled as a recipient for document request notifications	String
profileAccess	Indicates if the client has access to the IE profile	String

Key Concepts