REST API & SDK. Integrate in minutes.
Every action in the Verid dashboard is available via REST API. OpenAPI 3.1 spec included. Official Node.js SDK on npm.
Authentication
Authenticate with a Bearer token. Create and manage API keys from your dashboard. Each key starts with the readable prefix vrd_ and has configurable scopes.
Authorization: Bearer vrd_your_api_key
REST endpoints
Node.js SDK
The official Verid Node.js SDK wraps the REST API with TypeScript types and clean async methods. Install from npm and you're ready in minutes.
npm install @verid.dev/sdk
import { VeridClient } from '@verid.dev/sdk';
const client = new VeridClient({
apiKey: process.env.VERID_API_KEY!,
});
// Create a monitor
const monitor = await client.monitors.create({
name: 'React releases',
url: 'https://api.github.com/repos/facebook/react/releases/latest',
schedule_interval_seconds: 3600,
extract_config: {
method: 'json_path',
fields: { version: '$.tag_name' },
},
diff_predicate: { type: 'field_changes', field: 'version' },
deliveries: [{ type: 'webhook', url: 'https://your-app.com/hook' }],
});
// List monitors
const { data } = await client.monitors.list({ page: 1, limit: 20 });
// Trigger a run immediately
await client.monitors.runNow(monitor.id);API key management
Create multiple API keys with different scopes. Each key has a readable prefix for identification and can be revoked instantly from your dashboard.
Read-only keys
For monitoring dashboards, read-only integrations, and third-party tools. Can list and fetch, but cannot create or modify.
Read-write keys
Full access to create, update, and delete monitors. Use for your application backend where you need to manage monitors programmatically.
Instant revocation
Revoke any key immediately from your dashboard. The key is invalidated within seconds. Old keys are never re-usable after revocation.