Read an online generic vault

Overview

Allows you to read the contents of your online generic vault. This is a two step process to guard against network failure:
1. get-start
2. get-end
The first step (get-start) will retrieve the contents of your vault and give you the new vault (represented by encryptedData and payload in the response body of get-start).
You must then acknowledge you received new vault using (get-end). It is only after it has been acknowledged that
the Sanctum system recognises the vault content has been retrieved. If the retrieval of the content fails due to network issues,
the retrieval request is ignored and you can restart the retrieval process by calling (get-start) again.
This two step process is identical to the vault update process.

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.

Starting the data retrieval process:

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
transactionToken {: Contains transaction token information to be used on acknowledging the response
Type: JSON Object
Presence: required
expiry: The expiry time of the transaction token
Type: string
Format: ISO 8601 time-date
Example: "2018-09-27T06:55:23.045Z"
Presence: required
timeToExpire: The time left until the transaction token expires
Type: integer
Presence: required
token: The transaction token
Type: string
Presence: required
vault {: Contains the details of the vault
Type: JSON Object
Presence: required
credentials {: Contains the credentials required for further 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
content: The content stored in the vault
Type: string
Value: utf8
Presence: required
uuid: The uuid of the vault
Type: string
Values: hexadecimal, dashes
Length: 36
Presence: required
autoLockDate: Marks the time when the vault will be automatically locked FAQ
Type: string
Format: ISO 8601 time-date
Example: "2018-09-27T06:55:23.045Z"
Presence: optional
dateCreated: Marks the time when the vault was created
Type: string
Format: ISO 8601 time-date
Example: "2018-09-27T06:55:23.045Z"
Presence: optional
lastModified: Marks the time when the vault was last updated or read
Type: string
Format: ISO 8601 time-date
Example: "2018-09-27T06:55:23.045Z"
Presence: optional
}

Usage

This endpoint should be called to begin the data retrieval process for a vault.

API used
POST /sanctum/v1-2/vault/generic/online/{{vaultUuid}}/get-start

Ending the data retrieval process:

Structure

{
token: The transaction token from the get-start response
Type: string
Presence: required
}
{
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

This endpoint should be called to end the data retrieval process for a vault.

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