Very Good Security

https://docs.verygoodsecurity.com
Admin
Very Good Security (VGS) is a payment data protection platform providing PCI-compliant vaults, card...
Tokens:322,648
Snippets:3,184
Trust Score:10
Update:2 months ago
Show doc for...
Tokens:
Raw
### Install Maven

Source: https://docs.verygoodsecurity.com/vault/developer-tools/larky/test-larky-locally.md

Installs Maven and initializes the local settings configuration.

```bash
brew install maven
mkdir ~/.m2
touch ~/.m2/settings.xml
# You will need to copy the contents of the settings.xml 
# from GitHub to your repo, placing your credentials in it
```

--------------------------------

### Install OpenJDK 16

Source: https://docs.verygoodsecurity.com/vault/developer-tools/larky/test-larky-locally.md

Installs AdoptOpenJDK 16 and registers it with jenv.

```bash
brew tap AdoptOpenJDK/openjdk
brew search /adoptopenjdk/
    ==> Casks
    adoptopenjdk-jre                      adoptopenjdk12                        adoptopenjdk14                        adoptopenjdk16 ✔
    adoptopenjdk-openj9                   adoptopenjdk12-jre                    adoptopenjdk14-jre                    adoptopenjdk16-jre
    adoptopenjdk-openj9-jre               adoptopenjdk12-openj9                 adoptopenjdk14-openj9                 adoptopenjdk16-openj9
    adoptopenjdk-openj9-jre-large         adoptopenjdk12-openj9-jre             adoptopenjdk14-openj9-jre             adoptopenjdk16-openj9-jre
    adoptopenjdk-openj9-large             adoptopenjdk12-openj9-jre-large       adoptopenjdk14-openj9-jre-large       adoptopenjdk8 ✔
    adoptopenjdk10                        adoptopenjdk12-openj9-large           adoptopenjdk14-openj9-large           adoptopenjdk8-jre
    adoptopenjdk11 ✔                      adoptopenjdk13                        adoptopenjdk15                        adoptopenjdk8-openj9
    adoptopenjdk11-jre                    adoptopenjdk13-jre                    adoptopenjdk15-jre                    adoptopenjdk8-openj9-jre
    adoptopenjdk11-openj9                 adoptopenjdk13-openj9                 adoptopenjdk15-openj9                 adoptopenjdk8-openj9-jre-large
    adoptopenjdk11-openj9-jre             adoptopenjdk13-openj9-jre             adoptopenjdk15-openj9-jre             adoptopenjdk8-openj9-large
    adoptopenjdk11-openj9-jre-large       adoptopenjdk13-openj9-jre-large       adoptopenjdk15-openj9-jre-large       adoptopenjdk9
    adoptopenjdk11-openj9-large           adoptopenjdk13-openj9-large           adoptopenjdk15-openj9-large           adoptopenjdk
brew install --cask adoptopenjdk16
jenv add /Library/Java/JavaVirtualMachines/adoptopenjdk-16.jdk/Contents/Home
jenv enable-plugin export
exec $SHELL -l
```

--------------------------------

### Install VGS Show SDK

Source: https://docs.verygoodsecurity.com/vault/developer-tools/vgs-show/react-native-sdk/integration.md

Install the SDK package via npm.

```bash
npm install @vgs/show-react-native
```

--------------------------------

### Configure and Install a Custom Opener

Source: https://docs.verygoodsecurity.com/vault/developer-tools/larky/library-api/request.md

Demonstrates setting up authentication and proxy handlers, building a custom opener, and installing it as the default for subsequent urlopen calls.

```python
# set up authentication info
authinfo = urllib.request.HTTPBasicAuthHandler()
authinfo.add_password(realm='PDQ Application',
...                      uri='https://mahler:8092/site-updates.py',
...                      user='klem',
...                      passwd='geheim$parole')
proxy_support = urllib.request.ProxyHandler({"http" : "http://ahad-haam:3128"})
# build a new opener that adds authentication and caching FTP handlers
opener = urllib.request.build_opener(proxy_support, authinfo,
                                     urllib.request.CacheFTPHandler)
# install it
urllib.request.install_opener(opener)
f = urllib.request.urlopen('https://www.python.org/')
```

--------------------------------

### VGSCardTextFieldRepresentable Implementation Example

Source: https://docs.verygoodsecurity.com/vault/developer-tools/vgs-collect/ios-sdk/swiftui-components.md

A complete example showing configuration, custom icon setup, and component usage with modifiers.

```swift
// Setup  VGSConfiguration
var cardNumConfiguration: VGSConfiguration {
  let config = VGSConfiguration(collector: vgsCollect, fieldName: "card_number")
  config.type = .cardNumber
  return config
}
/// Set card brand icons globally
VGSPaymentCards.visa.brandIcon = UIImage(named: "my visa icon")
VGSPaymentCards.unknown.brandIcon = UIImage(named: "my unknown brand icon")
/// Return VGSCardTextFieldRepresentable Component
VGSCardTextFieldRepresentable(configuration: cardNumConfiguration)
          .placeholder("4111 1111 1111 1111")
          .onStateChange { newState in
            print(newState.bin)
            print(newState.cardBrand)
            cardTextFieldState = newState
          }
          .cardIconSize(CGSize(width: 40, height: 20))
          .cardIconLocation(.right)
          .textFieldPadding(paddings)
          .border(color: (cardTextFieldState?.isValid ?? true) ? validColor : invalidColor, lineWidth: 1)
          .frame(height: 54)
```

--------------------------------

### VGS CLI Setup

Source: https://docs.verygoodsecurity.com/cmp/payment-credentials/apple-pay/create-card-apple-pay-wallet-decryption.md

Commands to install and authenticate the VGS CLI for managing Apple Pay certificates.

```bash
source .venv-pypi/bin/activate
pip install vgs-cli
vgs login
```

--------------------------------

### Complete reveal screen implementation

