Client API

Use these endpoints from client applications to manage Identity Protection for the currently authenticated user.

Authentication

Both token families are valid for client endpoints:

• XV access token

• OpenID access token

For endpoints marked as 2FA-required, use the corresponding 2FA token:

• XV access token with 2FA

• OpenID access token with 2FA

Base URL and common headers

• Base URL: See Base Domains

• Header: Authorization: Bearer <token>

• Header: Content-Type: application/json for JSON request bodies

Detailed reference pages

• User and Enrollment

• Dashboard and Status

• Alerts

• Scans and Neighborhood Watch

• Mock Endpoints

Endpoint overview

User and Enrollment

Method	Path	Purpose	Auth
POST	/idp/array/users	Create IDP profile	XV/OpenID with 2FA
GET	/idp/array/users/me	Read profile/auth status	XV/OpenID
PATCH	/idp/array/users/me	Update profile data	XV/OpenID with 2FA
DELETE	/idp/array/users/me	Delete and unenroll user	XV/OpenID with 2FA
POST	/idp/array/users/me/enroll	Activate eligible products	XV/OpenID with 2FA
POST	/idp/array/users/me/token	Generate/refresh user token	XV/OpenID with 2FA
POST	/idp/array/users/me/migration	Set migration version and sync enrollment	XV/OpenID with 2FA

Dashboard and Status

Method	Path	Purpose	Auth
GET	/idp/array/users/me/dashboard	Read dashboard payload	XV/OpenID with 2FA
GET	/idp/array/users/me/monitors/overview	Read monitor overview	XV/OpenID
GET	/idp/array/users/me/credit-scores	Read credit scores	XV/OpenID
GET	/idp/array/users/me/financial-accounts/status	Read financial accounts summary	XV/OpenID
GET	/idp/array/users/me/nhw/status	Read Neighborhood Watch status	XV/OpenID

Alerts

Method	Path	Purpose	Auth
GET	/idp/array/users/me/alerts	List alerts	XV/OpenID
GET	/idp/array/users/me/alerts/{bureau}/{alert_id}/details	Get alert details	XV/OpenID
PUT	/idp/array/users/me/alerts/read	Mark all or some alerts read	XV/OpenID
DELETE	/idp/array/users/me/alerts/read	Mark all or some alerts unread	XV/OpenID
PUT	/idp/array/users/me/alerts/{alertId}/read	Mark one alert read	XV/OpenID
DELETE	/idp/array/users/me/alerts/{alertId}/read	Mark one alert unread	XV/OpenID

Scans and Neighborhood Watch

Method	Path	Purpose	Auth
GET	/idp/array/users/me/scans	List Privacy Protect scans	XV/OpenID
GET	/idp/array/users/me/scans/progress	Read removal progress	XV/OpenID
GET	/idp/array/users/me/nhw/alerts	List Neighborhood Watch alerts	XV/OpenID with 2FA
GET	/idp/array/users/me/nhw/watches	List Neighborhood Watch monitors	XV/OpenID with 2FA

Mock Endpoints

Method	Path	Purpose	Auth
GET	/idp/array/users/me/mock	Read mock feature flags	XV/OpenID
POST	/idp/array/users/me/mock/alerts	Enable mock alerts	XV/OpenID
DELETE	/idp/array/users/me/mock/alerts	Disable mock alerts	XV/OpenID
POST	/idp/array/users/me/mock/scans	Enable mock scans	XV/OpenID
DELETE	/idp/array/users/me/mock/scans	Disable mock scans	XV/OpenID