Early accessSome features may be unavailable

Quickstart Guide

Generate your first synthetic financial dataset in under 5 minutes

1

1. Get Your API Key

Sign up for a free VynFi account and navigate to the API Keys page in your dashboard. Create a new key to get started.

API Key Prefixes
Productionvf_live_*

Consumes credits from your plan

Sandboxvf_test_*

Free testing with limited rows

2

2. Your First Request

Use the /v1/generate/quick endpoint for synchronous generation. This returns data directly in the response, perfect for small to medium datasets (up to 10K rows).

Bash
curl -X POST https://api.vynfi.com/v1/generate/quick \
  -H "Authorization: Bearer vf_live_abc123..." \
  -H "Content-Type: application/json" \
  -d '{
    "sector": "banking",
    "tables": [
      { "name": "journal_entries", "rows": 1000 }
    ],
    "format": "json"
  }'
3

3. Understand the Response

The API returns your generated data along with metadata about the request. Here is an annotated example response:

JSON
{
  "id": "gen_abc123",
  "status": "completed",
  "credits_used": 1000,
  "data": {
    "journal_entries": [
      {
        "date": "2026-01-15",
        "account": "1010 - Cash",
        "debit": 5000.00,
        "credit": 0.00,
        "memo": "Customer payment received"
      },
      {
        "date": "2026-01-15",
        "account": "4010 - Revenue",
        "debit": 0.00,
        "credit": 5000.00,
        "memo": "Service revenue Q1"
      }
    ]
  },
  "metadata": {
    "duration_ms": 842,
    "row_count": 1000,
    "sector": "banking",
    "format": "json"
  }
}
id

Unique generation ID. Use this to reference the result later.

credits_used

Total credits consumed for this request. Varies by row count, sector, and options.

data

Your generated dataset, keyed by table name. Each table contains an array of records.

metadata

Performance and configuration info including duration, row count, and output format.

4

4. Check Your Usage

Monitor your credit consumption with the usage endpoint. This helps you track spend and plan capacity.

Bash
curl https://api.vynfi.com/v1/usage \
  -H "Authorization: Bearer vf_live_abc123..."
Response
JSON
{
  "period": {
    "start": "2026-02-01T00:00:00Z",
    "end": "2026-02-28T23:59:59Z"
  },
  "credits": {
    "included": 500000,
    "used": 1000,
    "remaining": 499000,
    "overage": 0
  },
  "tier": "Developer"
}
5

5. Audit Data Generation

VynFi supports 9 audit blueprint methodologies. Here’s how to generate audit engagement data:

Bash
curl -X POST https://api.vynfi.com/v1/generate \
  -H "Authorization: Bearer vf_live_abc123..." \
  -H "Content-Type: application/json" \
  -d '{
    "config": {
      "sector": "financial_services",
      "country": "US",
      "accountingFramework": "us_gaap",
      "rows": 50000,
      "companies": 10,
      "periods": 12,
      "periodLength": "monthly",
      "fraudPacks": ["revenue_fraud"],
      "fraudRate": 0.05,
      "processModels": ["o2c", "banking", "audit"],
      "exportFormat": "json"
    }
  }'

v2.2 adds optional sections for manufacturing cost accounting, treasury, tax, financial statements, ESG, and coherence validators. All sections are optional — omit them to use sensible defaults.

See the Audit Blueprints page for all 10 methodologies and configuration options.