Source: https://docs.verygoodsecurity.com/vault/developer-tools/vgs-show/react-native-sdk/samples.md

A full example demonstrating the setup of VGSShow, VGSShowLabel, VGSShowImage, and VGSShowPdf components within a React Native screen.

```tsx
import * as React from "react";
import { Button, SafeAreaView, Text, View } from "react-native";
import {
  VGSShow,
  VGSShowError,
  VGSShowImage,
  VGSShowLabel,
  VGSShowPdf,
  type VGSShowImageRef,
  type VGSShowLabelRef,
  type VGSShowPdfRef
} from "@vgs/show-react-native";

type RevealScreenProps = {
  readonly vaultId: string;
  readonly recordAlias: string;
};

export function RevealScreen(props: RevealScreenProps): React.ReactElement {
  const showRef = React.useRef<VGSShow | null>(null);
  const cardNumberRef = React.useRef<VGSShowLabelRef | null>(null);
  const imageRef = React.useRef<VGSShowImageRef | null>(null);
  const pdfRef = React.useRef<VGSShowPdfRef | null>(null);
  const [status, setStatus] = React.useState("Ready.");

  if (showRef.current === null) {
    showRef.current = new VGSShow({
      id: props.vaultId,
      environment: "sandbox"
    });
  }

  const vgsShow = showRef.current;

  React.useEffect(() => {
    const label = cardNumberRef.current;
    if (label === null) {
      return;
    }

    label.resetAllFormatters();
    label.addTransformationRegex({
      pattern: /^(.{4})(.{4})(.{4})(.{4})$/u,
      template: "$1 $2 $3 $4"
    });
    label.setSecureText({
      ranges: [
        { start: 5, end: 8 },
        { start: 10, end: 13 }
      ]
    });
  }, []);

  async function reveal(): Promise<void> {
    setStatus("Revealing...");

    try {
      const result = await vgsShow.request({
        path: "/post",
        method: "POST",
        payload: {
          recordAlias: props.recordAlias
        }
      });

      setStatus(`Reveal completed with HTTP ${result.code}.`);
    } catch (error) {
      if (error instanceof VGSShowError) {
        setStatus(`Reveal failed (${error.code}).`);
        return;
      }

      setStatus("Reveal failed.");
    }
  }

  function clear(): void {
    cardNumberRef.current?.clearText();
    imageRef.current?.clear();
    pdfRef.current?.clear();
    setStatus("Cleared.");
  }

  return (
    <SafeAreaView>
      <View>
        <VGSShowLabel
          ref={cardNumberRef}
          vgsShow={vgsShow}
          contentPath="json.card.number"
          placeholder="**** **** **** ****"
          onRevealError={(error) => {
            setStatus(`Card number unavailable (${error.code}).`);
          }}
        />

        <VGSShowImage
          ref={imageRef}
          vgsShow={vgsShow}
          contentPath="json.card.image"
          contentMode="scaleAspectFit"
          style={{ width: "100%", height: 220 }}
          onImageError={(error) => {
            setStatus(`Image unavailable (${error.code}).`);
          }}
        />

        <VGSShowPdf
          ref={pdfRef}
          vgsShow={vgsShow}
          contentPath="json.card.statement"
          style={{ width: "100%", height: 360 }}
          pdfDisplayMode="singlePageContinuous"
          pdfDisplayDirection="vertical"
          onDocumentError={(error) => {
            setStatus(`PDF unavailable (${error.code}).`);
          }}
        />

        <Button title="Reveal" onPress={() => void reveal()} />
        <Button title="Clear" onPress={clear} />
        <Text>{status}</Text>
      </View>
    </SafeAreaView>
  );
}
```

--------------------------------

### install_opener(opener)

Source: https://docs.verygoodsecurity.com/vault/developer-tools/larky/library-api/request.md

Installs a specific OpenerDirector instance as the default global opener.

```APIDOC
## install_opener(opener)

### Description
Sets the provided OpenerDirector instance as the default opener for subsequent urlopen calls.

### Parameters
- **opener** (OpenerDirector) - Required - The opener instance to install.
```

--------------------------------

### Implement VGSCVCTextFieldRepresentable

Source: https://docs.verygoodsecurity.com/vault/developer-tools/vgs-collect/ios-sdk/swiftui-components.md

Example showing configuration setup, global icon assignment, and component instantiation with modifiers.

```swift
// Setup  VGSConfiguration
var cvcConfiguration: VGSConfiguration {
  let config = VGSConfiguration(collector: vgsCollect, fieldName: "card_cvc")
  config.type = .cvc
  return config
}
/// Set card brand icons globally(you can also set icon via `cvcIconSource(:)` modifier)
VGSPaymentCards.amex.cvcIcon = UIImage(named: "my CVC icon for Amex")
VGSPaymentCards.unknown.cvcIcon = UIImage(named: "my CVC icon for unknown brand")
/// Return VGSCVCTextFieldRepresentable Component
VGSCVCTextFieldRepresentable(configuration: cvcConfiguration)
    .placeholder("CVC/CVV")
    .setSecureTextEntry(true)
    .cvcIconSize(CGSize(width: 30, height: 20))
    .textFieldPadding(paddings)
    .border(color: (cvcTextFieldState?.isValid ?? true) ? validColor : invalidColor, lineWidth: 1)
    .frame(height: 54)
```

--------------------------------

### SwiftUI Integration Example

Source: https://docs.verygoodsecurity.com/vault/developer-tools/vgs-collect/ios-sdk/blinkcard-module.md

A complete example showing how to integrate the scanner into a SwiftUI view with text field coordination.

