Response Codes

Envelope

Every response is {"response_code": "...", "response_text": "...", ...} - response_code is one of the codes below, response_text is that code's message (localized, see Accept-Language on the API Reference pages).

Account Error

Code	Message	HTTP Status
085	Account is suspended	403
464	Account locked due to too many failed attempts	403

Auth Error

Code	Message	HTTP Status
081	Authentication error	401
083	Invalid token	401
403	Access forbidden	403
422	Invalid credentials	401
423	Expired token	401
424	Insufficient permissions	403
496	Session expired	401

Business Error

Code	Message	HTTP Status
453	Service under maintenance	503

Client Error

Code	Message	HTTP Status
082	Required field is missing	400
097	Resource not found	404
098	Resource conflict	409
400	Invalid request	400
401	Invalid request format	400
404	Path not found	404
405	Method not allowed	405
407	Invalid operation type	400
408	Operation name mismatch	400
502	Rate limit exceeded	429
509	Resource already exists	409

Server Error

Code	Message	HTTP Status
060	Internal server error	500
504	Service temporarily unavailable	503

Service Error

Code	Message	HTTP Status
483	Error processing operation	400

Success

Code	Message	HTTP Status
001	Success	200
002	Created successfully	201
003	Updated successfully	200
004	Deleted successfully	200
005	Data retrieved successfully	200
006	Operation is pending	202

System Error

Code	Message	HTTP Status
000	Unknown error	400

Validation Error

Code	Message	HTTP Status
431	Validation error	422

Sample Response Patterns

Success

{
  "response_code": "001",
  "response_text": "Success",
  "data": { ... }
}

Paginated success

{
  "response_code": "001",
  "response_text": "Success",
  "data": {
    "items": [ ... ],
    "pagination": {
      "current_page": 1,
      "page_size": 10,
      "total_items": 42,
      "total_pages": 5
    }
  }
}

Error

{
  "response_code": "097",
  "response_text": "Resource not found",
  "error_details": {
    "error": "CLIENT_ERROR",
    "detail": "...",
    "path": "/v2/..."
  }
}

Auth error

{
  "response_code": "081",
  "response_text": "Authentication error",
  "error_details": {
    "error": "AUTH_ERROR",
    "detail": "...",
    "path": "/v2/..."
  }
}

Validation error

{
  "response_code": "431",
  "response_text": "Validation error",
  "errors": [
    { "field": "email", "message": "email is required" }
  ]
}