SDKs

Essence publishes one official SDK per ecosystem. Each has a single canonical package name, and these names are the only ones Essence will ever publish under:

Ecosystem	Package	Registry	Import
JavaScript / TypeScript	@essence/sdk	npm	import { EssenceClient } from '@essence/sdk'
C# / .NET	Essence.Sdk	NuGet	using Essence.Platform.Sdk;
Python	essence-sdk	PyPI	import essence_sdk

Not yet published

None of the three packages is on its public registry yet. They are published by the SDK release pipeline, which generates each client from the published API contract and has not yet made its first release. Until it does, npm install @essence/sdk, dotnet add package Essence.Sdk and pip install essence-sdk will fail.

Do not install a package under any other name that claims to be the Essence SDK. Essence publishes only the names above.

In the meantime, call the REST API directly. Start with Your first API call.

What the SDKs cover

Each SDK is generated from the published API contract, so it will expose the same operations as the REST API and change version when the contract does. Every SDK will cover authentication, vaults, documents, consent, sync, the marketplace, webhooks and client-side encryption.

The SDKs will authenticate the way the REST API does: every request carries a Bearer access token (see Authentication). Encrypt data in your application before you pass it to an SDK. The server stores it as it arrives and never decrypts it.

Reference

The reference for each SDK will be published here with its first release. Until then, every operation an SDK will expose is documented in the API reference.