```swift
struct CardDataCollectionSwiftUI: View {
    /// Track BlinkCard visibility status
    @State private var showingBlinkCardScanner = false
    /// Match scanned data with apropriate text fields.
    @State private var scanedDataCoordinators: [VGSBlinkCardDataType: VGSCardScanCoordinator] = [
            .cardNumber: VGSCardScanCoordinator(),
            .name: VGSCardScanCoordinator(),
            .cvc: VGSCardScanCoordinator(),
            .expirationDate: VGSCardScanCoordinator()
        ]
         
    // MARK: - Build View
    var body: some View {
        /// setup VGSConfiguration for fields 
        /// ...
      return VStack(spacing: 8) {
        VGSTextFieldRepresentable(configuration: holderNameConfiguration)
          .placeholder("Cardholder Name")
          .cardScanCoordinator(scanedDataCoordinators[.name]!)
        VGSCardTextFieldRepresentable(configuration: cardNumConfiguration)
          .placeholder("4111 1111 1111 1111")
          .cardScanCoordinator(scanedDataCoordinators[.cardNumber]!)
        HStack(spacing: 20) {
          VGSExpDateTextFieldRepresentable(configuration: expDateConfiguration)
            .placeholder("MM/YY")
            .cardScanCoordinator(scanedDataCoordinators[.expirationDate]!)
          VGSCVCTextFieldRepresentable(configuration: cvcConfiguration)
            .placeholder("CVC")
            .cardScanCoordinator(scanedDataCoordinators[.cvc]!)
            .setSecureTextEntry(true)
        }
        HStack(spacing: 20) {
          Button(action: {
            showingBlinkCardScanner = true
          }) {
              Text("SCAN")
                  .padding()
                  .cornerRadius(8)
                  .overlay(
                      RoundedRectangle(cornerRadius: 10)
                          .stroke(Color.blue, lineWidth: 2)
                  )
          }
          .fullScreenCover(isPresented: $showingBlinkCardScanner) {
            VGSBlinkCardControllerRepresentable(licenseKey: AppCollectorConfiguration.shared.blinkCardLicenseKey!, dataCoordinators: scanedDataCoordinators) { (errorCode) in
              print(errorCode)
            }.allowInvalidCardNumber(true)
            .onCardScanned({
              showingBlinkCardScanner = false
            })
            .onCardScanCanceled({
              showingBlinkCardScanner = false
            })
          }
        }
      }
    }
}
```

--------------------------------

### Service Account Output Example

Source: https://docs.verygoodsecurity.com/vault/developer-tools/vgs-git-flow.md

Example structure of the service account configuration output.

```yaml
apiVersion: 1.0.0
kind: ServiceAccount
data:
    clientId: ACxxxxxxx-vgs-cli-xxxxx
    clientSecret: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx
    name: vgs-cli
    scopes:
      - access-logs:read
      - routes:write
      - vaults:read
```

--------------------------------

### Install and Update Pods

Source: https://docs.verygoodsecurity.com/vault/developer-tools/vgs-show/ios-sdk/integration.md

Commands to install or update project dependencies.

```bash
pod install
```

```bash
pod update
```

--------------------------------

### Install VGS Collect.js

Source: https://docs.verygoodsecurity.com/vault/developer-tools/vgs-collect/js/index.md

Include the library via CDN or install the NPM package.

```html
<script type="text/javascript" src="https://js.verygoodvault.com/vgs-collect/3.2.2/vgs-collect.js"></script>
```

```bash
$ npm i @vgs/collect-js
```

--------------------------------

### Start Docker Services

Source: https://docs.verygoodsecurity.com/enterprise-platform/core-platform/observability/accessing-vgs-metrics-via-prometheus-api/pushing-metrics-in-self-hosted-grafana-instances.md

Command to initialize the containers defined in the docker-compose.yml file.

```bash
docker-compose up -d
```

--------------------------------

### Full Integration Example - CSS

Source: https://docs.verygoodsecurity.com/vault/developer-tools/vgs-collect/js/index.md

Apply styles to the form and field containers.

```css
* {
  box-sizing: border-box;
}
form {
  width: 300px;
  margin: 0 auto;
}
.form-field {
  width: 100%;
  height: 40px;
  position: relative;
  background: white;
  margin-bottom: 10px;
  border-radius: 4px;
  box-shadow: 0 0 3px 0px rgba(0, 0, 0, .3);
  padding: 0 10px;
}
iframe {
  width: 100%;
  height: 100%;
}
.form-field-group {
  display: flex;
  flex-flow: wrap;
}
.form-field-group div {
  flex: 0 0 50%;
}
.form-field-group div:first-child {
  border-radius: 4px 0 0 4px;
}
.form-field-group div:last-child {
  border-radius: 0 4px 4px 0;
}
.form-button {
  border: 1px solid #1f8ab0;
  background-color: #3b495c;
  border-color: #3b495c;
  color: #ced5e0;
  font-family: inherit;
  border-radius: 4px;
  font-size: 16px;
  height: 35px;
  width: 100%;
}
```

--------------------------------

### VGSLabelRepresentable Usage Example

Source: https://docs.verygoodsecurity.com/vault/developer-tools/vgs-show/ios-sdk/swiftui-components.md

A complete example demonstrating formatting, security, styling, and event handling.

```swift
/// Change raw card number format
let cardNumberPattern = "(\\d{4})(\\d{4})(\\d{4})(\\d{4})"
let template = "$1 $2 $3 $4"
let regex = try! NSRegularExpression(pattern: cardNumberPattern, options: [])

VGSLabelRepresentable(vgsShow: vgsShow, contentPath: "payment_card_number")
          .placeholder("XXXX XXXX XXXX XXXX")
          .placeholderStyle(VGSPlaceholderLabelStyle())
          .setSecureText(ranges: [VGSTextRange(start: 5, end: 8),
                                  VGSTextRange(start: 10, end: 13)])
          .addTransformationRegex(regex, template: template)
          .labelPaddings(UIEdgeInsets(top: 2, left: 8, bottom: 2, right: 8))
          .onContentDidChange({
            print("-card number label updated")
          })
          .onRevealError({ error in
            print("-card number label error: \(error)")
          })
          .border(color: .gray, lineWidth: 1)
          .frame(height: 54)
```

--------------------------------

### Submit Data Example

