Get started

Revenue Guard API

Submit orders, evaluate payer rules, and keep sandbox and live traffic isolated.

Revenue Guard helps CrelioHealth customers classify incoming orders against payer rules before downstream billing workflows begin. Use the public API to look up payer IDs and submit orders for evaluation, and use the dashboard to manage payers, review results, and tune rules.

New here? The Quickstart takes you from an API key to your first validated order in a few minutes, and How Revenue Guard works explains the classification pipeline end to end.

Use the public API while building integrations:

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

All public paths include /public/v1.

How integrations work

1

Create an API key

Create an organization-scoped API key in the Revenue Guard dashboard. Keys are environment-specific:

  • Sandbox keys start with rg_test_
  • Live keys start with rg_live_
2

Find payer IDs

Call GET /public/v1/payer-categories for the public reference list, GET /public/v1/payers to list payer IDs, or GET /public/v1/payers/{payerId} to verify one payer. Payer IDs are passed in payer_ids when submitting orders.

3

Submit orders

Call POST /public/v1/orders with the order, patient, insurance, and document evidence needed for rule evaluation.

$curl https://public-rg-api.crelio.solutions/public/v1/orders \
>  -H "X-API-Key: $REVENUE_GUARD_API_KEY" \
>  -H "Content-Type: application/json" \
>  -d '{
>    "order_id": "ORD-1001",
>    "payer_ids": ["00000000-0000-0000-0000-000000000000"],
>    "patient_info": {
>      "patient_uid": "PAT-123"
>    }
>  }'
4

Track the environment

Responses for environment-owned resources include environment and livemode. Use them to confirm sandbox traffic never mixes with live data.

Core concepts

API keys

Authenticate requests with the X-API-Key header. The key determines whether the request targets sandbox or live data.

Orders & validation

Submit orders for payer rule classification and review the generated validation result.

Payers

Manage payers and policy documents, and find payer IDs used by order submissions.

Webhooks

Receive validation results and rule changes at your own endpoints.

Environments

Do not send a separate environment header. The API key is authoritative for sandbox vs live routing.

Start with sandbox keys while developing. Move to live keys only after your payer lookup and order submission workflows are verified end to end.