Skip to main content

​
Getting Started

To get started, make sure you are using the correct client_id and client_secret for the environment you are using.

​
Staging Environment

For testing and development purposes, please use the staging API at https://api-staging.speccheckrx.com.

​
Production Environment

For live deployments, access the production API at https://api.speccheckrx.com.

​
Error Handling

Errors return a JSON response with an error object describing what went wrong. Failed requests return HTTP 4xx or 5xx status codes. The error object always includes type and message. When present, code is a stable, machine-readable string (for example, invalid_request), and param identifies the related input field or header. 
{
  "error": {
    "type": "invalid_request_error",
    "message": "Example message from the API.",
    "code": "invalid_request",
    "param": "User-Email"
  }
}
code and param are omitted when not applicable.

​
Error Types

typeTypical HTTP statusMeaning
invalid_request_error400 (or other 4xx)Missing or invalid parameters
authentication_error401Authentication failed
permission_error403Authenticated but not allowed
api_error500Internal server error
Error messages and status codes may vary by endpoint. Always use the error object together with the HTTP status when handling failures.