> ## 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.

# Retrieve a verification of benefits request

> Poll this resource for the request's status. A failed request returns 200 with a structured error; a completed one lists the patient, every policy and every verification of benefits, by ID.



## OpenAPI

````yaml https://api.getsolum.com/openapi.json get /v1/verification-of-benefits-requests/{request_id}
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-requests/{request_id}:
    get:
      tags:
        - Verification of Benefits Requests
      summary: Retrieve a verification of benefits request
      description: >-
        Poll this resource for the request's status. A failed request returns
        200 with a structured error; a completed one lists the patient, every
        policy and every verification of benefits, by ID.
      operationId: retrieve_request_v1_verification_of_benefits_requests__request_id__get
      parameters:
        - name: request_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
            title: Request Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VerificationRequestView'
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Not Found
        '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:
    VerificationRequestView:
      properties:
        id:
          type: string
          format: uuid
          title: Id
        status:
          $ref: '#/components/schemas/AsyncOperationStatus'
        patient:
          anyOf:
            - $ref: '#/components/schemas/IntakePatientOutcome'
            - type: 'null'
        policies:
          items:
            $ref: '#/components/schemas/IntakePolicyOutcome'
          type: array
          title: Policies
        verifications:
          items:
            $ref: '#/components/schemas/IntakeVerificationOutcome'
          type: array
          title: Verifications
        error:
          anyOf:
            - $ref: '#/components/schemas/RequestError'
            - type: 'null'
        created_at:
          type: string
          format: date-time
          title: Created At
        updated_at:
          type: string
          format: date-time
          title: Updated At
        completed_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Completed At
      additionalProperties: false
      type: object
      required:
        - id
        - status
        - created_at
        - updated_at
      title: VerificationRequestView
    ErrorResponse:
      properties:
        type:
          type: string
          title: Type
        code:
          type: string
          title: Code
        message:
          type: string
          title: Message
        param:
          anyOf:
            - type: string
            - type: 'null'
          title: Param
        meta:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Meta
      additionalProperties: false
      type: object
      required:
        - type
        - code
        - message
      title: ErrorResponse
      description: >-
        Clean error response schema following RFC 7807 inspired format.


        Error is returned directly without wrapper, with all fields in
        snake_case.


        Fields:

        - type: Error category (e.g., "validation_error", "resource_error")

        - code: Specific error code (e.g., "resource_missing", "invalid_field")

        - message: Human-readable error message

        - param: The parameter that caused the error (optional)

        - meta: Generic free-form bag for resource-specific context (optional).
          For 409 resource_conflict responses the conflicting resource is nested
          here under the resource-specific key, e.g. ``meta.existing_patient``.
    AsyncOperationStatus:
      type: string
      enum:
        - queued
        - processing
        - completed
        - failed
      title: AsyncOperationStatus
    IntakePatientOutcome:
      properties:
        id:
          type: string
          format: uuid
          title: Id
        action:
          $ref: '#/components/schemas/IntakePatientAction'
      additionalProperties: false
      type: object
      required:
        - id
        - action
      title: IntakePatientOutcome
    IntakePolicyOutcome:
      properties:
        id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Id
          description: The policy; null for an input that was not stored.
        action:
          $ref: '#/components/schemas/IntakePolicyAction'
        reason:
          anyOf:
            - $ref: '#/components/schemas/IntakePolicyReason'
            - type: 'null'
        source:
          anyOf:
            - $ref: '#/components/schemas/IntakePolicySource'
            - type: 'null'
          description: Which input named the policy; null when none did.
      additionalProperties: false
      type: object
      required:
        - action
      title: IntakePolicyOutcome
    IntakeVerificationOutcome:
      properties:
        id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Id
          description: The VOB opened or found open; null when none was requested.
        patient_policy_id:
          type: string
          format: uuid
          title: Patient Policy Id
        status:
          $ref: '#/components/schemas/IntakeVerificationStatus'
        reason:
          anyOf:
            - $ref: '#/components/schemas/IntakeVerificationReason'
            - type: 'null'
        left_out:
          items:
            $ref: '#/components/schemas/ServiceType'
          type: array
          title: Left Out
          description: Specialties that could not be requested on this policy's VOB.
      additionalProperties: false
      type: object
      required:
        - patient_policy_id
        - status
      title: IntakeVerificationOutcome
    RequestError:
      properties:
        code:
          type: string
          title: Code
        message:
          type: string
          title: Message
        retryable:
          type: boolean
          title: Retryable
        fields:
          items:
            $ref: '#/components/schemas/FieldError'
          type: array
          title: Fields
      additionalProperties: false
      type: object
      required:
        - code
        - message
        - retryable
      title: RequestError
    IntakePatientAction:
      type: string
      enum:
        - created
        - updated
        - matched
      title: IntakePatientAction
    IntakePolicyAction:
      type: string
      enum:
        - matched
        - filled
        - corrected
        - created
        - unchanged
        - skipped
      title: IntakePolicyAction
      description: |-
        What the intake did to one policy. `matched`: an input named it and
        nothing changed; `unchanged`: no input named it (a policy the patient
        already had, or one moved off its tier); `skipped`: an input that was
        not stored — its entry has no id.
    IntakePolicyReason:
      type: string
      enum:
        - new_member_number
        - corrected_insurance
        - specific_insurance
        - tier_moved
        - unresolved_payer
        - ambiguous
        - no_member_number
        - tiers_full
        - conflicts_with_request
        - duplicate_policy
        - external_id_taken
        - not_saved
      title: IntakePolicyReason
    IntakePolicySource:
      type: string
      enum:
        - request
        - card
        - both
      title: IntakePolicySource
    IntakeVerificationStatus:
      type: string
      enum:
        - opened
        - already_open
        - not_requested
      title: IntakeVerificationStatus
    IntakeVerificationReason:
      type: string
      enum:
        - no_service_type
        - specialties_unresolved
      title: IntakeVerificationReason
    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.
    FieldError:
      properties:
        path:
          type: string
          title: Path
        code:
          type: string
          title: Code
        message:
          type: string
          title: Message
      additionalProperties: false
      type: object
      required:
        - path
        - code
        - message
      title: FieldError
  securitySchemes:
    APIKeyHeader:
      type: apiKey
      in: header
      name: X-API-Key
    HTTPBearer:
      type: http
      scheme: bearer

````