Platform Partner API Overview
Authentication
All API requests must be authenticated using OAuth 2.0. Access to our Partner APIs require a unique client id and secret, which may be provided by Asset-Map upon request.
If you are interested in developing an integration to Asset-Map please complete our online Partnership Interest Question and include “Platform Integration” as a selected area of interest. From there, a member of the Asset-Map Team will reach out to schedule a conversation.
Available Endpoints
| Endpoint | Description | Supported Method(s) |
|---|---|---|
| Household Search | Searches an advisor's households using a query string that does a contains search on the household name and the household member’s full names. | POST |
| Household Info | Retrieves detailed information about a household, including household members and instruments. | GET |
| List Instruments | Retrieves all instruments for a household. | GET |
| Create Instruments | Creates a new instrument for the household. | POST |
| Get Instrument | Retrieves an individual instrument for the household. | GET |
| Update Instrument | Replaces instrument fields. | PUT |
| Delete Instrument | Deletes an instrument for a household. | DELETE |
| List Members | Retrieves all members for a household. | GET |
| Create Member | Creates a new member for the household. | POST |
| Get Member | Retrieves an individual member for the household. | GET |
| Update Member | Replaces member fields. | PUT |
| Delete Member | Deletes a member for a household. | DELETE |
How to Request Access & Additional Information
To request integration access:
- Complete the Partnership Interest Questionnaire.
- Select "Platform Integration".
- A member of the Asset-Map team will contact you.
When we reach out to you, you will be asked for the following information:
- Organization Name
- redirect_urls: Approved redirect URIs where users will be directed after authentication. You may provide multiple URIs, but only the ones listed will be accepted in the integration.
Once approved, you will receive:
- Client ID and Client Secret for use in the OAuth flow
- Authorization Host: The domain for the OAuth2 authorization endpoints, which must be securely stored upon receipt