API DOCUMENTATION

Build with the Vurrk API

Everything you need to integrate Vurrk into your applications and workflows.

Authentication

Learn how to authenticate API requests

Endpoints

Explore available API endpoints

Webhooks

Subscribe to real-time events

Examples

See code examples in popular languages

Authentication

All API requests require authentication using an API key. Include your key in the Authorization header.

bash
curl https://api.vurrk.com/v1/me \
  -H "Authorization: Bearer vurrk_live_xxx"
Generate API keys from your account settings

API Endpoints

GET/v1/meGet current user profile
GET/v1/trust-scoreGet your Trust Score
GET/v1/invoicesList all invoices
POST/v1/invoicesCreate a new invoice
GET/v1/invoices/:idGet invoice by ID
GET/v1/recordsList verified records
POST/v1/recordsCreate Shadow Ledger entry
POST/v1/webhooksRegister webhook endpoint

Webhooks

Subscribe to real-time events and automate your workflows. Webhooks deliver event payloads to your endpoint within seconds.

invoice.created

New invoice created

invoice.paid

Invoice payment received

invoice.overdue

Invoice past due date

record.created

New record created

record.verified

Record verified by client

trust_score.updated

Trust Score changed

Code Examples

Create an Invoice

javascript
const response = await fetch('https://api.vurrk.com/v1/invoices', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer vurrk_live_xxx',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    client_email: 'client@example.com',
    amount: 4500,
    currency: 'USD',
    description: 'Website Redesign Project',
    due_date: '2025-02-01',
  }),
});

const invoice = await response.json();
console.log(invoice.payment_url);
FAQ

API FAQs

Security, auth, webhooks, and best practices.

Is the API the only way to access data?
Yes. Vurrk is designed so client apps use APIs (and internal paths) rather than direct database access, keeping credentials secure.
How should I store API keys?
Store keys server-side only (never in client code). Rotate keys regularly and scope them to least privilege.
Do you provide webhooks?
Yes. Webhooks let you subscribe to invoice, record, and Trust Score events to automate workflows.
Is there rate limiting?
Yes. Rate limits depend on your plan, and you should implement exponential backoff and idempotency where applicable.
Do you have a full reference?
Yes. The full API reference is available on the API subdomain. This page provides a fast overview and examples.
Can I build internal integrations safely?
Yes. Use server-side calls to the internal API path and keep all secrets out of the browser.
START BUILDING

Ready to integrate?

Get your API keys and start building today.

Get API KeysFull API Reference