Source: https://docs.verygoodsecurity.com/vault/developer-tools/vgs-collect/react-native-sdk/submit-data.md

Example of initializing VGSCollect and submitting data to a backend endpoint.

```javascript
// Setup your vauldId and environment
const collector = new VGSCollect('vaultId', 'sandbox');

try {
    const { status, response } = await collector.submit('/post', 'POST');
    if (response.ok) {
    try {
        const responseBody = await response.json();
        const json = JSON.stringify(responseBody, null, 2);
        console.log('Success:', json);
    } catch (error) {
        console.warn(
        'Error parsing response body. Body can be empty or your <vaultId> is wrong!',
        error
        );
    }
    } else {
    console.warn(`Server responded with error: ${status}\n${response}`);
    if (status === 400) {
        console.error('Bad request! Check your VGSCollect config and input.');
    } else if (status === 500) {
        console.error('Server issue! Try again later.');
    }
    }
} catch (error) {
    if (error instanceof VGSError) {
    switch (error.code) {
        case VGSErrorCode.InputDataIsNotValid:
        for (const fieldName in error.details) {
            console.error(
            `Not valid fieldName: ${fieldName}: ${error.details[fieldName].join(', ')}`
            );
        }
        break;
        default:
        console.error('VGSError:', error.code, error.message);
    }
    } else {
    console.error('Network or unexpected error:', error);
    }
}
```

--------------------------------

### Start and Run CLI Container

Source: https://docs.verygoodsecurity.com/vault/developer-tools/vgs-cli/docker.md

Commands to start the container in detached mode or run a specific version.

```bash
docker-compose up -d cli
```

```bash
VERSION=<VERSION> docker-compose up -d cli
```

--------------------------------

### Full Integration Example - HTML

Source: https://docs.verygoodsecurity.com/vault/developer-tools/vgs-collect/js/index.md

Structure the HTML form with containers for VGS fields.

```html
<script type="text/javascript" src="https://js.verygoodvault.com/vgs-collect/3.2.2/vgs-collect.js"></script>
<form id="collect-form">
  <div id="cc-holder" class="form-field"></div>
  <div id="cc-number" class="form-field"></div>
  <div class="form-field-group">
    <div id="cc-expiration-date" class="form-field"></div>
    <div id="cc-cvc" class="form-field"></div>
  </div>
  <button type="submit" className="form-button">Submit</button>
</form>
```

--------------------------------

### Configure Regional VGSShow Instances

Source: https://docs.verygoodsecurity.com/vault/developer-tools/vgs-show/react-native-sdk/integration.md

Examples of initializing VGSShow for specific data regions.

```ts
const sandboxEuShow = new VGSShow({
  id: config.vaultId,
  environment: "sandbox",
  dataRegion: "eu-1"
});

const liveEuShow = new VGSShow({
  id: config.vaultId,
  environment: "live-eu1"
});
```

--------------------------------

### GET /cmp/platform/getting-started.md

Source: https://docs.verygoodsecurity.com/cmp/platform/getting-started.md

Performs a dynamic query against the documentation to retrieve answers, excerpts, and sources based on a specific question and optional goal.

```APIDOC
## GET /cmp/platform/getting-started.md

### Description
Queries the documentation dynamically to retrieve information not explicitly found in the current page. This allows for natural language questions to be answered using the documentation content.

### Method
GET

### Endpoint
https://docs.verygoodsecurity.com/cmp/platform/getting-started.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question written in natural language.
- **goal** (string) - Optional - Describes the broader end goal to help tailor the response.
```

--------------------------------

### GET Response for MPAN Card

Source: https://docs.verygoodsecurity.com/cmp/developer-resources/guides/testing/wallet-decrypt.md

Example of a successful GET response for an MPAN card, including merchant token identifiers.

```json
{
  "data": {
    "id": "CRDm3dzAeDCnfkwfqTEufFtz6",
    "type": "cards",
    "attributes": {
      "pan": "4111111111111222",
      "cvc_status": "not-set",
      "exp_month": 11,
      "exp_year": 27,
      "cardholder": {},
      "token_type": "mpan",
      "wallet_type": "apple_pay",
      "pan_alias": "tok_sandbox_kQy6qwjCP2NGGExD81dRpa",
      "bin": "411111",
      "first8": "41111111",
      "last4": "1222",
      "card_fingerprint": "b3p67ZCV6FcVnx9WtyKH2EQtfeax7yyq9cdvSm7k7rRX",
      "created_at": "2026-03-11T01:52:11.803918",
      "updated_at": "2026-03-11T01:52:11.803919",
      "wallet_details": {
        "device_manufacturer_identifier": "040010030299",
        "payment_data_type": "MerchantToken",
        "merchant_token_identifier": "DNITHE302308980001846",
        "payment_method": {
          "display_name": "Visa 0121",
          "network": "Visa",
          "type": "credit"
        }
      }
    }
  },
  "metadata": {
    "observability": {
      "trace_id": "d88aa1542357f9ae5be8b3f53df79762",
      "client_id": "AChkBQQGH-3DS-scope-61fC0",
      "vault_id": "tntiugemxfd",
      "account_id": "ACT9eeBkBsxXe9wWJkQdpG2kC",
      "fingerprint": "4GqVMtYY8uohftF2NdrQjFSG6JsmX1gTaVFegV9uF4zsdjEdKCP7CUyc1tA"
    }
  }
}
```

--------------------------------

### GET Response for DPAN Card

Source: https://docs.verygoodsecurity.com/cmp/developer-resources/guides/testing/wallet-decrypt.md

Example of a successful GET response for a DPAN card, showing persisted wallet details.

