Skip to main content

API Reference

Base URL: https://crowdproof-api.azurewebsites.net

All endpoints are prefixed with /api/v1/ unless noted.

Endpoints​

AreaEndpointsAuth Required
ReputationScore queries, batch, ZK proofsAPI Key
IdentityDID registration, resolution, credentialsMixed
ComplianceAge verify, KYC, sanctionsAPI Key
DisputesSubmit, track, escalateAPI Key
Debt ClaimsSubmit, dispute, resolve claimsNone
WebhooksRegister, list, deleteAPI Key
BillingAPI keys, checkoutJWT
AuthSign-In with EthereumNone
ErrorsError codes and troubleshooting—

Common Headers​

HeaderRequiredDescription
X-API-KeyYes (most endpoints)Your API key (did_live_...)
AuthorizationSome endpointsBearer <JWT> from SIWE
Content-TypePOST/PUTapplication/json

Response Headers​

HeaderDescription
X-Response-TimeRequest duration in milliseconds
X-RateLimit-Retry-AfterSeconds until rate limit resets (when 429)

Developer Tools​

ToolLinkDescription
Swagger UIcrowdproof-api.azurewebsites.net/swaggerInteractive API explorer with "Try it"
OpenAPI Specswagger.jsonOpenAPI 3.0.4 machine-readable spec
Postman CollectionDownload39 pre-configured requests across 10 folders

Import the Postman collection, set the apiKey variable, and start making requests immediately.

Public Endpoints (No API Key)​

  • GET /health
  • POST /api/v1/identity/register
  • GET /swagger