We launched the Accounting Sample!Manage invoices, payments, expenses, and more across multiple connectors.

Search docs

Vault JS

A vanilla JavaScript library to embed Apideck Vault in any web application.

This guide will get you up and running with the Vault component. To get started, follow these 3 steps:

Step 1: Setup Apideck

Create an account

If you haven't already, head over to our Signup page and create an account. Choose an application name and a subdomain. Afterward, you will be redirected to the Apideck dashboard.

Enable Unified APIs and connectors

Go to the Unified APIs page in the Apideck dashboard. Choose one or more Unified APIs to enable. You'll see a list of the available connectors for each Unified API. Choose a couple of connectors to enable. The Unified APIs and connectors you select become available to your users in Vault.

Get your API key and Application ID

Go to the API Keys page in the Apideck dashboard. Copy your application ID and API key. If your API key ever gets compromised, you can regenerate it on this page.

API keys overview
API keys overview

Step 2: Create a session

Vault lets your users (called consumers in Apideck) easily connect and configure integrations. You can create a consumer through a Vault session through the following endpoint https://developers.apideck.com/apis/vault/reference#tag/Sessions.

Most of the time, this is an ID of your internal data model that represents a user or account in your system. E.g., account:12345. If the consumer doesn't exist yet, Vault will upsert a consumer based on your ID.

Use the API call below to create a session for a consumer. This will return a Vault URL that you forward to a consumer to connect integrations.

curl --request POST \
  --url 'https://unify.apideck.com/vault/sessions' \
  --header 'Authorization: Bearer {API_KEY}' \
  --header 'x-apideck-app-id: {APP_ID}' \
  --header 'x-apideck-consumer-id: {CONSUMER_ID}' \

You can also use one of our SDKs to create a session, like for example the Node SDK:

npm install @apideck/node

Below is an example of creating a function to create a session:

import { Apideck } from '@apideck/node'

const createSession = async (_, res) => {
  const apideck = new Apideck({
    apiKey: `${process.env.API_KEY}`,
    appId: `${process.env.APP_ID}`,
    consumerId: 'test-consumer'
  const settings = {}
  const { data } = await apideck.vault.sessionsCreate(settings)


export default createSession

The returned

object will include the
that you can use pass as the
prop to the
component. It also includes a
, which is a link to the Hosted Vault application. You can use this link if you don't want to use
and redirect the user to the hosted solution.

Step 3: Add Vault JS

Vault JS lets your users authorize connectors and manage integration settings. It stores the credentials securely and lets you make authorized API calls on your consumers` (users) behalf. To get started, install the component using NPM or Yarn.



npm install @apideck/vault-js


If you don't want to set up a build environment, you can get

from a CDN like unpkg.com and it will be globally available through the

<script src="https://unpkg.com/@apideck/vault-js"></script>


Pass the JWT you got from the Vault session to


import { ApideckVault } from '@apideck/vault-js'


If you want to only show integrations for a single Unified API, you can do that by passing the

option. If you want to open Vault for only a single integration, you can provide the

import { ApideckVault } from '@apideck/vault-js'

  unifiedApi: 'accounting',
  serviceId: 'quickbooks'

If you want to get notified when the modal opens and closes, you can provide the


import { ApideckVault } from '@apideck/vault-js'

  onClose: () => {
  onReady: () => {


tokenstringtrue-The JSON Web Token returned from the Create Session API
showAttributionbooleanfalsetrueShow "Powered by Apideck" in the backdrop of the modal backdrop
open() => voidfalse-Function to open the Vault modal
close() => voidfalse-Function to close the Vault modal
onReady() => voidfalse-Function that gets called when the modal is opened
onClose() => voidfalse-Function that gets called when the modal is closed
onConnectionChange(connection: Connection) => voidfalse-Function that gets called when the user updates a connection. This can be linking their account, filling out settings or adding a new connection
onConnectionDelete(connection: Connection) => voidfalse-Function that gets called when the user deletes a connection
unifiedApistringfalse-When unifiedApi is provided it will only show integrations from that API.
serviceIdstringfalse-When unifiedApi and serviceId are provided Vault opens a single integration
showConsumerbooleanfalsefalseIf true it shows the current consumer metadata at the bottom of the modal


See a working demo here