```json
{
  "data": {
    "id": "CRDoEYk47qUtndEHR9w8kGKra",
    "type": "cards",
    "attributes": {
      "pan": "4111111111111444",
      "cvc_status": "not-set",
      "exp_month": 8,
      "exp_year": 28,
      "cardholder": {},
      "token_type": "dpan",
      "wallet_type": "apple_pay",
      "pan_alias": "tok_sandbox_kAYsfM1wyRwbJEesrnqFFi",
      "bin": "411111",
      "first8": "41111111",
      "last4": "1444",
      "card_fingerprint": "Qg3rYRJd4gjHYefhxpwfS2XkUovBwF2uVNhUPXgCj2H",
      "created_at": "2026-03-11T01:47:32.601715",
      "updated_at": "2026-03-11T01:47:32.601716",
      "wallet_details": {
        "device_manufacturer_identifier": "040010030400",
        "payment_data_type": "3DSecure",
        "payment_method": {
          "display_name": "Visa 0121",
          "network": "Visa",
          "type": "credit"
        }
      }
    }
  },
  "metadata": {
    "observability": {
      "trace_id": "707a927ca06a9db1d6ac0cc6705cdf11",
      "client_id": "AChkBQQGH-3DS-scope-61fC0",
      "vault_id": "tntiugemxfd",
      "account_id": "ACT9eeBkBsxXe9wWJkQdpG2kC",
      "fingerprint": "4GqVMtYY8uohftF2NdrQjH4TApUbjScwsB5oXACgvq8ATZkzALLtZSGYwo5"
    }
  }
}
```

--------------------------------

### Get Card API Response with Network Token

Source: https://docs.verygoodsecurity.com/agentic-commerce/provision-network-tokens-for-payments.md

Example JSON response from the Get Card endpoint showing the network_tokens object within the included array.

```json
{
  "data": {
    "id": "CRDecqZp3xRgXU3TFmtcDdzQs",
    "type": "cards",
    "attributes": {
      "pan": "4111111111111111",
      "cvc_status": "active",
      "bin": "411111",
      "first8": "41111111",
      "last4": "1111",
      "exp_month": 5,
      "exp_year": 28,
      "card_fingerprint": "6TeSCB16LtyifEAmY2goxYfSk5sALriXpefzzxh29xhu",
      "capabilities": [
        "network-tokens"
      ],
      "created_at": "2025-08-01T00:00:00Z",
      "updated_at": "2025-08-01T00:00:00Z"
    },
    "included": [
        {
            "type": "network_tokens",
            "id": "NTabcdefghijklH2Dy1BVE9iR",
            "attributes": {
                "payment_account_reference": "V0010014610000000085141000282",
                "network_token": "4124980000004244",
                "last4": "4244",
                "bin": "412492",
                "exp_month": 11,
                "exp_year": 27,
                "created_at": "2025-07-24T04:13:51.428077",
                "updated_at": "2025-07-24T04:13:51.428092",
                "state": "active"
            }
        }
    ],
    "meta": {
      "token_type": "pan"
    }
  }
}
```

--------------------------------

### Initialize Podfile

Source: https://docs.verygoodsecurity.com/vault/developer-tools/vgs-collect/ios-sdk/integration.md

Command to create a new Podfile in your project directory.

```bash
pod init
```

--------------------------------

### Configure Output Date Format

Source: https://docs.verygoodsecurity.com/vault/developer-tools/vgs-collect/ios-sdk/configuration.md

Example showing how to set input and output date formats for data transmission.

```swift
/// Change output date format from "mm/dd/yyyy" to "yyyy/mm/dd"

/// Use `VGSDateConfiguration` when you need to convert output date format
let dateConfiguration = VGSDateConfiguration(collector: vgsCollect, fieldName: "date")
dateConfiguration.type = .date
dateConfiguration.divider = "/"
dateConfiguration.formatPattern = "##/##/####"

/// Set date format that user use for input
dateConfiguration.inputDateFormat = .mmddyyyy // "mm/dd/yyyy" -> 01/02/2025

/// Set date format that will be send to your Vault
dateConfiguration.outputDateFormat = .yyyymmdd // "yyyy/mm/dd" -> 2025/01/02

/// Update validation rules, date format should be the same used in the configuration inputDateFormat
dateConfiguration.validationRules = VGSValidationRuleSet(
  rules: [
    VGSValidationRuleDateRange(
      dateFormat: .mmddyyyy,
      error: VGSValidationErrorType.date.rawValue
    )
  ]
)
```

--------------------------------

### Implement VGSExpDateTextFieldRepresentable

Source: https://docs.verygoodsecurity.com/vault/developer-tools/vgs-collect/ios-sdk/swiftui-components.md

Example showing configuration setup, input source selection, and usage of modifiers within a SwiftUI view.

```swift
// Setup  VGSExpDateConfiguration
let expDateConfiguration = VGSExpDateConfiguration(collector: vgsCollect, fieldName: "card_expirationDate")
expDateConfiguration.type = .expDate
/// Set input source if needed. Default is `VGSTextFieldInputSource.datePicker`
expDateConfiguration.inputSource = .datePicker
/// Return VGSExpDateTextFieldRepresentable Component
VGSExpDateTextFieldRepresentable(configuration: expDateConfiguration)
  .placeholder( "MM/YY")
  /// Set month picker date format as long symbols: e.g.:`January`
  .monthPickerFormat(.longSymbols)
  /// Set year picker date format as long year: e.g.:`2021`
  .yearPickerFormat(.long)
  .onStateChange { newState in
    print(newState.isValid)
  }
  .textFieldPadding(paddings)
  .frame(height: 54)
/// Output format will be same as field formatPattern:
/// "##/##" - "01/21"
/// OR
/// "##/####" - "01/2021"
```

--------------------------------

### Configuring Tokenization for Fields

Source: https://docs.verygoodsecurity.com/vault/developer-tools/vgs-collect/ios-sdk/tokenization-configuration.md

Examples of initializing tokenization configurations and overriding default parameters.

