Getting Started with VynFi

Create a free VynFi account at vynfi.com/signup. The free tier includes 10,000 credits per month, enough to generate thousands of rows of journal entries. No credit card required.

Navigate to Dashboard → API Keys and click “Create New Key”. Give it a descriptive name and copy the key. It will only be shown once.

Use a vf_test_ key for this tutorial. Sandbox keys do not consume credits and are perfect for experimentation.

The /v1/generate/quick endpoint returns data synchronously, ideal for datasets up to 10,000 rows. Replace the API key with your own.

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

Understanding the Response

{
  "id": "gen_r4kX8mN2",
  "status": "completed",
  "credits_used": 1000,
  "data": {
    "journal_entries": [
      {
        "date": "2026-01-03",
        "account": "4100 - Sales Revenue",
        "debit": 15420.50,
        "credit": 0.00,
        "description": "POS sales - Store #7",
        "is_anomaly": false
      },
      {
        "date": "2026-01-03",
        "account": "1100 - Accounts Receivable",
        "debit": 0.00,
        "credit": 15420.50,
        "description": "AR from Store #7 sales",
        "is_anomaly": false
      }
    ]
  },
  "metadata": {
    "duration_ms": 342,
    "row_count": 1000,
    "sector": "retail",
    "format": "json"
  }
}

Check Your Credit Usage

After generating data, verify your credit consumption:

curl https://api.vynfi.com/v1/usage \
  -H "Authorization: Bearer vf_test_your_key_here"

{
  "period": {
    "start": "2026-04-01T00:00:00Z",
    "end": "2026-04-30T23:59:59Z"
  },
  "credits": {
    "included": 10000,
    "used": 1000,
    "remaining": 9000,
    "overage": 0
  },
  "tier": "Free"
}

For datasets larger than 10,000 rows, use asynchronous generation. Submit a job, poll for status, and download when complete. Supported export formats include JSON, CSV, Parquet, and Excel.

# Step 1: Submit async generation job
curl -X POST https://api.vynfi.com/v1/generate \
  -H "Authorization: Bearer vf_live_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "config": {
      "sector": "banking",
      "rows": 100000,
      "companies": 20,
      "periods": 12,
      "periodLength": "monthly",
      "exportFormat": "csv"
    }
  }'
# Response: { "job_id": "job_abc123", "status": "queued" }
# Step 2: Check job status
curl https://api.vynfi.com/v1/jobs/job_abc123 \
  -H "Authorization: Bearer vf_live_your_key_here"
# Step 3: Download when complete
curl -O https://api.vynfi.com/v1/jobs/job_abc123/download \
  -H "Authorization: Bearer vf_live_your_key_here"

You can also use webhooks to receive a notification when your job completes instead of polling.

Every VynFi dataset comes with a quality report. Use the quality endpoint to inspect statistical properties of your generated data.

curl https://api.vynfi.com/v1/jobs/job_abc123/quality \
  -H "Authorization: Bearer vf_live_your_key_here"

{
  "overall_score": 0.94,
  "benford_compliance": {
    "score": 0.97,
    "chi_squared": 3.21,
    "p_value": 0.92,
    "verdict": "pass"
  },
  "distribution_fidelity": {
    "score": 0.91,
    "kolmogorov_smirnov": 0.032,
    "verdict": "pass"
  },
  "referential_integrity": {
    "score": 1.0,
    "orphan_records": 0,
    "verdict": "pass"
  },
  "temporal_consistency": {
    "score": 0.93,
    "out_of_order_entries": 12,
    "verdict": "pass"
  }
}

Quality Dimensions

You can also view quality metrics visually in the Quality Dashboard.