@evervault/browser NPM

Evervault JavaScript SDK

The Evervault JavaScript SDK is a toolkit for encrypting data in the browser. Using the Evervault JavaScript SDK means your customer's data never leaves their browser unencrypted.

Getting Started

Before starting with the Evervault JavaScript SDK, you will need to create an account, a team and an app.

Installation

To make Evervault available for use in your app, add this script to your page's footer:

<script src="https://js.evervault.com/v2"></script>

Setup

Once installed, initialize the JavaScript SDK with your team's unique ID found in the Settings.

const evervault = new Evervault("<TEAM_ID>", "<APP_ID>");

Reference

The Evervault JavaScript SDK exposes two functions.

evervault.encrypt()

evervault.encrypt() encrypts data for use in your Functions and Cages. To encrypt data in the browser, simply pass an object or string into the evervault.encrypt() function. Store the encrypted data in your database as normal.

async evervault.encrypt(data: Object | Array | String | Number | File | Blob);

Parameter	Type	Description
data	`Object`, `Array`, `String`, `Number`, `File` or `Blob`	Data to be encrypted.

evervault.inputs()

Note: Self-Serve customers can only use Inputs in debug mode, which is not safe for production use.

evervault.inputs() initialises Evervault Inputs which make it easy to collect encrypted cardholder data in a completely PCI-compliant environment.

Evervault Inputs are served within an iFrame retrieved directly from Evervault’s PCI-compliant infrastructure, which can reduce your PCI DSS compliance scope to the simplest form (SAQ-A) once integrated correctly.

Simply pass the id of the element in which the iFrame should be embedded.

We also support themes so you can customise how Inputs looks in your UI.

evervault.inputs(id: String, settings: Object);

Parameter	Type	Description
id	String	Id of the element in which the Evervault Inputs iFrame should be embedded
config	Object	A config object for custom styling.

config

Parameter	Type	Description
theme	String	The base styling for Inputs. Currently supports default, minimal and material.
height	String	The height of the Evervault Inputs iframe.
primaryColor	String	The main theme color.
labelColor	String	The color CSS property applied to the input labels.
inputBorderColor	String	The border-color CSS property applied to inputs.
inputTextColor	String	The color CSS property applied to inputs.
inputBackgroundColor	String	The color CSS property applied to the ::placeholder CSS pseudo-element for inputs.
inputBorderRadius	String	The border-radius CSS property applied to inputs.
inputHeight	String	The height CSS property applied to inputs.
cardNumberLabel	String	The label for the card number input
expirationDateLabel	String	The label for the expiration date input
securityCodeLabel	String	The label for the security code input
expirationDatePlaceholder	String	The placeholder shown for the expiration date input
invalidCardNumberLabel	String	The message shown on an invalid card number
invalidExpirationDateLabel	String	The message shown on an invalid expiration date
invalidSecurityCodeLabel	String	The message shown on an invalid security code
fontUrl	String	Load a custom font with the Google Fonts API
fontFamily	String	Set the font-family for the fontUrl
inputFontSize	String	Set the font-size property of the input attribute
inputBoxShadow	String	Set the box-shadow property of the input attribute
labelFontSize	String	Set the font-size property of the label attribute
labelWeight	String	Set the font-weight property of the label attribute
disableCVV	Boolean	If true the CVV field will not be displayed

<body>
  <form id="ev-payment-form">
    <div id="ev-card-fields">
      <!-- Evervault will create input elements here -->
    </div>
  </form>
</body>
<script src="https://js.evervault.com/v2"></script>
<script>
  const inputs = evervault.inputs("ev-card-fields");
</script>

Retrieving card data

There are two ways of accessing encrypted card data once it has been entered. In each case, a cardData object containing details about the card data your user has entered is returned.

{
  "card": {
    "type": "visa_credit",
    "number": "ev:encrypted:abc123",
    "cvc": "ev:encrypted:def456",
    "expMonth": "01",
    "expYear": "23"
  },
  "isValid": true,
  "isPotentiallyValid": true,
  "isEmpty": false,
  "error": {
    "type": "invalid_pan",
    "message": "The credit card number you entered was invalid"
  }
}

`onChange` hook

This option is best when you are looking to handle the card values in realtime, like displaying validation errors as a user is inputting their card data. The callback for the hook is run every time your user updates the card data.

const hook = inputs.on("change", async (cardData) => {});

`getData` method

This option is best when you are looking to retrieve card data occasionally, like when your form is submitted.

const cardData = await inputs.getData();

Localization

The iFrame can be localized on initialization by providing a set of labels in the config. The labels can then be updated as required using the setLabels method.

await inputs.setLabels({});

Parameter	Type	Description
cardNumberLabel	String	The label for the card number input
expirationDateLabel	String	The label for the expiration date input
securityCodeLabel	String	The label for the security code input
expirationDatePlaceholder	String	The placeholder shown for the expiration date input
invalidCardNumberLabel	String	The message shown on an invalid card number
invalidExpirationDateLabel	String	The message shown on an invalid expiration date
invalidSecurityCodeLabel	String	The message shown on an invalid security code