What Are API Keys?

An API Key is a unique identifier tied to your business account that grants access to Vaulta Technologies APIs. It serves as a secure “password” for your backend applications to communicate with Vaulta Technologies services. For every API request, this key must be included in the request header to verify identity and authorization.

Example:

curl -X GET https://api.vaultalabs.com/v1/transaction \
  -H "Authorization: Bearer {your_api_key}"

How to Generate an API Key

You can create and manage your API Key directly from your business dashboard.

Step-by-Step Guide

Login to your Vaulta Business Dashboard.
Navigate to Settings → API Access.
Click the “Generate API Key” button.
The system will generate a secure AES-256 encrypted API Key for your account.
Copy and store your API Key securely — you’ll need it for all authenticated API requests.

⚠️
Important: Vaulta Technologies does not store your API Key in plain text. Once generated, you will not be able to view it again.

Key Rotation Policy

For security reasons, each business can ONLY have one active API Key at any time.

When you generate a new API Key, the previous key is immediately invalidated.
All API requests made with the old key will fail with a 401 Unauthorized error.
It’s best practice to rotate your API Key periodically (e.g., every 90 days) or immediately if you suspect compromise.

Example response when regenerating a key:

{
    "message": "api key generated successfully",
    "status": "success",
    "data": {
        "api_key": "sk_test_gdnd8YEZavJTaMJc..."
    }
}

Security Protocol

Vaulta Technologies enforces AES-256 encryption for API Key storage and transmission. This ensures that keys are:

Encrypted at rest and in transit.
Bound to your organization’s unique credentials.
Protected against unauthorized use.

For maximum security:

Never expose your API Key in public repositories or client-side code.
Restrict usage to your server-side applications.
Rotate and revoke keys as part of your internal security policy.

Example Usage

Example API request with your generated key:

curl -X POST https://api.usevaulta.com/v1/transaction \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer sk_test_gdnd8YEZavJTaMJc..."

Response:

{
    "message": "transactions successfully fetched",
    "status": "success",
    "data": {
        "transactions": [
            {
                "id": "7e521ac2-9d2c-4078-8a7a-32c67a073042",
                "business_id": "33c248f4-8644-40f5-9c4a-e2e17426a709",
                "source": "crypto-wallet",
                "destination": "crypto-wallet",
                "mode": "credit",
                "status": "success",
                "from_amount": "10",
                "from_currency": "USDC",
                "from_network": "ERC20",
                "to_amount": "10",
                "to_currency": "USDC",
                "to_network": "ERC20",
                "fee_currency": "USDC",
                "narration": "Wallet Funding From External to Olawale",
                "created_at": "2025-10-03T08:22:37.167937Z",
                "updated_at": "2025-10-03T08:22:37.167937Z",
                "completed_at": "2025-10-03T08:22:37.167936Z",
                "from_address": "0x3C3380cdFb94dFEEaA41cAD9F58254AE380d752D",
                "to_address": "0x6BECC92E4c75F833D4036545dD4Aa84aaF8583ec",
                "hash_url": "https://sepolia.etherscan.io/tx/0x1309904d4531..."
            }
        ],
        "pageInfo": {
            "totalCount": 1,
            "page": 1,
            "hasNextPage": false,
            "next_cursor": "",
            "previous_cursor": ""
        }
    }
}

Notes

Each API request must include the Authorization header with your Bearer Token.
The API Key uniquely identifies your business — handle it with the same care as a password.
Lost or compromised keys should be revoked immediately from your dashboard.

Summary

Feature	Description
API Key Type	AES-256 encrypted token
Key Lifetime	Until manually regenerated, or disabled
Limit per Business	1 active API Key
Rotation Policy	New key invalidates old key
Storage	Encrypted at rest and in transit