Delete an online generic vault

Overview

Allows you to delete an online generic vault. The correct payload and encryptedData must be supplied
in order to proceed with deletion. If this vault was created with a hashedPin, it should also
be supplied for deletion to be successful.

As this is an online vault endpoint, the request may contain the fields:
- (required) device: The device information associated with this vault. Device Fingerprinting
- (optional) hashedPin: Extra field to increase the level of security of the vault. FAQ
For more information about online vaults see here.

Structure

{
application {: The application details
Type: JSON Object
Presence: required
apiKey: The application's api key
Type: string
Values: hexadecimal, dashes
Length: 36
Presence: required
uuid: The application's uuid
Type: string
Values: hexadecimal, dashes
Length: 36
Presence: required
device {: Contains the end-user's device metrics. Device Fingerprinting
Type: JSON Object
Presence: required
browserType: Type of browser on the end-user's device
Type: string
Value: alphanumeric, dash, underscore, space
Min length: 2
Presence: required
browserVersion: Version of the browser on the end-user's device
Type: string
Value: numeric, dots
Min length: 2
Presence: required
osType: Operating System on the end-user's device
Type: string
Value: alphanumeric, dash, underscore, space
Min length: 2
Presence: required
fonts [: Fonts on the end-user's device
Type: Array of string
Min length: 1
Presence: required
externalRef: Your reference to this operation for audits. FAQ
Type: string
Values: utf8
Min length: 1
Max length: 64
Presence: optional
vault {: Contains the details of the vault
Type: JSON Object
Presence: required
credentials {: Contains the credentials required for use of the vault
Type: JSON Object
Presence: required
encryptedData: The vault's encryptedData
Type: string
Presence: required
payload: The vault's payload
Type: string
Presence: required
hashedPin: The value used to create the vault in order to provide more security
Type: string
Values: base64
Presence: optional
}
{
responseStatus {: Contains details about the response status
Type: JSON Object
Presence: required
code: The response status code
Type: optional
Values: alphanumeric, dashes
Presence: optional
detailedErrors [{: Contains error details if any error(s) occurred
Type: Array of JSON Objects
Presence: optional
errorReasons [: Contains reasons for the parent detailed error
Type: Array of string
Presence: optional
property: The JSON property in the request responsible for the parent detailed error
Type: string
Presence: optional
message: The response message
Type: string
Values: see Sanctum error messages
Presence: optional
status: The response status
Type: string
Values: ERROR, SUCCESS
Presence: required
}

Usage

API used
PUT /sanctum/v1-2/vault/generic/online/{vaultUuid}/delete