Skip to main content

Error envelope

Application errors return:

Status semantics

  • 200: request succeeded
  • 400: malformed path identifier (geo_id format)
  • 404: valid identifier but resource not found
  • 422: query validation failed, including unsupported permit-scoped geo type or invalid cursor
  • 429: throttled/quota exceeded
  • 500: internal server error
  • 503: dependent permits data source unavailable/misconfigured

Common codes

  • VALIDATION_ERROR
  • INVALID_CURSOR
  • INVALID_GEO_ID
  • LOCATION_NOT_FOUND
  • CONFIGURATION_ERROR
  • DEPENDENCY_ERROR
  • UNSUPPORTED_GEO_TYPE
  • INTERNAL_ERROR

Request IDs

  • responses include X-Request-ID when available
  • errors include error.request_id
  • include request ID when contacting support