Skip to main content

Overview

ZKScore API returns structured error responses to help you understand and handle issues effectively.

Error Response Format

All errors follow this structure:

Common Error Codes

Identity Errors (ZKS-001-xxx)

  • ZKS-001-001: Identity not found
  • ZKS-001-002: Identity not activated
  • ZKS-001-003: Invalid ZKS ID format

Authentication Errors (ZKS-002-xxx)

  • ZKS-002-001: Invalid API key
  • ZKS-002-002: API key expired
  • ZKS-002-003: Insufficient permissions

Rate Limit Errors (ZKS-003-xxx)

  • ZKS-003-001: Rate limit exceeded
  • ZKS-003-002: Quota exceeded

Score Errors (ZKS-004-xxx)

  • ZKS-004-001: Score not found
  • ZKS-004-002: Score calculation failed

HTTP Status Codes

Error Handling Examples

Best Practices

  1. Always Check Status Codes: Verify response status before processing
  2. Implement Retry Logic: Handle temporary failures gracefully
  3. Log Error Details: Include request IDs for debugging
  4. Handle Rate Limits: Implement exponential backoff
  5. Validate Inputs: Prevent errors before making requests