Payers

Create or update insurance payer (insurance company) records.

Upsert Payer

POST /integration/payers

Creates or updates a payer by id.

Request Body

Field	Type	Required	Description
`id`	string	Yes	Your unique identifier for this payer
`name`	string	Yes	Payer name (e.g., "Blue Cross Blue Shield")
`payer_code`	string	No	Short code identifier (e.g., "BCBS")
`payer_type`	string	No	Type of payer (e.g., "Private", "Medicare", "Medicaid")
`contact_email`	string	No	Claims contact email
`contact_phone`	string	No	Contact phone number
`fax`	string	No	Fax number
`website`	string	No	Payer website URL
`address_line1`	string	No	Street address
`address_line2`	string	No	Address line 2
`city`	string	No	City
`state`	string	No	State code
`zip_code`	string	No	ZIP code
`country`	string	No	Country code (default: `US`)

Example Request

curl -X POST https://api.neuralrev.ai/integration/payers \
  -H "x-api-key: nrev_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "PAYER-001",
    "name": "Blue Cross Blue Shield",
    "payer_code": "BCBS",
    "payer_type": "Private",
    "contact_email": "claims@bcbs.example.com",
    "contact_phone": "8005550100",
    "fax": "8005550101",
    "website": "https://www.bcbs.com",
    "address_line1": "225 North Michigan Ave",
    "city": "Chicago",
    "state": "IL",
    "zip_code": "60601",
    "country": "US"
  }'

Response

200 OK — Payer upserted successfully:

{
  "success": true,
  "message": "Payer upserted successfully"
}

400 Bad Request — Validation error:

{
  "error": "Validation failed",
  "details": [
    {"field": "name", "message": "Required"}
  ]
}

Notes

Create payers before creating patients with insurance, as insurance objects reference the payer's id.
The payer_code is useful for internal identification and clearinghouse routing.
Common payer_type values: Private, Medicare, Medicaid, Tricare, Workers Compensation, Self-Pay.

Payers

Upsert Payer

Request Body

Example Request

Response

Notes

On this page