Privacy Protect

Detailed reference for Privacy Protect scans and Neighborhood Watch data endpoints.

Endpoint Reference

GET /idp/array/users/me/scans

• Description: list Privacy Protect scans

• Authentication: XV/OpenID token

• Request body: none

Responses on success:

• 200 OK

[
  {
    "id": "scan-123abc",
    "customerId": "customer-456def",
    "enrollmentId": "enrollment-789ghi",
    "brokerCount": 25,
    "brokerIds": ["broker1", "broker2"],
    "realtime": true,
    "scanType": "full",
    "status": "completed",
    "createdAt": "2024-01-01T00:00:00Z",
    "modifiedAt": "2024-01-02T00:00:00Z",
    "startedAt": "2024-01-01T01:00:00Z",
    "stoppedAt": "2024-01-01T05:00:00Z"
  }
]

GET /idp/array/users/me/scans/progress

• Description: read aggregated removal progress

• Authentication: XV/OpenID token

• Request body: none

Responses on success:

• 200 OK

{
  "totals": {
    "scanId": "all",
    "totalRecords": 150,
    "notInitiated": 20,
    "submitted": 50,
    "confirmed": 40,
    "verified": 40,
    "percentCompleted": 73.33
  },
  "perScan": [
    {
      "scanId": "scan-123abc",
      "totalRecords": 100,
      "notInitiated": 10,
      "submitted": 30,
      "confirmed": 30,
      "verified": 30,
      "percentCompleted": 90.0
    }
  ]
}

GET /idp/array/users/me/nhw/alerts

• Description: list Neighborhood Watch alerts

• Authentication: XV/OpenID token with 2FA

• Request body: none

Responses on success:

• 200 OK with the same response shape as /idp/array/users/me/alerts

GET /idp/array/users/me/nhw/watches

• Description: list Neighborhood Watch monitors

• Authentication: XV/OpenID token with 2FA

• Request body: none

Responses on success:

• 200 OK

{
  "watchAlerts": [
    {
      "watchAlertId": "watch-123",
      "radius": 5,
      "address": {
        "street1": "123 Main St",
        "street2": "Apt 4",
        "city": "Austin",
        "state": "TX",
        "zip": "78701",
        "longitude": "-97.7431",
        "latitude": "30.2672"
      }
    }
  ]
}