API Reference

Complete API documentation for Zero Proof AI. All endpoints use REST principles and return JSON responses.

Base URL

https://api.zeroproofai.com/v1

Authentication

All API requests require authentication using an API key. Include your API key in the X-Api-Key header:

X-Api-Key: your_api_key_here

Endpoints

POST/verify/challenge

Request Challenge

Request a verification challenge for an AI agent. Returns a unique nonce and challenge ID.

POST/verify/proof

Verify Proof

Submit a zero-knowledge proof for verification. Returns verification result and confidence score.

GET/verify/status/:sessionId

Check Status

Check the status of a verification session using the session ID.

Response Format

All responses are returned as JSON with appropriate HTTP status codes.

Success Response

{
  "verified": true,
  "agent_id": "shop-bot-001",
  "confidence": 0.99,
  "timestamp": "2025-01-01T12:00:00Z"
}

Error Response

{
  "error": "Invalid API key",
  "message": "Provide API key in X-Api-Key header"
}

Status Codes

CodeDescription
200Success - Request completed successfully
400Bad Request - Invalid parameters or expired challenge
401Unauthorized - Missing or invalid API key
403Forbidden - API key inactive or insufficient permissions
404Not Found - Challenge or session not found
500Internal Server Error - Something went wrong on our end

Rate Limits

API requests are rate limited to ensure service quality:

  • Free tier: 10,000 verifications per month
  • Rate limit: 100 requests per minute
  • Burst: Up to 20 requests per second

Need higher limits? Contact us for enterprise pricing and custom rate limits.