Aliases

Unique IDs that retain all the essential information about the data without compromising its security.

Reveal multiple aliases

get

/aliases

Given a list of aliases, retrieves all associated values stored in the vault.

NOTE: This endpoint may expose sensitive data. Therefore, it is disabled by default. To enable it, please contact your VGS account manager or drop us a line at support@verygoodsecurity.com.

Authorizations

AuthorizationstringRequired

The default authentication schema.

Query parameters

aliasesstringRequired

Comma-separated list of aliases to reveal.

Example: ["tok_sandbox_5UpnbMvaihRuRwz5QXwBFw,tok_sandbox_9ToiJHedw1nE1Jfx1qYYgz"]

storagestringOptional

PERSISTENT or VOLATILE storage

Example: ["PERSISTENT"]

Responses

200

application/json

default

Something went wrong

application/json

get/aliases

cURL

curl https://api.sandbox.verygoodvault.com/aliases?aliases={{alias1}},{{alias2}}?storage=PERSISTENT \
 -u "$USERNAME:$PASSWORD"

{
  "data": {
    "tok_sandbox_5UpnbMvaihRuRwz5QXwBFw": {
      "value": "476673481",
      "classifiers": [
        "bank-account"
      ],
      "aliases": [
        {
          "value": "tok_sandbox_5UpnbMvaihRuRwz5QXwBFw",
          "format": "UUID"
        }
      ],
      "created_at": "2019-08-10T11:45:30Z",
      "storage": "VOLATILE"
    },
    "tok_sandbox_9ToiJHedw1nE1Jfx1qYYgz": {
      "value": "750360025",
      "classifiers": [
        "bank-account"
      ],
      "aliases": [
        {
          "value": "tok_sandbox_9ToiJHedw1nE1Jfx1qYYgz",
          "format": "UUID"
        }
      ],
      "created_at": "2019-08-10T11:45:30Z",
      "storage": "VOLATILE"
    }
  }
}

Create aliases

post

/aliases

Stores multiple values at once & returns their aliases.

Alternatively, this endpoint may be used to associate additional (i.e. secondary) aliases with the same underlying data as the reference alias specified in the request body.

NOTE: You cannot reference the same alias more than once in a single request.

Authorizations

AuthorizationstringRequired

The default authentication schema.

Body

Responses

201

Created

application/json

default

Something went wrong

application/json

post/aliases

cURL

curl https://api.sandbox.verygoodvault.com/aliases \
 -X POST \
 -u "$USERNAME:$PASSWORD" \
 -H 'Content-Type: application/json' \
 -d '{
    "data": [
    {
      "value": "test@example.com",
      "classifiers": [
        "email_address"
      ],
      "format": "UUID",
      "storage": "VOLATILE"
    }
    ]
  }'

{
  "data": [
    {
      "value": 122105155,
      "classifiers": [
        "bank-account"
      ],
      "aliases": [
        {
          "alias": "tok_sandbox_bhtsCwFUzoJMw9rWUfEV5e",
          "format": "UUID"
        }
      ],
      "created_at": "2019-05-15T12:30:45Z",
      "storage": "PERSISTENT"
    }
  ]
}

Batch Delete Aliases

post

/aliases/delete

Deletes multiple aliases.

Authorizations

AuthorizationstringRequired

The default authentication schema.

Body

Format for batch requests (limit 20)

datastring[]Optional

storagestring · enumOptionalPossible values:

Responses

204

No Content

No content

404

Not Found

post/aliases/delete

cURL

curl -v https://api.sandbox.verygoodvault.com/aliases/delete -d \
  '{"storage":"VOLATILE","data":["tok_whjuj6F8r3f2KeCpY7RPCE"]}' \ 
-H 'Content-Type: application/json' \
-u "$USERNAME:$PASSWORD"

No content

Reveal single alias

get

/aliases/{alias}

Retrieves a stored value along with its aliases.

NOTE: This endpoint may expose sensitive data. Therefore, it is disabled by default. To enable it, please contact your VGS account manager or drop us a line at support@verygoodsecurity.com.

Authorizations

AuthorizationstringRequired

The default authentication schema.

Path parameters

aliasstringRequired

Alias to operate on.

Example: tok_sandbox_bhtsCwFUzoJMw9rWUfEV5e

Query parameters

storagestring · enumOptionalDefault: PERSISTENTPossible values:

Responses

200

application/json

default

Something went wrong

application/json

get/aliases/{alias}

cURL

curl https://api.sandbox.verygoodvault.com/aliases/{{alias}}?storage=PERSISTENT \
 -u "$USERNAME:$PASSWORD"

{
  "data": [
    {
      "value": 122105155,
      "classifiers": [
        "bank-account"
      ],
      "aliases": [
        {
          "alias": "tok_sandbox_bhtsCwFUzoJMw9rWUfEV5e",
          "format": "UUID"
        }
      ],
      "created_at": "2019-05-15T12:30:45Z",
      "storage": "PERSISTENT"
    }
  ]
}

Update data classifiers

put

/aliases/{alias}

Apply new classifiers to the value that the specified alias is associated with.

Authorizations

AuthorizationstringRequired

The default authentication schema.

Path parameters

aliasstringRequired

Alias to operate on.

Example: tok_sandbox_bhtsCwFUzoJMw9rWUfEV5e

Query parameters

storagestring · enumOptionalDefault: PERSISTENTPossible values:

Body

Responses

204

No Content

No content

default

Something went wrong

application/json

put/aliases/{alias}

cURL

curl https://api.sandbox.verygoodvault.com/aliases/{{alias}} \
 -X PUT \
 -u "$USERNAME:$PASSWORD" \
 -H 'Content-Type: application/json' \
 -d '{
    "data": {
      "classifiers": [
        "credit-cards", "PII"
      ]
    }
  }'

No content

Delete alias

delete

/aliases/{alias}

Removes a single alias.

Authorizations

AuthorizationstringRequired

The default authentication schema.

Path parameters

aliasstringRequired

Alias to operate on.

Example: tok_sandbox_bhtsCwFUzoJMw9rWUfEV5e

Query parameters

storagestring · enumOptionalDefault: PERSISTENTPossible values:

Responses

204

No Content

No content

default

Something went wrong

application/json

delete/aliases/{alias}

cURL

curl https://api.sandbox.verygoodvault.com/aliases/{{alias}}?storage=PERSISTENT \
 -X DELETE \
 -u "$USERNAME:$PASSWORD"

No content

PreviousResource Limits NextVault APIs and Region

Last updated 3 months ago