Platform Partner API Overview

Introduction

Thank you for your interest in integrating with the Asset-Map! This page provides a brief overview of our Partner accessible API structure, including some basic details pertaining to authentication, endpoints, and related resources for prospective integration partners.

Key Features

• RESTful API with predictable resource-oriented URLs
• JSON-formatted response
• Secure authentication via OAuth 2.0
• High availability and 99.9% uptime SLA

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/:uuid/info	Retrieve detailed household and instrument info	GET

GET /api/v3/partner/default/household/:uuid/info

This endpoint retrieves detailed information about a specific household, including members, entities, and associated financials.

Request Headers

• Authorization: Bearer :access_token
• Content-Type: application/json

Example Response

{
  "id": "a2539450-f291-40ab-a8f9-7c149aca8e9b",
  "currency": "USD",
  "householdmembers": [
    {
      "id": "872cfe41-172b-47c0-9dbf-71c3c4f9451f",
      "category": "primary",
      "member_type": "member",
      "name": "Sam Smith"
    }
  ],
  "instruments": [
    {
      "id": "994ddbdd-442e-47be-8581-22c0c7d13582",
      "amount": 43,
      "amount_period": 1,
      "category": "income.unearned.annuity",
      "instrument_type": "income",
      "members": [
        {
          "id": "b4na4M8j",
          "ratio": 100.0,
          "relation": "owner"
        }
      ],
      "name": "Cashflow",
      "source": "Unknown",
      "start_date": "2025-03-18",
      "end_date": "2109-03-18"
    },
    {
      "id": "12d9eed1-41ce-4122-acac-ff6c3354f5b6",
      "amount": 33,
      "amount_period": 1,
      "category": "retirement",
      "instrument_type": "asset",
      "members": [
        {
          "id": "b4na4M8j",
          "ratio": 100.0,
          "relation": "owner"
        }
      ],
      "name": "401k",
      "source": "Institution XYZ"
    }
  ],
  "name": "Smith",
  "status": "client"
}

Support & Onboarding

[INSERT NARRATIVE TEXT HERE]

Contact: tbd@asset-map.com