> This page is for Revenue Guard.

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://revenue-docs.creliohealth.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://revenue-docs.creliohealth.com/_mcp/server.

# API reference

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

Base URL:

```text
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.

```bash
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](/api-reference/orders/post-public-v1-orders)

Create or update an order and run payer rule classification.

#### [List payers](/api-reference/payers/get-public-v1-payers)

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

#### [List payer categories](/api-reference/payers/get-public-v1-payer-categories)

Fetch public payer category reference data.

#### [Get a payer](/api-reference/payers/get-public-v1-payers-payer-id)

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.