How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Very Good Security aliases API

Tokenization operations on the VGS Vault HTTP API.

Very Good Security aliases API is one of 4 APIs that Very Good Security publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Aliases. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 5 operations across 2 paths, and defines 8 schemas. It is described by OpenAPI 3.0.1, at version 1.0.

Requests are made against 4 base URLs: https://api.sandbox.verygoodvault.com, https://api.live.verygoodvault.com, https://api.live-eu-1.verygoodvault.com, https://accounts.apps.verygoodsecurity.com.

5 operations 2 paths 8 schemas 1 DELETE2 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.0
Base URL
https://api.sandbox.verygoodvault.com
Authentication
HTTP Basic, HTTP Bearer
Terms of Service
Resource Areas
1

Authentication & Security 2

Very Good Security aliases API declares 2 security schemes for authenticating requests. It accepts HTTP basic authentication (basicAuth). It accepts HTTP bearer tokens (JWT) (bearerAuth).

  • basicAuth — HTTP Basic authentication used by the VGS Vault HTTP API. Username and password are the vault access credentials generated in the VGS dashboard.
  • bearerAuth — Bearer access token used by the VGS Accounts API. Obtain the token from the OAuth2 client-credentials endpoint at https://auth.verygoodsecurity.com/auth/realms…

Paths & Operations 5

Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

aliases 5

Tokenization operations on the VGS Vault HTTP API.

POST
/aliases
Create aliases
createAliases body → 201default
GET
/aliases
Reveal multiple aliases
revealMultipleAliases 1 param → 200default
GET
/aliases/{alias}
Reveal single alias
revealAlias 1 param → 200default
PUT
/aliases/{alias}
Update data classifiers
updateAlias 1 param body → 204default
DELETE
/aliases/{alias}
Delete alias
deleteAlias 1 param → 204default

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are RevealedData (5 properties), CreateAliasesRequestNew (4 properties), ApiError (4 properties), CreateAliasesRequestReference (2 properties). Each schema is shown below with its type and property counts.

CreateAliasesRequest
object
1 property 1 required
RevealedData
object
5 properties
CreateAliasesRequestReference
object
2 properties 2 required
AliasFormat
string
Format of the generated alias string.
CreateAliasesRequestNew
object
4 properties 2 required
Alias
object
2 properties
UpdateAliasRequest
object
1 property 1 required
ApiError
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

vgs-aliases-api-openapi.yml Raw ↑

Other APIs Very Good Security publishes across the network.

Very Good Security organizations API
Very Good Security routes API
Very Good Security vaults API
Where this information came from

This is an independent, third-party profile of Very Good Security aliases API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.