This section provides a complete reference for all available API endpoints. The API is organized into logical groups based on functionality:
  • Authentication — Obtain and manage Access Tokens.
  • User Management — Create, list, update, enable, disable, renew, and delete the users you protect.
  • Dark Web Monitoring — Look up breach records by identifier, browse the breach catalog, and enrich identities.
  • Data Broker Opt-Out Service — Scan data broker sites for a person and automate removal requests.

​
Base URL

Every endpoint in this reference is written against the <base_url> placeholder:
The base URL is:
Replace <base_url> with this value. All endpoint paths shown in this reference are relative to it, so the example above becomes https://atomapi.com/usermanagement/v1/user?userName={userName}. Keep the base URL in configuration rather than inlining it in your client.

​
Authentication

Every endpoint except API Access Authentication requires an Access Token in the X-AccessToken header.

​
Pagination

List endpoints return results a page at a time:
  • User Management — List Users takes page, limit, sort, order, and keyword query parameters.
  • Dark Web Monitoring — Dark Web Scan lookups and List All Breach Metadata take a page query parameter (1-based), and return page, pageSize, and total (the number of matching records across all pages) in the response body.

​
Endpoint Groups

Navigate to the specific endpoint documentation using the sidebar. Each endpoint page includes:
  1. Description of the endpoint’s purpose
  2. Endpoint URL and HTTP method
  3. Path, query, and request body parameters
  4. A sample cURL request
  5. Response fields and the shape of a sample response
  6. Status codes

​
Next steps

Authentication

Exchange your Secret Key for an Access Token before calling any other endpoint.

User Management overview

Create and manage the users you’ll protect with the DPP services.

Quickstart

Walk through a first end-to-end authenticated call.