FORVUE

Fill these in before sending to your integration team:

Pass your API key in the X-Api-Key header on every request:

curl https://platform.investwisecap.com/api/v1/properties \
  -H "X-Api-Key: YOUR_API_KEY"

If authentication fails, you'll receive:

{ "error": "Invalid or inactive API key." }

Add ?sandbox=true to any GET request to work with demo data only. No production data is exposed.

curl https://platform.investwisecap.com/api/v1/properties?sandbox=true \
  -H "X-Api-Key: YOUR_API_KEY"

⚠ Remove ?sandbox=true when you are ready to go live.

The most common integration — pull risk scores for all components in a portfolio:

curl https://platform.investwisecap.com/api/v1/components \
  -H "X-Api-Key: YOUR_API_KEY"

Response (shape verified against live API, July 9, 2026):

{
  "components": [
    {
      "component_id": "C_17762...",
      "component_name": "wh_gas_anode",
      "appliance_type": "water_heater_gas",
      "appliance_brand": "Rheem",
      "unit": "U_...",
      "property_id": "P_...",
      "property_name": "Oakwood Apartments",
      "risk_score": 0.847,
      "risk_tier": "CRITICAL",
      "proactive_cost": 220,
      "reactive_cost": 1800,
      "last_scored": "2026-07-09T20:07:06.109Z"
    }
  ]
}

📌 Response-shape change effective July 9, 2026: NUMERIC, DECIMAL, BIGINT, and INT8 fields now return as JSON numbers, not strings. See the API Reference §13.4.1 changelog.

Send properties, appliances, and service events to build a portfolio:

// Create a property
curl -X POST https://platform.investwisecap.com/api/v1/properties \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Oakwood Apartments",
    "address": "123 Main St",
    "city": "Dallas",
    "state": "TX",
    "zip": "75201",
    "unit_count": 24
  }'

// Add an appliance
curl -X POST https://platform.investwisecap.com/api/v1/appliances \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "property_id": "P_...",
    "type_id": "hvac_central",
    "brand": "Carrier",
    "model": "24ACC636",
    "install_year": 2018
  }'

// Log a service event (bulk endpoint; send one or many)
curl -X POST https://platform.investwisecap.com/api/v1/service-events/bulk \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "events": [
      {
        "appliance_id": "A_...",
        "event_type": "Preventive Maintenance",
        "date": "2026-07-09",
        "technician": "ABC HVAC",
        "parts_cost": 45,
        "labor_cost": 150,
        "condition_after": "good",
        "notes": "Replaced capacitor, cleaned coils"
      }
    ]
  }'

For lenders and insurance carriers — pull property condition scores and replacement cost values:

// Condition score (bank underwriting)
curl https://platform.investwisecap.com/api/v1/property/P_.../condition-score \
  -H "X-Api-Key: YOUR_API_KEY"

// Replacement cost value (insurance coverage)
curl https://platform.investwisecap.com/api/v1/property/P_.../rcv \
  -H "X-Api-Key: YOUR_API_KEY"

// Push insurance claims for Bayesian risk adjustment
curl -X POST https://platform.investwisecap.com/api/v1/property/P_.../claims \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "claim_type": "water_damage",
    "date_of_loss": "2026-03-15",
    "amount": 12500
  }'

Receive real-time alerts when components cross CRITICAL or WARNING thresholds.

What ForVue sends to your webhook URL:

POST https://your-server.com/your-webhook-endpoint

Headers:
  Content-Type: application/json
  X-Webhook-Signature: HMAC-SHA256 signature

Body:
{
  "event": "component.critical",
  "timestamp": "2026-04-28T14:30:00Z",
  "data": {
    "component_id": "C_...",
    "appliance_id": "A_...",
    "property_id": "P_...",
    "component_name": "Anode Rod",
    "risk_score": 0.84,
    "risk_tier": "CRITICAL",
    "projected_failure_year": 2027,
    "reactive_cost": 1800,
    "proactive_cost": 220
  }
}

How to verify the signature:

const crypto = require('crypto');
const signature = req.headers['x-webhook-signature'];
const expected = crypto
  .createHmac('sha256', YOUR_WEBHOOK_SECRET)
  .update(JSON.stringify(req.body))
  .digest('hex');
if (signature !== expected) {
  return res.status(401).send('Invalid signature');
}
// Signature valid — process the event

Return HTTP 200 to acknowledge. ForVue retries at 0s, 5s, and 30s if no 200 received.