> ## Documentation Index
> Fetch the complete documentation index at: https://docs.getsolum.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List verifications of benefits

> Lists your company's VOBs — grouped by status, most recently updated first — each with its policy and requested specialties. Filter by `patient_id`, `patient_policy_id`, `status` (repeatable) and `priority`. `include=result` adds each VOB's result (the benefits Solum verified; `null` until anything has been written); every row's `result_id` names it without embedding it. VOBs Solum created for verifications that predate VOB requests are listed too, with `backfilled: true`: their result can be a policy's current verification.



## OpenAPI

````yaml https://api.getsolum.com/openapi.json get /v1/verification-of-benefits
openapi: 3.1.0
info:
  title: Solum Health API
  description: '## Solum Health Backend API '
  version: 1.0.0
servers: []
security: []
paths:
  /v1/verification-of-benefits:
    get:
      tags:
        - Verification of Benefits
      summary: List verifications of benefits
      description: >-
        Lists your company's VOBs — grouped by status, most recently updated
        first — each with its policy and requested specialties. Filter by
        `patient_id`, `patient_policy_id`, `status` (repeatable) and `priority`.
        `include=result` adds each VOB's result (the benefits Solum verified;
        `null` until anything has been written); every row's `result_id` names
        it without embedding it. VOBs Solum created for verifications that
        predate VOB requests are listed too, with `backfilled: true`: their
        result can be a policy's current verification.
      operationId: list_vobs_v1_verification_of_benefits_get
      parameters:
        - name: page
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            description: Page number, from 1.
            default: 1
            title: Page
          description: Page number, from 1.
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            maximum: 100
            minimum: 1
            description: Page size, 1-100.
            default: 50
            title: Limit
          description: Page size, 1-100.
        - name: patient_id
          in: query
          required: false
          schema:
            anyOf:
              - type: string
                format: uuid
              - type: 'null'
            description: Only this patient's VOBs.
            title: Patient Id
          description: Only this patient's VOBs.
        - name: patient_policy_id
          in: query
          required: false
          schema:
            anyOf:
              - type: string
                format: uuid
              - type: 'null'
            description: Only this policy's VOBs.
            title: Patient Policy Id
          description: Only this policy's VOBs.
        - name: status
          in: query
          required: false
          schema:
            anyOf:
              - type: array
                items:
                  $ref: '#/components/schemas/VobStatus'
              - type: 'null'
            description: Only VOBs in these statuses.
            title: Status
          description: Only VOBs in these statuses.
        - name: priority
          in: query
          required: false
          schema:
            anyOf:
              - type: boolean
              - type: 'null'
            description: Only priority (true) or normal (false) VOBs.
            title: Priority
          description: Only priority (true) or normal (false) VOBs.
        - name: include
          in: query
          required: false
          schema:
            anyOf:
              - const: result
                type: string
              - type: 'null'
            description: '`result` embeds each VOB''s result.'
            title: Include
          description: '`result` embeds each VOB''s result.'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VobList'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  type:
                    type: string
                    example: validation_error
                  code:
                    type: string
                    example: invalid_parameter
                  message:
                    type: string
                    example: Field validation failed
                  param:
                    type: string
                    example: phone_number
                required:
                  - type
                  - code
                  - message
      security:
        - APIKeyHeader: []
        - HTTPBearer: []
