Skip to main content

API Reference

Complete reference for the ZewstID REST API. Authenticate with OAuth 2.0 client credentials, manage service accounts, configure webhooks, and track usage.

Base URL
https://api.zewstid.com
Download OpenAPI Spec

Authentication

This API uses OAuth 2.0 Client Credentials for machine-to-machine authentication. Obtain a service account from the Developer Portal, then exchange your credentials for an access token.

curl -X POST https://api.zewstid.com/oauth/token \
  -d grant_type=client_credentials \
  -d client_id=sa_abc123 \
  -d client_secret=sk_live_xyz789

Rate Limiting

All API requests are rate limited based on your subscription tier. Rate limit headers are included in every response.

TierRequests / minDaily quota
Free601,000
Startup60050,000
Enterprise10,0005,000,000

Endpoints

OAuth 2.0 client credentials flow for machine-to-machine authentication.

Create and manage service accounts for M2M authentication. Each service account receives a unique client ID and secret.

Configure webhook endpoints to receive real-time notifications for authentication events.

Track API usage, request counts, and rate limit consumption.

Error Responses

All errors follow a consistent JSON format. The HTTP status code indicates the error category.

{
  "error": "unauthorized",
  "message": "Invalid or missing access token",
  "details": {}
}
StatusMeaning
400Bad request -- invalid parameters or body
401Unauthorized -- missing or invalid access token
403Forbidden -- insufficient scopes or permissions
404Not found -- the requested resource does not exist
429Too many requests -- rate limit exceeded
500Internal server error