When a card is stored in the vault, the original card information is not retrievable by the client without the cardvault_raw scope (contact support). The CVV's ttl is set to the same ttl as the card unless the card is stored permanently. If the card is stored permanently, the CVV's ttl is set to 30 minutes. The CVV is purged after its first use or after its ttl expires, whichever comes first. After the card's ttl, the card is deleted. To make the card permanent, leave out the ttl property. The full card number can be used through the proxy endpoint. You can get the first six, the last four, full name, and expiration from /cardvault/cards (GET).

Provides card data. The first six and the last four are included in the response. The ttl values represent the time remaining in seconds until that item is purged. the original card information is not retreivable by the client without the cardvault_raw scope (contact support). If you have the proper scope, use the cardvault/raw/cards endpoint.

Returns an empty 204 response on success.

Special endpoint to retreive raw card data. It can only be used with the cardvault_raw scope.

The ephemeralKey is a one time use expiring key that allows an external client to use a card token. The destinationClientId is a valid Enigma Vault clientId of the destination app. The time to live (ttl) is in seconds.

The card's time to live in seconds. Once expired the card is deleted from the vault. If -1, the card lives forever until manually deleted.

Adjusts the time (seconds) until deletion. Additional time cannot be added to the CVV's ttl.

This endpoint allows you to use a stored card without touching the card data. Build out the request meant for the upstream url and then use the following placeholders to have the endpoint populate them with card data: ${ccn}, ${cvv}, ${fullName}, ${lastName}, ${firstName}, ${cardType}, ${mm}, ${yy}, and ${yyyy}. Supports GET/PUT/POST/DELETE.

The card processing UI allows your customers to enter their card data and process upstream with the payment gateway without your app touching it. Build out the request meant for the upstream url and then use the following placeholders to have the endpoint populate them with card data: ${total}, ${ccn}, ${cvv}, ${fullName}, ${lastName}, ${firstName}, ${cardType}, ${mm}, ${yy}, and ${yyyy}. Supports GET/PUT/POST/DELETE. The customer is redirected back to your app (callback url) via POST with the parameter eVsessionId. You can then use /cardvault/process/sessions/ to determine the adjudication. The session information is available for 72 hours. If the customer choses to save their card, it will be available through the sessions endpoint. If the customer chooses to cancel or if the form timeouts, evException will have a value within the POST callback. For cancels, evException's value will be 'cancel'. For timeouts, the evException's value will be 'timeout'. There are multiple ways to integrate the card process form. You can use it within a popup, redirect or simple iframe.

Obtain the results from the gateway and retrieve the card token if the customer decided to save it.

The card store form allows your app to store and later use customer card data without touching it. After the cardTtl expires, the card is deleted. If the user decides to save the card, the card is stored permanently. If you're seeking to permanently store the card outside of a transaction (wallet style), set walletSave to true. If you set walletSave to true, the buttonText and cardTtl are overriden. If walletSave is true the CVV isn't requested. If you intend to use the card in a transaction within 30 minutes, set walletSave to false. On callback, your app will receive via POST the card token within the parameter eVtoken. If the customer chooses to cancel or if the form timeouts, the evException parameter will contain the reason. For cancels, evException's value will be 'cancel'. For timeouts, evException's value will be 'timeout'. If embedFormForControl is set to true, pass 'submit' as a message over to the iframe to submit the form. On response, the parent will receive an object that consists of the status, the token, and CardModel object. There are multiple ways to integrate the card store form. You can use it within a popup, redirect, simple iframe, or iframe where the parent page has control to submit the form. You can find example code for the advanced iframe integration on GitHub.

The CVV store form allows your app to temporarily store the CVV until authorization. The CVV ttl is set to the card's ttl. If the card has a ttl of -1, the CVV ttl will be set to 1800 seconds. If autoSave is true, the callback will not trigger so the client app will need to verify the cvv ttl for its existence. There are multiple ways to integrate the cvv form. You can use it within a popup, redirect, simple iframe, (previous 3 can use autosave) or iframe where the parent page has control to submit the form. You can find example code for the advanced iframe integration on GitHub.

Supports up to 5,000 plaintext objects per request. Plaintext strings must be less than 1000 characters in length. The customIdentifier attribute ties your unencrypted data to the tokens. The customIdentifier is not stored within the vault.

The ephemeralKey is a one time use expiring key that allows an external client to obtain the token's secret. To generate one, use the datavault/secrets/ephemeralKey endpoint.

Exact matches will only be returned and is case sensitive.

The ephemeralKey is a one time use expiring key that allows an external client to obtain the token's secret. The destinationClientId is a valid Enigma Vault clientId of the destination app. The time to live (ttl) is in seconds.

The url is used to upload (PUT) a file into the vault. The url has an exipration of five minutes. The file size cannot exceed 5 gigabytes. A websocket url is provided so that the status of the file can be tracked in realtime.

This endpoint has been deprecated because the file status is now provided through a websocket API.

The url is used to download the file out of the vault. The url has an exipration of five minutes. When aSync is set to true for large files, a websocket API url is returned so that the file status can be monitored in real time. When the file is finished decrypting, the download url is provided through the websocket connection.

On successful deletion, a 204 response is returned.

The ephemeralKey is a one time use expiring key that allows an external client to obtain a download url. The destinationClientId is a valid Enigma Vault clientId of the destination app. The time to live (ttl) is in seconds.