```swift
/// Use VGSCVCTokenizationConfiguration with predefined tokenization parameters
let cvcConfiguration = VGSCVCTokenizationConfiguration(collector: vgsCollect, fieldName: "card_cvc")
cvcCardNum.configuration = cvcConfiguration

/// Use VGSCardNumberTokenizationConfiguration and override tokenization format
let cardConfiguration = VGSCardNumberTokenizationConfiguration(collector: vgsCollect, fieldName: "card_number")
cardConfiguration.tokenizationParameters.format = VGSVaultAliasFormat.UUID.rawValue
cardNumber.configuration = cardConfiguration
```

--------------------------------

### Verify VGS CLI Installation

Source: https://docs.verygoodsecurity.com/vault/developer-tools/vgs-cli/getting-started.md

Checks the installed version of the VGS CLI to confirm successful installation.

```bash
vgs --version
```

--------------------------------

### Install VGS CLI via PyPI

Source: https://docs.verygoodsecurity.com/vault/developer-tools/vgs-cli/getting-started.md

Installs the latest version of the VGS CLI using pip. Requires Python 3 to be installed on the system.

```bash
pip install vgs-cli
```

--------------------------------

### Initialize VGS Show v2

Source: https://docs.verygoodsecurity.com/vault/developer-tools/vgs-show/js/changelog.md

Initialization pattern for VGS Show version 2, including the required environment and optional CNAME configuration.

```javascript

const show = VGSShow.create('<VAULT_ID>', function(state) {})
                    .setEnvironment('<ENVIRONMENT>')
                    .setCname('my-cname.com');

```

--------------------------------

### Initialize VGS Show Client

Source: https://docs.verygoodsecurity.com/vault/developer-tools/vgs-show/js/configuration.md

Client-side setup for VGS Show.js, including script inclusion, initialization, and iframe rendering.

```html
<body>
  <main>
    <!-- Iframe wrapper -->
    <div id="secret-data"></div>
  </main>
  <!-- Show.js script file -->
  <script type="text/javascript" src="https://js.verygoodvault.com/vgs-show/2.0.0/<organization-id>.js"></script>
  <script>
    // Show.js initialization
    const show = VGSShow.create('<VAULT_ID>', function(state) {
        console.log(state);
    }).setEnvironment('<ENVIRONMENT>');
    // Request configuration
    const iframe = show.request({
      name: 'secret-card-number',
      method: 'POST',
      path: '/secure-data',
      payload: {'card_number': '<alias>'},
      htmlWrapper: 'text',
      jsonPathSelector: 'json.card_number'
    });
    // iframe rendering
    iframe.render('#secret-data', { fontWeight: 'bold', color: 'blue' });
  </script>
</body>
```

--------------------------------

### Install CocoaPods

Source: https://docs.verygoodsecurity.com/vault/developer-tools/vgs-collect/ios-sdk/integration.md

Command to install the CocoaPods dependency manager on your system.

```bash
sudo gem install cocoapods
```

--------------------------------

### Configuring Multiple Data Regions

Source: https://docs.verygoodsecurity.com/vault/developer-tools/vgs-show/ios-sdk/reveal-data.md

Examples for setting up specific data regions during VGSShow initialization.

```swift
/// Check your data region, it should look like: "live-eu-1"
/// In your code follow the VGSShow initialization pattern
var vgsShow = VGSShow(id: "<VAULT_ID>", environment: .live, dataRegion: "eu-1")

///If you set enivronment as String, you can point region directly in environment string
var vgsShow = VGSShow(id: "<VAULT_ID>", environment: "live-eu-1")
```

--------------------------------

### Configure and Implement VGSImageView

Source: https://docs.verygoodsecurity.com/vault/developer-tools/vgs-show/ios-sdk/ui-components.md

Demonstrates how to subscribe a VGSImageView to the VGS Show SDK, set the content path, and implement the delegate methods to handle state changes.

```swift
class ViewController {

  // Create instances
  var imageView = VGSImageView()

  // ...

  private func configureUI() {

    // Subscribe to show SDK
    vgsShow.subscribe(imageView)

    // Configure content path
    imageView.contentPath = "<CONTENT_PATH_NAME>"

    // Set image display content mode
    imageView.imageContentMode = .scaleAspectFit

    // Set VGSImageViewDelegate to handle reveal events
    imageView.delegate = self

    // Background color.
    imageView.backgroundColor = UIColor.gray
  }

  // ...

  // Clear image content
  imageView.clear()

  // ...
}

/// Handle VGSImageViewDelegate methods
extension ViewController: VGSImageViewDelegate {
  
  func imageDidChange(in imageView: VGSImageView) {
    /// VGSImageView change image content
  }
  
  func imageView(_ imageView: VGSImageView, didFailWithError error: VGSShowError) {
    /// Handle reveal image errors
  }
}
```

--------------------------------

### GET /vault/example-integrations.md

Source: https://docs.verygoodsecurity.com/vault/example-integrations.md

Queries the documentation for specific information by providing a question and an optional goal.

```APIDOC
## GET /vault/example-integrations.md

### Description
Queries the documentation dynamically to retrieve answers, excerpts, and sources based on a natural language question.

### Method
GET

### Endpoint
https://docs.verygoodsecurity.com/vault/example-integrations.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained natural language question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response context.
```

--------------------------------

### VGSShow.create()

Source: https://docs.verygoodsecurity.com/vault/developer-tools/vgs-show/js/reference-documentation.md

Initializes a new VGS Show instance to manage secure data display.

```APIDOC
## VGSShow.create()

### Description
Creates a VGS Show instance to securely display sensitive data.

### Signature
`VGSShow.create(vaultId, stateCallback)`

### Parameters
- **vaultId** (string) - Required - The VGS organization’s unique vault ID value.
- **stateCallback** (function) - Optional - Callback that receives a state object whenever the iframe state changes.

### Example
```javascript
const show = VGSShow.create('<VAULT_ID>', (state) => { 
  console.log(state)
});
```
```

--------------------------------

### Install CocoaPods dependencies

Source: https://docs.verygoodsecurity.com/vault/developer-tools/vgs-collect/ios-sdk/blinkcard-module.md

