Skip to navigation
Overview

API reference

Public Revenue Guard endpoints for order submission and payer lookup.

Use the API reference for exact request and response fields when building a Revenue Guard integration.

Base URL:

https://public-rg-api.crelio.solutions

All public paths include /public/v1.

Authentication

All public endpoints require an organization-scoped API key in the X-API-Key header.

curl https://public-rg-api.crelio.solutions/public/v1/payers \
  -H "X-API-Key: $REVENUE_GUARD_API_KEY"

API keys are scoped by resource and action:

  • order:create submits orders.
  • payer:read lists payer categories, lists payers, and reads one payer by ID.

Sandbox and live mode

Revenue Guard separates sandbox and live data at the API key level:

  • rg_test_ keys can only access sandbox data.
  • rg_live_ keys can only access live data.
  • Public callers should not send an environment header.
  • Responses that create environment-owned resources include environment and livemode.

Available endpoints

Submit an order

Create or update an order and run payer rule classification.

List payers

Fetch payer IDs and names that can be used in order submissions.

List payer categories

Fetch public payer category reference data.

Get a payer

Verify one payer ID using the slim public payer response.

SDKs

Customer SDKs are planned from this public API contract. Until package availability is confirmed, use the API reference for raw HTTP integrations.