Skip to content

Integration Flows

These guides walk a Defentry integration partner through wiring their own systems into the Defentry Identity Protection platform end to end: standing up a service account, creating and administering customer accounts, enrolling monitored items, giving end users self-service access, and running the Delete My Data service on their behalf.

Every endpoint referenced in these guides exists in the API Explorer (the integration OpenAPI spec), and each flow mirrors a sequence we exercise against the live API in our own test harness.

The two authentication scopes

Almost everything you do uses one of two bearer tokens. Knowing which scope a call needs is the single most important concept in the API.

TokenObtained viaActs asUse it for
CRM tokenPOST /api/v1/crm/auth/loginYour service account (partner admin)Create/administer accounts by id, manage watchlists on behalf of users, read alarms
App tokenPOST /api/v1/sso/tokenA single end userEnd-user self-service: own profile, own watchlists, Online Data
  1. Onboarding & service account — first CRM user, create your service account, log in, 2FA.
  2. Account management — create and administer customer accounts (CRM token).
  3. Watchlist enrolment — add monitored items, with the CRM-token vs app-token split made explicit.
  4. End-user access (SSO) — mint an app token for a user without a login UI.
  5. Online Data — scan, sign, and submit broker removals (app token).
  6. Alarms — surface and resolve identity alarms.

Response format

Pick legacy or standardized responses per request with the X-API-Version header. Before you go live, read Legacy → Standardized migration and the Response & Error Conventions — the API Explorer's version selector renders both shapes side by side.

For API access and technical questions, contact Defentry through your account manager.