Skip to main content

PayerSchema

_archivedboolean
archivedboolean
archived_datedate-timenullable
archivedbynullable
archivedby_idintegernullable
crawl_queuestringrequired
dataobjectsundefined[]
disabledboolean
employer_payersundefined[]
employersundefined[]
has_security_questionsboolean
has_two_factor_authboolean
idinteger
interoperability_apisundefined[]
is_premium_claims_harvestingboolean

True if the payer is signed up for premium claims harvesting

is_primaryboolean

This payer is the primary payer in a payer group. For use with Patient Access API

is_testboolean
login_problem_emails_disabledboolean
logo_urlstringnullable
long_namestringnullable

Includes whether this is Patient Access API, otherwise this should be the same as name

namestringrequired
onboard_form object
property name*any
onboard_form_stringstringrequired
onboard_ui_schema object
property name*any
payer_group_idintegernullable
payer_idinteger
policy_holdersundefined[]
polymorphicstringnullable
redirect_vendor_namestring
register_urlstringnullable
retrieverstringrequired
retriever_proxynullable
retriever_proxy_idintegernullable
short_namestringnullable
supports_interoperability_apisboolean
supports_realtime_verificationboolean
tenant_idintegernullable

Used for Carrier Feeds

tpas_claim_statementsbooleannullable
Determines whether we allow generating eob pdfs for claims
website_home_urlstringnullable

i.e. https://www.medmutual.com/

website_home_url_netlocstring
PayerSchema
{
  "_archived": true,
  "archived": true,
  "archived_date": "2024-07-29T15:51:28.071Z",
  "archivedby_id": 0,
  "crawl_queue": "string",
  "dataobjects": [
    null
  ],
  "disabled": true,
  "employer_payers": [
    null
  ],
  "employers": [
    null
  ],
  "has_security_questions": true,
  "has_two_factor_auth": true,
  "id": 0,
  "interoperability_apis": [
    null
  ],
  "is_premium_claims_harvesting": true,
  "is_primary": true,
  "is_test": true,
  "login_problem_emails_disabled": true,
  "logo_url": "string",
  "long_name": "string",
  "name": "string",
  "onboard_form": {},
  "onboard_form_string": "string",
  "onboard_ui_schema": {},
  "payer_group_id": 0,
  "payer_id": 0,
  "policy_holders": [
    null
  ],
  "polymorphic": "string",
  "redirect_vendor_name": "string",
  "register_url": "string",
  "retriever": "string",
  "retriever_proxy_id": 0,
  "short_name": "string",
  "supports_interoperability_apis": true,
  "supports_realtime_verification": true,
  "tenant_id": 0,
  "tpas_claim_statements": true,
  "website_home_url": "string",
  "website_home_url_netloc": "string"
}