Run the install command in your terminal after updating the Podfile.

```ruby
pod install
```

--------------------------------

### VGSImageViewRepresentable Usage Example

Source: https://docs.verygoodsecurity.com/vault/developer-tools/vgs-show/ios-sdk/swiftui-components.md

Example implementation of VGSImageViewRepresentable with modifiers in a SwiftUI view.

```swift
VGSImageViewRepresentable(vgsShow: vgsShow, contentPath: "pdf_view")
    .imageContentMode(.scaleAspectFit)
    .onContentDidChange {
        print("-Image view updated")
    }.onRevealError { error in
        print("-Image view error: \(error)")
    }
```

--------------------------------

### Example Response Headers

Source: https://docs.verygoodsecurity.com/vault/developer-tools/larky/code-examples/headers.md

Sample JSON output showing the resulting headers after processing.

```json
"headers": {
    "Accept": "*/*",
    "Authorization": "Bearer FNfcatCkg5yqh5mPBEwuxbbVFNfcatCkg5yqh5mPBEwuxbbV",
    "B3": "00082402568a56f59a3f94f2d26a42f2-0d80d440d9aef470-1",
    "Connection": "close",
    "Content-Length": "3",
    "Content-Type": "application/json",
    "Host": "echo.apps.verygood.systems",
    "User-Agent": "curl/7.77.0",
    "Vgs-Request-Id": "00082402568a56f59a3f94f2d26a42f2",
    "Vgs-Tenant": "{VAULT_ID}",
    "X-Amzn-Trace-Id": "Root=1-6238ba7c-15b8bce65d777a053529f0f0",
    "X-B3-Sampled": "1",
    "X-B3-Spanid": "2c388296d74386cb",
    "X-B3-Traceid": "dbe5bffd53fb6537b2e4c49bc3c31c81",
    "X-Forwarded-Host": "{VAULT_ID}.sandbox.verygoodproxy.com"
  }
```

--------------------------------

### Configure an HTTP request with show.request()

Source: https://docs.verygoodsecurity.com/vault/developer-tools/vgs-show/js/reference-documentation.md

Initializes a request to a specified path with defined methods and payload handling.

```javascript
const frame = show.request({
  name: 'secret-card-number',
  method: 'POST',
  path: '/secure-data',
  payload: {'card_number': '<ALIAS>'},
  htmlWrapper: 'text',
  jsonPathSelector: 'json.card_number'
});
```

--------------------------------

### Response example

Source: https://docs.verygoodsecurity.com/vault/developer-tools/vgs-collect/js/collect-tokenization-api.md

Example of the response object containing aliased field values.

```javascript
{
  "card_number": "4111117531101111",
  "card_cvc": "181",
}
```

--------------------------------

### Initialize bytearray objects

Source: https://docs.verygoodsecurity.com/vault/developer-tools/larky/library-api/builtins.md

Demonstrates creating bytearray instances using integer sizes, string encoding, and iterable sequences.

```python
builtins.bytearray(2) # A byte array of size 2
bytearray(b'\x00\x00')
builtins.bytearray('Hello World','utf-8')
bytearray(b'Hello World')
builtins.bytearray([1, 2, 3, 4, 5])
bytearray(b'     ')
```

--------------------------------

### VGSPDFViewRepresentable Usage Example

Source: https://docs.verygoodsecurity.com/vault/developer-tools/vgs-show/ios-sdk/swiftui-components.md

A complete example showing how to initialize and configure the VGSPDFViewRepresentable with modifiers.

```swift
VGSPDFViewvgsShow: vgsShow, contentPath: "pdf_view")
    .pdfAutoScales(false)
    .pageShadowsEnabled(true)
    .pdfDisplayDirection(.horizontal)
    .onContentDidChange {
        print("-PDF view updated")
    }.onRevealError { error in
        print("-PDF view error: \(error)")
    }
```

--------------------------------

### Create and call partials with keyword arguments

Source: https://docs.verygoodsecurity.com/vault/developer-tools/larky/library-api/partial.md

Shows how keyword arguments are merged, with call-site arguments taking precedence over make-site arguments.

```python
def _foo(make_arg1, call_arg1, make_location, call_location):
...     print(make_arg1 + " is from " + make_location + " and " + call_arg1 + " is from " + call_location + "!")
func = partial.make(_foo, "Ben", make_location="Hollywood")
partial.call(func, "Jennifer", call_location="Denver")
"Ben is from Hollywood and Jennifer is from Denver!"
partial.call(func, "Jennifer", make_location="LA", call_location="Denver")
"Ben is from LA and Jennifer is from Denver!".
```

--------------------------------

### Initialize VGSShow and Subscribe Views

Source: https://docs.verygoodsecurity.com/vault/developer-tools/vgs-show/android-sdk/integration.md

Initialize the VGSShow instance and subscribe your secure views to reveal data. Ensure the appropriate plugin is configured for Kotlin or use findViewById for Java.

```kotlin
import android.os.Bundle
import androidx.appcompat.app.AppCompatActivity
import com.verygoodsecurity.demoshow.R
import com.verygoodsecurity.vgsshow.VGSShow
import com.verygoodsecurity.vgsshow.core.VGSEnvironment
class MainActivity : AppCompatActivity() {
    private lateinit var vgsShow: VGSShow
    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        setContentView(R.layout.main_activity)
        vgsShow = VGSShow(this, "<VAULT_ID>", VGSEnvironment.Sandbox())
        vgsShow.subscribe(infoField)
    }
    override fun onDestroy() {
        super.onDestroy()
    }
}
```

```java
import android.os.Bundle;
import androidx.annotation.Nullable;
import androidx.appcompat.app.AppCompatActivity;
import com.verygoodsecurity.demoshow.R;
import com.verygoodsecurity.vgsshow.VGSShow;
import com.verygoodsecurity.vgsshow.core.VGSEnvironment;
public class MainActivity extends AppCompatActivity {
    private VGSShow vgsShow;
    @Override
    protected void onCreate(@Nullable Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.main_activity);
        vgsShow = new VGSShow(this, "<VAULT_ID>", new VGSEnvironment.Sandbox());
        vgsShow.subscribe(findViewById(R.id.infoField));
    }
    @Override
    protected void onDestroy() {
        super.onDestroy();
    }
}
```

