Skip to main content
The VantageClaw Partner API is the HTTPS surface that lets partner organizations integrate with the VantageClaw platform. v1 is deliberately substrate-only: identity verification and webhook subscriptions. Resource CRUD ships with the first resource family.

What this API is

Authenticated identity

Long-lived vck_ API keys with explicit scopes. Confirm your integration is wired correctly with GET /me.

Webhook subscriptions

Subscribe to platform events. HMAC-signed deliveries with a documented retry schedule and replay defense.

What it isn’t (yet)

v1 ships the substrate first so partner integrations have something stable to build against. The following land with subsequent versions:
  • Resource CRUD — no /leads, /jobs, or other domain endpoints yet. Reserved scopes (leads:read, tasks:write, etc.) are rejected at key-creation time so partners don’t depend on them prematurely.
  • OAuth / multi-user auth — v1 is single-key-per-partner. Per-user delegation lands with the first multi-user partner.
  • Public org-admin UI — keys are admin-provisioned for now. Self-service key rotation surfaces when partner count > ~2.

Start here

Quickstart

Provision a key, subscribe to a webhook, and trigger a test event in under 10 minutes.

Reference

Authentication

Key format, scope vocabulary, and rotation procedure.

Webhook security

HMAC signature verification and replay-window enforcement.

Webhook events

Current event vocabulary and envelope shape.

Integration test

Production-readiness checklist before going live.

Support

This API is in v1. The surface is deliberately small. If something you need isn’t here yet, reach out — the v1 surface is the foundation, not the ceiling.