Status Dashboard

Detailed reference for dashboard, monitor overview, credit score, financial account, and Neighborhood Watch status endpoints.

Endpoint Reference

GET /idp/array/users/me/dashboard

• Description: fetch composite dashboard payload

• Authentication: XV/OpenID token with 2FA

Query parameters:

• count (optional integer)

• offset (optional integer)

Responses on success:

• 200 OK

{
  "userAlerts": {
    "Ok": {
      "userAlerts": [
        {
          "alertId": 123456,
          "class": "CREDIT_MONITORING",
          "createDate": "2025-10-01T12:34:56Z",
          "updatedDate": "2025-10-02T09:00:00Z"
        }
      ]
    }
  },
  "creditScoreHistory": {
    "Ok": {
      "creditScoreHistory": [
        {
          "score": "720",
          "productCode": "EXP",
          "scoreDate": "2025-10-01"
        }
      ]
    }
  },
  "dataRemovalProgress": {
    "Err": "provider unavailable"
  },
  "monitorsOverview": {
    "Ok": {
      "countsByCategory": {
        "emailAddress": 1,
        "phoneNumber": 0
      },
      "monitoredCount": 1,
      "availableCount": 5,
      "availableInHigherPlans": 7,
      "availableCategoriesInHigherPlans": ["firstName", "lastName"]
    }
  },
  "neighborhoodWatchStatus": {
    "Ok": {
      "hasWatches": true,
      "watchAlertCount": 2
    }
  },
  "financialAccountsStatus": {
    "Ok": {
      "hasAccounts": true,
      "institutionCount": 2,
      "accountCount": 3,
      "anyNeedsRenewal": false,
      "needsRenewalCount": 0
    }
  }
}

Note: each top-level section is a result wrapper under Ok or Err.

---

GET /idp/array/users/me/monitors/overview

• Description: read monitor category overview

• Authentication: XV/OpenID token

• Request body: none

Responses on success:

• 200 OK

{
  "countsByCategory": {
    "addressDarkWeb": 2,
    "emailAddress": 1,
    "phoneNumber": 0
  },
  "monitoredCount": 2,
  "availableCount": 5,
  "availableInHigherPlans": 7,
  "availableCategoriesInHigherPlans": ["firstName", "lastName"]
}

---

GET /idp/array/users/me/credit-scores

• Description: read credit score history

• Authentication: XV/OpenID token

• Request body: none

Responses on success:

• 200 OK

{
  "creditScoreHistory": [
    {
      "score": "720",
      "productCode": "EXP",
      "scoreDate": "2025-10-01"
    }
  ]
}

---

GET /idp/array/users/me/financial-accounts/status

• Description: read financial account status summary

• Authentication: XV/OpenID token

• Request body: none

Responses on success:

• 200 OK

{
  "hasAccounts": true,
  "institutionCount": 2,
  "accountCount": 3,
  "anyNeedsRenewal": true,
  "needsRenewalCount": 1
}

---

GET /idp/array/users/me/nhw/status

• Description: read Neighborhood Watch status

• Authentication: XV/OpenID token

• Request body: none

Responses on success:

• 200 OK

{
  "hasWatches": true,
  "watchAlertCount": 2
}