components:
  schemas:
    VobStatus:
      type: string
      enum:
        - pending
        - in_progress
        - completed
        - missing_information
        - cancelled
      title: VobStatus
      description: VOB status enum matching Prisma exactly.
    VobList:
      properties:
        data:
          items:
            $ref: '#/components/schemas/VobOut'
          type: array
          title: Data
        pagination:
          $ref: '#/components/schemas/Pagination'
      additionalProperties: false
      type: object
      required:
        - data
        - pagination
      title: VobList
    VobOut:
      properties:
        id:
          type: string
          format: uuid
          title: Id
        created_at:
          type: string
          format: date-time
          title: Created At
        updated_at:
          type: string
          format: date-time
          title: Updated At
        patient_id:
          type: string
          format: uuid
          title: Patient Id
        priority:
          type: boolean
          title: Priority
          default: false
        created_by_id:
          type: string
          title: Created By Id
        company_id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Company Id
        version:
          type: integer
          title: Version
        status:
          type: string
          title: Status
        active:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Active
        reviewer_user_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Reviewer User Id
        reviewed_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Reviewed At
        completed_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Completed At
        completed_by_user_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Completed By User Id
        missing_information_since:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Missing Information Since
        sla_paused_seconds:
          type: integer
          title: Sla Paused Seconds
          default: 0
        patient_policy_id:
          type: string
          format: uuid
          title: Patient Policy Id
        backfilled:
          type: boolean
          title: Backfilled
          default: false
        specialties:
          items:
            $ref: '#/components/schemas/SpecialtyOut'
          type: array
          title: Specialties
          default: []
        result_id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Result Id
          description: >-
            The id of the VOB's result (`result.id`), on the list with or
            without `include=result`; `null` while it has none.
        result:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Result
        created_by:
          anyOf:
            - $ref: >-
                #/components/schemas/app__shared__work_record_schemas__UserSummary
            - type: 'null'
        patient:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Patient
      type: object
      required:
        - id
        - created_at
        - updated_at
        - patient_id
        - created_by_id
        - version
        - status
        - patient_policy_id
      title: VobOut
      description: >-
        A VOB: the request (policy + specialties) and, when asked for, its

        read-only result.


        `backfilled` VOBs were created by Solum for verifications that predate

        VOB requests; nobody asked for them, but their result can still be the

        policy's current verification. `result` is the benefits Solum verified

        (`null` until anything has been written) — on `GET /{id}` always, on the

        list with `include=result`. `result_id` names it on every row, so a list

        tells the VOBs that have a result from those that don't without
        embedding

        any: a policy's current verification is the result of its latest

        completed VOB that has one.
    Pagination:
      properties:
        has_more:
          type: boolean
          title: Has More
        total:
          type: integer
          title: Total
        page:
          type: integer
          title: Page
        limit:
          type: integer
          title: Limit
      additionalProperties: false
      type: object
      required:
        - has_more
        - total
        - page
        - limit
      title: Pagination
      description: |-
        Pagination information for list responses.

        Fields:
        - has_more: Whether more items exist beyond this page
        - total: Total number of items across all pages
        - page: Current page number (1-based)
        - limit: Number of items per page
    SpecialtyOut:
      properties:
        id:
          type: string
          title: Id
        service_type:
          $ref: '#/components/schemas/ServiceType'
        credentialing_id:
          type: string
          title: Credentialing Id
        npi:
          type: string
          title: Npi
        cpt_codes:
          items:
            type: string
          type: array
          title: Cpt Codes
        service_locations:
          items:
            $ref: '#/components/schemas/ServiceLocation'
          type: array
          title: Service Locations
        icd_codes:
          items:
            type: string
          type: array
          title: Icd Codes
        credentialing:
          anyOf:
            - $ref: '#/components/schemas/VobRequestServiceCredentialing'
            - type: 'null'
      type: object
      required:
        - id
        - service_type
        - credentialing_id
        - npi
        - cpt_codes
        - service_locations
        - icd_codes
      title: SpecialtyOut
      description: 'One requested specialty, as stored: every field resolved.'
    app__shared__work_record_schemas__UserSummary:
      properties:
        id:
          type: string
          title: Id
        name:
          anyOf:
            - type: string
            - type: 'null'
          title: Name
        email:
          anyOf:
            - type: string
            - type: 'null'
          title: Email
        image:
          anyOf:
            - type: string
            - type: 'null'
          title: Image
        user_type:
          anyOf:
            - type: string
            - type: 'null'
          title: User Type
      type: object
      required:
        - id
      title: UserSummary
    ServiceType:
      type: string
      enum:
        - medical_care
        - surgical
        - consultation
        - diagnostic_x_ray
        - diagnostic_lab
        - radiation_therapy
        - anesthesia
        - surgical_assistance
        - other_medical
        - blood_charges
        - used_durable_medical_equipment
        - durable_medical_equipment_purchase
        - ambulatory_service_center_facility
        - renal_supplies_in_home
        - alternate_method_dialysis
        - chronic_renal_disease_equipment
        - pre_admission_testing
        - durable_medical_equipment_rental
        - pneumonia_vaccine
        - second_surgical_opinion
        - third_surgical_opinion
        - social_work
        - diagnostic_dental
        - periodontics
        - restorative
        - endodontics
        - maxillofacial_prosthetics
        - adjunctive_dental_services
        - health_benefit_plan_coverage
        - plan_waiting_period
        - chiropractic
        - chiropractic_office_visits
        - dental_care
        - dental_crowns
        - dental_accident
        - orthodontics
        - prosthodontics
        - oral_surgery
        - routine_preventive_dental
        - home_health_care
        - home_health_prescriptions
        - home_health_visits
        - hospice
        - respite_care
        - hospital
        - hospital_inpatient
        - hospital_room_and_board
        - hospital_outpatient
        - hospital_emergency_accident
        - hospital_emergency_medical
        - hospital_ambulatory_surgical
        - long_term_care
        - major_medical
        - medically_related_transportation
        - air_transportation
        - cabulance
        - licensed_ambulance
        - general_benefits
        - in_vitro_fertilization
        - mri_cat_scan
        - donor_procedures
        - acupuncture
        - newborn_care
        - pathology
        - smoking_cessation
        - well_baby_care
        - maternity
        - transplants
        - audiology_exam
        - inhalation_therapy
        - diagnostic_medical
        - private_duty_nursing
        - prosthetic_device
        - dialysis
        - otological_exam
        - chemotherapy
        - allergy_testing
        - immunizations
        - routine_physical
        - family_planning
        - infertility
        - abortion
        - aids
        - emergency_services
        - cancer
        - pharmacy
        - free_standing_prescription_drug
        - mail_order_prescription_drug
        - brand_name_prescription_drug
        - generic_prescription_drug
        - podiatry
        - podiatry_office_visits
        - podiatry_nursing_home_visits
        - professional_physician
        - anesthesiologist
        - professional_visit_office
        - professional_visit_inpatient
        - professional_visit_outpatient
        - professional_visit_nursing_home
        - professional_visit_skilled_nursing_facility
        - professional_visit_home
        - psychiatric
        - psychiatric_room_and_board
        - psychotherapy
        - psychiatric_inpatient
        - psychiatric_outpatient
        - rehabilitation
        - rehabilitation_room_and_board
        - rehabilitation_inpatient
        - rehabilitation_outpatient
        - occupational_therapy
        - physical_medicine
        - speech_therapy
        - skilled_nursing_care
        - skilled_nursing_care_room_and_board
        - substance_abuse
        - alcoholism
        - drug_addiction
        - vision_optometry
        - frames
        - routine_exam
        - lenses
        - nonmedically_necessary_physical
        - experimental_drug_therapy
        - burn_care
        - brand_name_prescription_drug_formulary
        - brand_name_prescription_drug_non_formulary
        - independent_medical_evaluation
        - partial_hospitalization_psychiatric
        - day_care_psychiatric
        - cognitive_therapy
        - massage_therapy
        - pulmonary_rehabilitation
        - cardiac_rehabilitation
        - pediatric
        - nursery
        - skin
        - orthopedic
        - cardiac
        - lymphatic
        - gastrointestinal
        - endocrine
        - neurology
        - eye
        - invasive_procedures
        - gynecological
        - obstetrical
        - obstetrical_gynecological
        - mail_order_prescription_drug_brand_name
        - mail_order_prescription_drug_generic
        - physician_visit_office_sick
        - physician_visit_office_well
        - coronary_care
        - private_duty_nursing_inpatient
        - private_duty_nursing_home
        - surgical_benefits_professional
        - surgical_benefits_facility
        - mental_health_provider_inpatient
        - mental_health_provider_outpatient
        - mental_health_facility_inpatient
        - mental_health_facility_outpatient
        - substance_abuse_facility_inpatient
        - substance_abuse_facility_outpatient
        - screening_x_ray
        - screening_laboratory
        - mammogram_high_risk_patient
        - mammogram_low_risk_patient
        - flu_vaccination
        - eyewear_and_accessories
        - case_management
        - dermatology
        - durable_medical_equipment
        - diabetic_supplies
        - generic_prescription_drug_formulary
        - generic_prescription_drug_non_formulary
        - allergy
        - intensive_care
        - mental_health
        - neonatal_intensive_care
        - oncology
        - physical_therapy
        - pulmonary
        - renal
        - residential_psychiatric_treatment
        - transitional_care
        - transitional_nursery_care
        - urgent_care
      title: ServiceType
      description: |-
        X12 Service Type — human-readable enum values stored in the database.
        See app/utils/service_type_mapping.py for code-to-type mappings.
    ServiceLocation:
      type: string
      enum:
        - home
        - office
        - school
        - daycare
        - community
        - telehealth
        - on_campus_outpatient_hospital
      title: ServiceLocation
      description: Service location enum matching Prisma @@map("service_location").
    VobRequestServiceCredentialing:
      properties:
        id:
          type: string
          format: uuid
          title: Id
        name:
          type: string
          title: Name
        type:
          type: string
          title: Type
        is_active:
          type: boolean
          title: Is Active
      type: object
      required:
        - id
        - name
        - type
        - is_active
      title: VobRequestServiceCredentialing
      description: Denormalised credentialing summary embedded in a VOB specialty.
  securitySchemes:
    APIKeyHeader:
      type: apiKey
      in: header
      name: X-API-Key
    HTTPBearer:
      type: http
      scheme: bearer

````