API Reference

Programmatic access to your audits

Use the ProofCap API to create forensic audits, check their status, and retrieve verification reports for SaaS due diligence.

Authentication

Bearer tokens

All API requests are authenticated using an API key. Generate one from Settings → API in your dashboard (available on the Investor / Broker plan). Include it in the Authorization header of every request.

curl https://app.proofcap.io/api/audits \
  -H "Authorization: Bearer pcap_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

Base URL

All requests are relative to

https://app.proofcap.io/api

Endpoints

Audits & reports

GET/api/auditsList your audits
POST/api/auditsCreate a new forensic audit
GET/api/audits/:id/statusCheck audit status, progress logs
PATCH/api/audits/:id/shareGenerate or update a shareable report link
POST/api/reports/:shareToken/verifyUnlock a password- or email-protected report
GET/api/reports/:shareToken/badgeEmbeddable verification badge for a report

The /api/reports/:shareToken/* endpoints don't require an API key — they're scoped by the share token in the URL itself.

Response Format

JSON

All responses are JSON. Successful responses return the requested resource directly; errors return an object with an error field.

{
  "id": "clx1a2b3c4d5",
  "targetUrl": "https://example.com",
  "type": "DEEP",
  "status": "completed",
  "updatedAt": "2026-06-01T12:00:00.000Z"
}

Rate Limits

Fair use limits apply

API usage is subject to the limits of your subscription plan. Audit creation endpoints are rate-limited to prevent abuse; if you exceed your limit, the API returns an HTTP 429 status. For higher limits, contact us about enterprise plans.

Need higher limits or dedicated support?

Reach out and we'll help you get set up.

Contact Us