Skip to content

Add sealed results code example to readme #232

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
erayaydin wants to merge 1 commit into
base: main
Choose a base branch
from
+19 −2
Open

Add sealed results code example to readme #232

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 19 additions & 2 deletions readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -164,9 +164,26 @@ To learn more, see [example/validateWebhookSignature.mjs](example/validateWebhoo

### Sealed results

Customers on the Enterprise plan can enable [Sealed results](https://dev.fingerprint.com/docs/sealed-client-results) to receive the full device intelligence result on the client and unseal it on the server. This SDK provides utility methods for decoding sealed results.
This SDK provides utility methods for decoding [sealed results](https://docs.fingerprint.com/docs/sealed-client-results).
Use below code to unseal results:

To learn more, see [example/unsealResult.mjs](https://github.com/fingerprintjs/node-sdk/tree/main/example/unsealResult.mjs) or the [API Reference](https://fingerprintjs.github.io/node-sdk/functions/unsealEventsResponse.html).
```typescript
import { unsealEventsResponse, DecryptionAlgorithm } from '@fingerprint/node-sdk'

const sealedData = process.env.BASE64_SEALED_RESULT
const decryptionKey = process.env.BASE64_KEY

const unsealedData = await unsealEventsResponse(Buffer.from(sealedData, 'base64'), [
{
key: Buffer.from(decryptionKey, 'base64'),
algorithm: DecryptionAlgorithm.Aes256Gcm,
},
])

console.log(JSON.stringify(unsealedData, null, 2))
```

To learn more, refer to example located in [example/unsealResult.mjs](./example/unsealResult.mjs).

### Deleting visitor data

Expand Down
Loading