> For the complete documentation index, see [llms.txt](https://docs.verygoodsecurity.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.verygoodsecurity.com/cmp/platform/getting-started.md).

# Getting Started

## Getting Started with VGS CMP <a href="#getting-started-with-vgs-cmp" id="getting-started-with-vgs-cmp"></a>

Welcome to the VGS Credential Management Platform! This guide will help you quickly set up your sandbox environment and begin managing your tenants.

### 1. Create a Sandbox Tenant <a href="#id-1-create-a-sandbox-account" id="id-1-create-a-sandbox-account"></a>

Start by creating a sandbox (test) tenant. This allows you to create your organization and experiment with the APIs without affecting your production environment.

Currently, VGS offers two Dashboard experiences that support Sandbox tenant creation:<br>

* [VGS Dashboard](https://dashboard.verygoodsecurity.com/cmp): A unified dashboard experience that supports both Credential Management Platform and Secure Data use cases. This dashboard supports all current-state secure data tooling, as well as Sandbox tenant creation, payment credential search, visibility on individual credential details, and configuration of CMP tenants.

<details>

<summary>Create a Sandbox tenant through the VGS Dashboard (preferred):</summary>

1. Log in and authenticate to the [VGS Dashboard](https://dashboard.verygoodsecurity.com/cmp), and confirm that your preferred Organization is selected as the active Organization first - this is the Organization the account will be associated to. \
   \
   You can set your active Org by using the dropdown menu next to the title of the Organization reflected in the upper-left of the dashboard. To manage your Organizations, go to *Organization Settings*.&#x20;

2. Navigate to the 'Tenant' scope selector, and select "Create new tenant"

<figure><img src="https://236204706-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fg1pA9re6lCmtaiQAnvjh%2Fuploads%2F4odlOTzWQREuXQCwOfv1%2FScreenshot%202026-08-05%20at%201.30.10%E2%80%AFPM.png?alt=media&amp;token=bc232fce-ec23-4b73-b306-abc33e2d73e0" alt=""><figcaption></figcaption></figure>

3. Follow the guided experience to create a Sandbox account. Sandbox accounts created through the VGS Dashboard are enabled for credential management by default, and preconfigured with all available services.<br>

   <figure><img src="https://236204706-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fg1pA9re6lCmtaiQAnvjh%2Fuploads%2FjvtquQxVLDcZthK11oHF%2FScreenshot%202025-10-02%20at%203.31.46%E2%80%AFPM.png?alt=media&amp;token=caebdebf-313b-4946-8cdf-555303a96f5e" alt="" width="375"><figcaption></figcaption></figure>

4. Once the Sandbox tenant is created, locate the Tenant ID by navigating to *Tenant* *Settings*.<br>

   <figure><img src="https://236204706-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fg1pA9re6lCmtaiQAnvjh%2Fuploads%2FA7SkYq0Cdk7oT0ddE14N%2FScreenshot%202026-08-05%20at%201.31.32%E2%80%AFPM.png?alt=media&amp;token=956baf29-352a-4724-9440-0b5b2e4daab3" alt=""><figcaption></figcaption></figure>

</details>

* [Vault Dashboard](https://dashboard.verygoodsecurity.com): A distinct experience for users of VGS Secure Data products and services, with support for vault/tenant creation, service tenant creation, access credential creation, notifications, route set up, VGS Collect, vaulting, and more.

<details>

<summary>Create a Sandbox tenant through the Vault Dashboard</summary>

1. Log in and authenticate to the [Vault Dashboard](https://dashboard.verygoodsecurity.com) and locate the *Vault* dropdown in the header. Beneath the name of each Vault (also known as a *Tenant*), an alphanumeric ID is visible.\
   \
   Note: To change the name of a Vault/Tenant, navigate to [Vault Dashboard](https://dashboard.verygoodsecurity.com) *> Vault > Vault settings.*<br>

   <figure><img src="https://236204706-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fg1pA9re6lCmtaiQAnvjh%2Fuploads%2F7kaEszG2OimecOgkPe06%2FScreenshot%202025-10-02%20at%203.20.21%E2%80%AFPM.png?alt=media&amp;token=01927d89-e588-47a5-875d-1851c59f37ba" alt="" width="563"><figcaption></figcaption></figure>

2. Click the "+New" element within the dropdown to initiate the process of opening a new Sandbox account.<br>

3. Define a name, region, and confirm the Vault/Tenant environment as Sandbox, then click 'Create Vault.'

4. Once the Vault/Tenant is created, locate alphanumeric Tenant ID and follow the next steps.<br>

   <figure><img src="https://236204706-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fg1pA9re6lCmtaiQAnvjh%2Fuploads%2Fww5Xgt9xOoeAQwQ82bnR%2FScreenshot%202025-10-02%20at%201.29.26%E2%80%AFPM.png?alt=media&amp;token=fa74f84e-2b11-4d24-ba88-92b8542b5561" alt="" width="563"><figcaption></figcaption></figure>

</details>

{% hint style="info" %}
Please note that for security reasons, all dashboard experience sessions automatically expire after 20 minutes.
{% endhint %}

### 2. Set Up Services <a href="#id-2-getting-set-up-with-services" id="id-2-getting-set-up-with-services"></a>

Sandbox tenants created within the [VGS Dashboard](https://dashboard.verygoodsecurity.com/cmp) are enabled for credential management by default, and are preconfigured with all available CMP services enabled.

To create a Sandbox tenant *that is not enabled for credential management*, please contact **<support@vgs.io>**.

If not relying on the Dashboard experience, follow these steps to begin managing your tenants:<br>

* **Locate Your Tenant ID:** Identify and record your Tenant ID (also referred to as a *Vault Id*), which is the unique identifier for your tenant. This identifier always begins with prefix *tnt*, and can be found under Tenant Settings.
* **Identify Your Services:** Choose the desired card services from the [Configuration Options](/cmp/platform/cmp-account.md#account-configuration-options) section to tailor your tenant to your specific needs.
* **Contact Customer Support**: Once you have identified which services you want applied to the Sandbox tenant, contact <support@vgs.io> with your Tenant ID to assist with tenant configuration.

#### What happens when I'm done testing and ready to take my changes Live?

When you're ready to begin leveraging VGS in your real business environment, use the **Activate Organization** option in 'Organization Settings' in the [VGS Dashboard](https://dashboard.verygoodsecurity.com/cmp). You'll be asked to submit necessary business data, agree to our [Standard Master Services Agreement](https://www.verygoodsecurity.com/vgs-msa), and begin collaborating directly with our customer success team. \
\
If you have specific questions about activating an existing tenant from Sandbox to Live, reach out to <support@vgs.io>

The next section will cover key actions needed to properly authenticate your new tenant and ensure credential data flows securely. &#x20;


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.verygoodsecurity.com/cmp/platform/getting-started.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.