Integrate the Privacy Interaction SDK

Integrate the Privacy Interaction SDK into your application.

Prerequisites

1. Complete the Getting Started Guide

2. Integrate the User SDK

Integrate the JS SDK

To use the Privacy Interaction SDK in a Web or Node.js project, you must add @sudoplatform/sudo-privacy-interaction as a dependency to your project.

Typescript

yarn add '@sudoplatform/sudo-privacy-interaction'
# or
npm install --save '@sudoplatform/sudo-privacy-interaction'

In order to instantiate a Privacy Interaction client, make sure you have followed the instructions for Getting Started and User SDK (see Prerequisites above).

To instantiate a client in your application, add the following:

Typescript

import { DefaultSudoPrivacyInteractionClient } from '@sudoplatform/sudo-privacy-interaction'
import { DefaultSudoUserClient } from '@sudoplatform/sudo-user'

const userClient = new DefaultSudoUserClient(/* refer to Users documentation */)

const privacyInteractionClient = new DefaultSudoPrivacyInteractionClient({
  sudoUserClient: userClient,
})

You only need one client instance for a given user per device. Instantiating multiple clients with the same configuration and using them at the same time may cause unexpected runtime errors to occur.

SDK Architecture

The Privacy Interaction SDK is organized around three core resource types:

Resource	Description
Virtual Presence	A connected user identity (e.g., email account) that the SDK monitors.
Data Holder	An organization discovered to hold data for a virtual presence.
Analysis Result	A structured privacy analysis produced for each data holder.

The typical workflow is:

1. Connect a virtual presence (e.g., via OAuth authorization code or refresh token).

2. Scan — the platform automatically scans the connected account and discovers data holders.

3. Analyze — for each data holder, the platform performs a privacy analysis.

4. Subscribe — receive real-time updates as scanning and analysis progress.