{ "info": { "_postman_id": "4ef49add-ae71-448a-ba4b-05f996feb735", "name": "Vault HTTP aliases API", "description": "The VGS Vault HTTP API is used for storing, retrieving, and managing sensitive data (aka Tokenization) within a VGS Vault.\n\nThe VGS API is organized around REST. Our API is built with a predictable resource-oriented structure, uses JSON-encoded requests and responses, follows standard HTTP verbs/responses, and uses industry standard authentication.\n\n## What is VGS\n\nStoring sensitive data on your company\u2019s infrastructure often comes with a heavy compliance burden. For instance, storing payments data yourself greatly increases the amount of work needed to become PCI compliant. It also increases your security risk in general. To combat this, companies will minimize the amount of sensitive information they have to handle or store.\n\nVGS provides multiple methods for minimizing the sensitive information that needs to be stored which allows customers to secure any type of data for any use-case.\n\n**Tokenization** is a method that focuses on securing the storage of data. This is the quickest way to get started and is free. [Get started with Tokenization](https://www.verygoodsecurity.com/docs/tokenization/getting-started).\n\n**Zero Data** is a unique method invented by VGS in 2016 that securely stores data like Tokenization, however it also removes the customer\u2019s environment from PCI scope completely providing maximum security, and minimum compliance scope. [Get started with Zero Data](https://www.verygoodsecurity.com/docs/getting-started/before-you-start).\n\nAdditionally, for scenarios where neither technology is a complete solution, for instance with legacy systems, VGS provides a compliance product which guarantees customers are able to meet their compliance needs no matter what may happen. [Get started with Control](https://www.verygoodsecurity.com/docs/control).\n\n## Learn about Tokenization\n\n- [Create an Account for Free Tokenization](https://dashboard.verygoodsecurity.com/tokenization)\n- [Try a Tokenization Demo](https://www.verygoodsecurity.com/docs/tokenization/getting-started)\n- [Install a Tokenization SDK](https://www.verygoodsecurity.com/docs/tokenization/client-libraries)\n\n### Authentication\n\nThis API uses `Basic` authentication.\n\nCredentials to access the API can be generated on the\n[dashboard](https://dashboard.verygoodsecurity.com) by going to the Settings\nsection of the vault of your choosing.\n\n[Docs \u00bb Guides \u00bb Access credentials](https://www.verygoodsecurity.com/docs/settings/access-credentials)\n\n## Resource Limits\n\n### Data Limits\n\nThis API allows storing data up to 32MB in size.\n\n### Rate Limiting\n\nThe API allows up to 3,000 requests per minute. Requests are associated with\nthe vault, regardless of the access credentials used to authenticate the\nrequest.\n\nYour current rate limit is included as HTTP headers in every API response:\n\n| Header Name | Description |\n|-------------------------|----------------------------------------------------------|\n| `x-ratelimit-remaining` | The number of requests remaining in the 1-minute window. |\n\nIf you exceed the rate limit, the API will reject the request with HTTP\n[429 Too Many Requests](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429).\n\n### Errors\n\nThe API uses standard HTTP status codes to indicate whether the request\nsucceeded or not.\n\nIn case of failure, the response body will be JSON in a predefined format.\nFor example, trying to create too many aliases at once results in the\nfollowing response:\n\n```json\n{\n \"errors\": [\n {\n \"status\": 400,\n \"title\": \"Bad request\",\n \"detail\": \"Too many values (limit: 20)\",\n \"href\": \"https://api.sandbox.verygoodvault.com/aliases\"\n }\n ]\n}\n```\n\n\nContact Support:\n Email: support@verygoodsecurity.com", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "createdAt": "2026-07-28T03:27:25.000Z", "updatedAt": "2026-07-28T03:27:25.000Z", "lastUpdatedBy": "35240", "uid": "35240-4ef49add-ae71-448a-ba4b-05f996feb735" }, "item": [ { "name": "aliases", "item": [ { "name": "{alias}", "item": [ { "name": "Reveal single alias", "id": "4aa0248a-a32c-49c8-9e79-c07f620d95ae", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/aliases/:alias", "host": [ "{{baseUrl}}" ], "path": [ "aliases", ":alias" ], "variable": [ { "id": "5c5f3318-9e66-400f-ab81-a3a5d35f88fd", "key": "alias", "value": "", "description": "(Required) Alias to operate on." } ] }, "description": "Retrieves a stored value along with its aliases.\n\n**NOTE:** This endpoint may expose sensitive data. Therefore, it is\ndisabled by default. To enable it, please contact your VGS account\nmanager or drop us a line at\n[support@verygoodsecurity.com](mailto:support@verygoodsecurity.com).\n" }, "response": [ { "id": "729e9dfd-a2d3-4c14-b765-db1db700f67d", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/aliases/:alias", "host": [ "{{baseUrl}}" ], "path": [ "aliases", ":alias" ], "variable": [ { "key": "alias" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"value\": \"\",\n \"classifiers\": [\n \"\",\n \"\"\n ],\n \"aliases\": [\n {\n \"alias\": \"\",\n \"format\": \"FPE_SIX_T_FOUR\"\n },\n {\n \"alias\": \"\",\n \"format\": \"UUID\"\n }\n ],\n \"created_at\": \"\",\n \"storage\": \"PERSISTENT\"\n }\n ]\n}", "createdAt": "2026-07-28T03:27:25.000Z", "updatedAt": "2026-07-28T03:27:25.000Z", "uid": "35240-729e9dfd-a2d3-4c14-b765-db1db700f67d" }, { "id": "f1c5e9c8-dc92-44d1-962a-9b184259180f", "name": "Something went wrong", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/aliases/:alias", "host": [ "{{baseUrl}}" ], "path": [ "aliases", ":alias" ], "variable": [ { "key": "alias" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"status\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"href\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T03:27:25.000Z", "updatedAt": "2026-07-28T03:27:25.000Z", "uid": "35240-f1c5e9c8-dc92-44d1-962a-9b184259180f" } ], "createdAt": "2026-07-28T03:27:25.000Z", "updatedAt": "2026-07-28T03:27:25.000Z", "uid": "35240-4aa0248a-a32c-49c8-9e79-c07f620d95ae" }, { "name": "Update data classifiers", "id": "5c0232bb-c7b8-4501-a276-fcf42ae87398", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"classifiers\": [\n \"\",\n \"\"\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/aliases/:alias", "host": [ "{{baseUrl}}" ], "path": [ "aliases", ":alias" ], "variable": [ { "id": "8e0bf80b-7a1a-4ee0-b01e-1936c1d4b5d2", "key": "alias", "value": "", "description": "(Required) Alias to operate on." } ] }, "description": "Apply new classifiers to the value that the specified alias is\nassociated with.\n" }, "response": [ { "id": "9021bfa1-c1ad-4c26-a442-a1d1ef56478a", "name": "No Content", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"classifiers\": [\n \"\",\n \"\"\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/aliases/:alias", "host": [ "{{baseUrl}}" ], "path": [ "aliases", ":alias" ], "variable": [ { "key": "alias" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T03:27:25.000Z", "updatedAt": "2026-07-28T03:27:25.000Z", "uid": "35240-9021bfa1-c1ad-4c26-a442-a1d1ef56478a" }, { "id": "db2e3e7b-0500-475c-91f0-a358743b9c84", "name": "Something went wrong", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"classifiers\": [\n \"\",\n \"\"\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/aliases/:alias", "host": [ "{{baseUrl}}" ], "path": [ "aliases", ":alias" ], "variable": [ { "key": "alias" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"status\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"href\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T03:27:25.000Z", "updatedAt": "2026-07-28T03:27:25.000Z", "uid": "35240-db2e3e7b-0500-475c-91f0-a358743b9c84" } ], "createdAt": "2026-07-28T03:27:25.000Z", "updatedAt": "2026-07-28T03:27:25.000Z", "uid": "35240-5c0232bb-c7b8-4501-a276-fcf42ae87398" }, { "name": "Delete alias", "id": "5dfe269f-f170-4221-93cf-2dc04a095e30", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/aliases/:alias", "host": [ "{{baseUrl}}" ], "path": [ "aliases", ":alias" ], "variable": [ { "id": "4d6f9940-6887-49fa-b4b8-296716779c3b", "key": "alias", "value": "", "description": "(Required) Alias to operate on." } ] }, "description": "Removes a single alias.\n" }, "response": [ { "id": "1d1f35fd-02ef-4c2a-bdee-dcdf60c7e5d2", "name": "No Content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/aliases/:alias", "host": [ "{{baseUrl}}" ], "path": [ "aliases", ":alias" ], "variable": [ { "key": "alias" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T03:27:25.000Z", "updatedAt": "2026-07-28T03:27:25.000Z", "uid": "35240-1d1f35fd-02ef-4c2a-bdee-dcdf60c7e5d2" }, { "id": "e761c84d-0f03-4b48-be09-3bd3ec51b208", "name": "Something went wrong", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/aliases/:alias", "host": [ "{{baseUrl}}" ], "path": [ "aliases", ":alias" ], "variable": [ { "key": "alias" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"status\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"href\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T03:27:25.000Z", "updatedAt": "2026-07-28T03:27:25.000Z", "uid": "35240-e761c84d-0f03-4b48-be09-3bd3ec51b208" } ], "createdAt": "2026-07-28T03:27:25.000Z", "updatedAt": "2026-07-28T03:27:25.000Z", "uid": "35240-5dfe269f-f170-4221-93cf-2dc04a095e30" } ], "id": "3a050681-0b15-46bc-bbb9-aaaaee4fb45b", "createdAt": "2026-07-28T03:27:25.000Z", "updatedAt": "2026-07-28T03:27:25.000Z", "uid": "35240-3a050681-0b15-46bc-bbb9-aaaaee4fb45b" }, { "name": "Create aliases", "id": "359f1223-bf8b-430e-9703-a1751d1ebdd7", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"value\": \"\",\n \"format\": \"FPE_ACC_NUM_T_FOUR\",\n \"classifiers\": [\n \"\",\n \"\"\n ],\n \"storage\": \"PERSISTENT\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/aliases", "host": [ "{{baseUrl}}" ], "path": [ "aliases" ] }, "description": "Stores multiple values at once & returns their aliases.\n\nAlternatively, this endpoint may be used to associate additional (i.e.\nsecondary) aliases with the same underlying data as the reference\nalias specified in the request body.\n\n**NOTE:** You cannot reference the same alias more than once in a\nsingle request.\n" }, "response": [ { "id": "d56ef611-bf9f-4f6b-97eb-17356063de22", "name": "Created", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"value\": \"\",\n \"format\": \"FPE_ACC_NUM_T_FOUR\",\n \"classifiers\": [\n \"\",\n \"\"\n ],\n \"storage\": \"PERSISTENT\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/aliases", "host": [ "{{baseUrl}}" ], "path": [ "aliases" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"value\": \"\",\n \"classifiers\": [\n \"\",\n \"\"\n ],\n \"aliases\": [\n {\n \"alias\": \"\",\n \"format\": \"PFPT\"\n },\n {\n \"alias\": \"\",\n \"format\": \"FPE_ACC_NUM_T_FOUR\"\n }\n ],\n \"created_at\": \"\",\n \"storage\": \"PERSISTENT\"\n },\n {\n \"value\": \"\",\n \"classifiers\": [\n \"\",\n \"\"\n ],\n \"aliases\": [\n {\n \"alias\": \"\",\n \"format\": \"FPE_ACC_NUM_T_FOUR\"\n },\n {\n \"alias\": \"\",\n \"format\": \"FPE_SSN_T_FOUR\"\n }\n ],\n \"created_at\": \"\",\n \"storage\": \"PERSISTENT\"\n }\n ]\n}", "createdAt": "2026-07-28T03:27:25.000Z", "updatedAt": "2026-07-28T03:27:25.000Z", "uid": "35240-d56ef611-bf9f-4f6b-97eb-17356063de22" }, { "id": "b76a4a83-35fc-4f69-8af3-4c4c1b3eaeb9", "name": "Something went wrong", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"data\": [\n {\n \"value\": \"\",\n \"format\": \"FPE_ACC_NUM_T_FOUR\",\n \"classifiers\": [\n \"\",\n \"\"\n ],\n \"storage\": \"PERSISTENT\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/aliases", "host": [ "{{baseUrl}}" ], "path": [ "aliases" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"status\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"href\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T03:27:25.000Z", "updatedAt": "2026-07-28T03:27:25.000Z", "uid": "35240-b76a4a83-35fc-4f69-8af3-4c4c1b3eaeb9" } ], "createdAt": "2026-07-28T03:27:25.000Z", "updatedAt": "2026-07-28T03:27:25.000Z", "uid": "35240-359f1223-bf8b-430e-9703-a1751d1ebdd7" }, { "name": "Reveal multiple aliases", "id": "6c097493-fbfa-471d-a3f3-97d3b067fa91", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/aliases?q=", "host": [ "{{baseUrl}}" ], "path": [ "aliases" ], "query": [ { "description": "(Required) Comma-separated list of aliases to reveal.", "key": "q", "value": "" } ] }, "description": "Given a list of aliases, retrieves all associated values stored in the\nvault.\n\n**NOTE:** This endpoint may expose sensitive data. Therefore, it is\ndisabled by default. To enable it, please contact your VGS account\nmanager or drop us a line at\n[support@verygoodsecurity.com](mailto:support@verygoodsecurity.com).\n" }, "response": [ { "id": "cf6ecd60-a82d-45ce-a0fb-dda094aa982e", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/aliases?q=", "host": [ "{{baseUrl}}" ], "path": [ "aliases" ], "query": [ { "description": "(Required) Comma-separated list of aliases to reveal.", "key": "q", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"sunt1\": {\n \"value\": \"\",\n \"classifiers\": [\n \"\",\n \"\"\n ],\n \"aliases\": [\n {\n \"alias\": \"\",\n \"format\": \"FPE_T_FOUR\"\n },\n {\n \"alias\": \"\",\n \"format\": \"NUM_LENGTH_PRESERVING\"\n }\n ],\n \"created_at\": \"\",\n \"storage\": \"PERSISTENT\"\n },\n \"voluptate_0\": {\n \"value\": \"\",\n \"classifiers\": [\n \"\",\n \"\"\n ],\n \"aliases\": [\n {\n \"alias\": \"\",\n \"format\": \"PFPT\"\n },\n {\n \"alias\": \"\",\n \"format\": \"NUM_LENGTH_PRESERVING\"\n }\n ],\n \"created_at\": \"\",\n \"storage\": \"PERSISTENT\"\n }\n }\n}", "createdAt": "2026-07-28T03:27:25.000Z", "updatedAt": "2026-07-28T03:27:25.000Z", "uid": "35240-cf6ecd60-a82d-45ce-a0fb-dda094aa982e" }, { "id": "511dbad2-f51e-4b4f-a9c0-56b3eb6ec04e", "name": "Something went wrong", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/aliases?q=", "host": [ "{{baseUrl}}" ], "path": [ "aliases" ], "query": [ { "description": "(Required) Comma-separated list of aliases to reveal.", "key": "q", "value": "" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"status\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"href\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T03:27:25.000Z", "updatedAt": "2026-07-28T03:27:25.000Z", "uid": "35240-511dbad2-f51e-4b4f-a9c0-56b3eb6ec04e" } ], "createdAt": "2026-07-28T03:27:25.000Z", "updatedAt": "2026-07-28T03:27:25.000Z", "uid": "35240-6c097493-fbfa-471d-a3f3-97d3b067fa91" } ], "id": "1fdbdbd9-12e4-4c44-b5f0-4229f891306a", "createdAt": "2026-07-28T03:27:25.000Z", "updatedAt": "2026-07-28T03:27:25.000Z", "uid": "35240-1fdbdbd9-12e4-4c44-b5f0-4229f891306a" } ], "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "variable": [ { "key": "baseUrl", "value": "https://api.sandbox.verygoodvault.com" } ] }