Skip to main content

Getting Started

In this article, we walk you through the process setting up the Verida Client SDK and guide you through the process of initializing and using the library in your applications.

You can interactively use the Verida client library in your browser using the Verida Web Sandbox or learn with our interactive tutorial.


Start by installing the Verida client protocol library and Verida Vault authentication method:

npm install @verida/client-ts @verida/account-web-vault

You may receive compilation warnings when using typescript regarding pouchdb. If that happens, add the pouchdb-core type definitions:

npm install --dev @types/pouchdb-core


Initialize a connection to the Verida network using a private key stored on the user’s mobile device using the Verida Vault:

import { Network, EnvironmentType } from '@verida/client-ts';
import { VaultAccount } from '@verida/account-web-vault';

const CONTEXT_NAME = 'My Application Context Name';

# The LOGO_URL should be a 170x170 PNG file
const LOGO_URL = "";

const account = new VaultAccount({
logoUrl: LOGO_URL

const context = Network.connect({
client: {
account: account,
context: {

Note: The default settings will connect to the Verida testnet.

  • CONTEXT_NAME: A string representing your decentralized application. By convention prefix it with your company name. ie: Verida: My Application.
  • VERIDA_TESTNET_DEFAULT_SERVER: The URI of a Verida Storage Node that provides a default encrypted storage option for your users. This example is using a testnet Storage Node that any application can use for testing.

Learn more about different authentication methods.

How to Use

You can now verify the user has connected succesfully to your application:

const did = await account.did();
console.log('User is connected with Verida Account DID: ' + did);

You can open a database, save a record and then fetch it:

const db = await context.openDatabase('test_db');
const item = await{
hello: 'world',
const items = await db.getMany();

Learn more about building applications with decentralized databases, datastores and messaging.