--------------------------------

### Initialize VGS Show v1

Source: https://docs.verygoodsecurity.com/vault/developer-tools/vgs-show/js/changelog.md

Standard initialization pattern for VGS Show version 1.

```javascript

const show = VGSShow.create('<VAULT_ID>', function(state) {})
                    .setEnvironment('<ENVIRONMENT>');

```

--------------------------------

### VGSTextFieldRepresentable Implementation Example

Source: https://docs.verygoodsecurity.com/vault/developer-tools/vgs-collect/ios-sdk/swiftui-components.md

A complete example showing how to integrate VGSTextFieldRepresentable within a SwiftUI View.

```swift
struct CardDataCollectionView: View {
  // Collector
  let vgsCollect = VGSCollect(id: "vaultId" environment: .sandbox)

  // State
  @State private var textFieldState: VGSTextFieldState? = nil
  
  // MARK: - Textfield UI attributes
  let paddings = UIEdgeInsets(top: 2,left: 8,bottom: 2,right: 8)
  let validColor = UIColor.lightGray
  let invalidColor = UIColor.red
      
  // Build View
  var body: some View {
    
    // extfield Configuration
    var configuration: VGSConfiguration {
      let config = VGSConfiguration(collector: vgsCollect, fieldName: "name")
      config.type = .cardHolderName
      return config
    }
    
    return VStack() {
      VGSTextFieldRepresentable(configuration: configuration)
        .placeholder("Holder Name")
        /// Track field editing events and State
        .onEditingEvent { event in
            switch event {
            case .didBegin(let state):
              print("Editing began with state: \(state.description)")
            case .didChange(let state):
                print("Editing changed with state: \(state.description)")
            case .didEnd(let state):
                print("Editing ended with state: \(state.description)")
            }
        }
        /// Track field State changes
        .onStateChange { newState in
          print(newState.isValid)
          textFieldState = newState
        }
        .textFieldPadding(paddings)
        .border(color: (textFieldState?.isValid ?? true) ? validColor : invalidColor, lineWidth: 1)
        .frame(height: 54)
    }
  }
}
```

--------------------------------

### GET /vault/guides/card-issuing.md

Source: https://docs.verygoodsecurity.com/vault/guides/card-issuing.md

Perform an HTTP GET request to query the documentation dynamically for specific information.

```APIDOC
## GET /vault/guides/card-issuing.md

### Description
Queries the documentation dynamically by providing a specific question and an optional goal to retrieve relevant excerpts and answers.

### Method
GET

### Endpoint
https://docs.verygoodsecurity.com/vault/guides/card-issuing.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

--------------------------------

### Implement VGSCardTextField

Source: https://docs.verygoodsecurity.com/vault/developer-tools/vgs-collect/ios-sdk/ui-components.md

Example showing how to configure field properties and set custom icons either globally or per instance.

```swift
var cardNumberField = VGSCardTextField()
cardNumberField.cardIconLocation = .left
cardNumberField.cardIconSize = CGSize(width: 45, height: 45)

/// Set card brand icons globally
VGSPaymentCards.visa.brandIcon = UIImage(named: "my visa icon")
VGSPaymentCards.unknown.brandIcon = UIImage(named: "my unknown brand icon")

/// OR

/// Set card brand icons for specific textfield
cardNumberField.cardsIconSource = { cardBrand in
    switch cardBrand {
    case .mastercard:
        return UIImage(named: "<custom mastercard icon>")
    case .visa:
        return UIImage(named: "<custom visa icon>")
    default:
        return nil
    }
}
```

--------------------------------

### Initialize VGSFileProvider and Handle Activity Results

Source: https://docs.verygoodsecurity.com/vault/developer-tools/vgs-collect/android-sdk/files-upload.md

Demonstrates how to retrieve the VGSFileProvider instance from VGSCollect and delegate activity results to the SDK.

```kotlin
private val vgsForm = VGSCollect(this, "<VAULT_ID>", Environment.<SANDBOX> )

fun getFileProvider() {
    val fileProvider: VGSFileProvider = vgsForm.getFileProvider()
}

override fun onActivityResult(requestCode: Int, resultCode: Int, data: Intent?) {
    super.onActivityResult(requestCode, resultCode, data)
    vgsForm.onActivityResult(requestCode, resultCode, data)
}
```

```java
private VGSCollect vgsForm = new VGSCollect(this, "<VAULT_ID>", Environment.<SANDBOX> );

fun getFileProvider() {
    VGSFileProvider fileProvider = vgsForm.getFileProvider();
}

@Override
protected void onActivityResult( int requestCode, int resultCode, Intent data ) {
    super.onActivityResult(requestCode, resultCode, data);
    vgsForm.onActivityResult(requestCode, resultCode, data);
}
```

--------------------------------

### GET /enterprise-platform/access-management/service-accounts-for-programmatic-access/creating-service-accounts-using-the-vgs-cli.md

Source: https://docs.verygoodsecurity.com/enterprise-platform/access-management/service-accounts-for-programmatic-access/creating-service-accounts-using-the-vgs-cli.md

Perform an HTTP GET request to query the documentation dynamically for specific information.

```APIDOC
## GET /enterprise-platform/access-management/service-accounts-for-programmatic-access/creating-service-accounts-using-the-vgs-cli.md

### Description
Queries the documentation dynamically by providing a specific question and an optional end goal to receive a tailored answer with relevant excerpts.

### Method
GET

### Endpoint
https://docs.verygoodsecurity.com/enterprise-platform/access-management/service-accounts-for-programmatic-access/creating-service-accounts-using-the-vgs-cli.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```
Tokens:
Raw