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 (See Supported workflow)

Data models

The following graph displays the data models of IDM:

Client

The Client object 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 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

Investment Entity

An investment vehicle of a Client. Each IE will contain a profile, a list of documents, and a list of contacts.

Field Name	Field Description	Data Type
id	The system-generated ID provided at the creation	String
name	The name of the Investment Entity	String
trackingId	The unique ID set by the user	String
type	The investor type of the Investment Entity	String
jurisdiction	The jurisdiction type of the Investment Entity	String
riskLevel	The risk level of the Investment Entity	String

Contact

A contact of an Investment Entity

Field Name	Field Description	Data Type
id	The system-generated ID provided at the creation	String
firstName	The first name of the contact	String
lastName	The last name of the contact	String
email	The email address of the contact	String
role	The role of the contact	String
contactTypes	The communication type of the contact	List[String]
phone	The phone number of the contact	String

Profile

A list of data points of a particular investment entity

Field Name	Field Description	Data Type
investmentEntityId	The system-generated ID of the investment entity that owns the profile	String
data	The profile data in the format of a map between field name to field value	Map[String, String

Document

A list of data points of a particular investment entity

Field Name	Field Description	Data Type
investmentEntityId	The system-generated ID of the investment entity that owns the document	String
name	The name of the document	Map[String, String]
note	The note about the document	String
signAt	The date the document is signed	String
expiredAt	The date the document is expired	String
documentType	The type of the document	String