Skip to main content
GET
/
api
/
v1
/
insurance_profiles
/
{id}
Error
A valid request URL is required to generate request examples
{
  "id": "<string>",
  "appeals_phone": "<string>",
  "claims_address": "<string>",
  "completeness_score": 123,
  "copay_primary": "<string>",
  "created_at": "<string>",
  "effective_date": "<string>",
  "expiration_date": "<string>",
  "expired": true,
  "field_sources": {},
  "form_authorizations": [
    {}
  ],
  "group_number": "<string>",
  "has_card_data": true,
  "has_policy_data": true,
  "insurance_members": [
    {
      "id": "<string>",
      "address_line1": "<string>",
      "address_line2": "<string>",
      "city": "<string>",
      "date_of_birth": "<string>",
      "email": "<string>",
      "legal_authorization_document_id": "<string>",
      "name": "<string>",
      "phone_number": "<string>",
      "postal_code": "<string>",
      "primary": true,
      "relationship": "<string>",
      "representative_member_id": "<string>",
      "representative_member_name": "<string>",
      "representative_type": "<string>",
      "state": "documents_received"
    }
  ],
  "insurer_fax": "<string>",
  "insurer_id": "<string>",
  "insurer_matched": true,
  "insurer_name": "<string>",
  "insurer_phone": "<string>",
  "linked_documents": [
    {
      "id": "<string>",
      "document_type": "<string>",
      "title": "<string>"
    }
  ],
  "member_id": "<string>",
  "members": [
    {
      "id": "<string>",
      "address_line1": "<string>",
      "address_line2": "<string>",
      "city": "<string>",
      "date_of_birth": "<string>",
      "email": "<string>",
      "legal_authorization_document_id": "<string>",
      "name": "<string>",
      "phone_number": "<string>",
      "postal_code": "<string>",
      "primary": true,
      "relationship": "<string>",
      "representative_member_id": "<string>",
      "representative_member_name": "<string>",
      "representative_type": "<string>",
      "state": "documents_received"
    }
  ],
  "network_type": "<string>",
  "patient_address": "<string>",
  "patient_address_line2": "<string>",
  "patient_city": "<string>",
  "patient_state": "<string>",
  "patient_zip": "<string>",
  "plan_name": "<string>",
  "plan_type": "<string>",
  "policy_number": "<string>",
  "rx_bin": "<string>",
  "rx_group": "<string>",
  "rx_pcn": "<string>",
  "status": "active",
  "updated_at": "<string>",
  "verified": true
}

Path Parameters

id
string
required

Response

OK

id
string
required
appeals_phone
string
required
claims_address
string
required
completeness_score
integer
required
copay_primary
string
required
created_at
string
required
effective_date
string
required
expiration_date
string
required
expired
boolean
required
field_sources
object
required
form_authorizations
object[]
required
group_number
string
required
has_card_data
boolean
required
has_policy_data
boolean
required
insurance_members
object[]
required
insurer_fax
string
required
insurer_id
string | null
required
insurer_matched
boolean
required
insurer_name
string
required
insurer_phone
string
required
linked_documents
object[]
required
member_id
string
required
members
object[]
required
network_type
string
required
patient_address
string
required
patient_address_line2
string | null
required
patient_city
string
required
patient_state
string
required
patient_zip
string
required
plan_name
string
required
plan_type
string
required
policy_number
string
required
rx_bin
string
required
rx_group
string
required
rx_pcn
string
required
status
enum<string>
required
Available options:
active,
expired,
superseded
updated_at
string
required
verified
boolean
required