Insurances

Insurance configurations help your agent answer coverage questions accurately. Instead of burying insurance info in FAQs, use the dedicated insurance module so Annie can respond intelligently to questions like “Do you take my insurance?” Use insurances for:

Which providers you accept
In-network vs out-of-network status
Plan-specific notes (PPO vs HMO, filing policies)

Creating an Insurance

First, call List Insurance Providers to get the provider’s id. Provider IDs differ between the sandbox and production environments, so read them from the environment you are calling.

const response = await fetch("https://api.helloannie.com/v1/organizations/YOUR_ORG_ID/insurances", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    providerId: "YOUR_PROVIDER_ID",
    type: "PPO",
    status: "IN_NETWORK",
    notes: "Premier and PPO plans accepted"
  })
})

import requests

response = requests.post(
    "https://api.helloannie.com/v1/organizations/YOUR_ORG_ID/insurances",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Content-Type": "application/json"
    },
    json={
        "providerId": "YOUR_PROVIDER_ID",
        "type": "PPO",
        "status": "IN_NETWORK",
        "notes": "Premier and PPO plans accepted"
    }
)

curl -X POST https://api.helloannie.com/v1/organizations/YOUR_ORG_ID/insurances \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "providerId": "YOUR_PROVIDER_ID",
    "type": "PPO",
    "status": "IN_NETWORK",
    "notes": "Premier and PPO plans accepted"
  }'

Insurance Fields

string

required

The id of the insurance provider, from List Insurance Providers.Insurance responses return this as providerId, along with the provider’s name as providerName.

string

required

The plan type.Options: PPO, HMO, EPO, MEDICAID, MEDICARE

string

required

Your acceptance status for this insurance.

Status	Meaning
`IN_NETWORK`	You’re an in-network provider
`ACCEPTED`	You accept the insurance. Similar to `CAN_FILE`, but helps adjust verbiage to be less direct about being out of network.
`CAN_FILE`	Similar to `ACCEPTED`, but more direct about being out of network. Means you can file claims on the patient’s behalf
`CONDITIONAL`	Accepted with conditions (explain in notes)
`NOT_ACCEPTED`	You don’t accept this insurance

string

Additional context Annie can use when discussing this insurance.Example: "Premier and PPO plans only. HMO plans not accepted."

Insurances API

See the full API reference for insurance endpoints.

Get Started

Guides

Creating an Insurance

Insurance Fields

Insurances API