v1

latestOpenAPI 3.0.0MIT2026-07-22275773.2 KB

Verifications

Get Verification

get/v2/verifications/{verificationId}

Response

A verification

verificationIdstring uuid

The Sohar ID for the verification

createdstring date-time

An ISO 8601 date and time string describing when the verification was created

statusstring

The status of the verification

statusReason'INACTIVE' | 'NON_COVERED' | 'CONTACT_PAYER_REQUIRED' | 'ACTIVE_PENDING_INVESTIGATION' nullable

Reason for the verification status when status is "complete.ineligible" or "error.payer". INACTIVE indicates coverage is inactive, NON_COVERED indicates coverage is active but the requested service type is not covered, CONTACT_PAYER_REQUIRED indicates the verification is pending but requires manual payer contact when manual resolution is not enabled, ACTIVE_PENDING_INVESTIGATION indicates coverage is active but further investigation is required to determine eligibility (ie premium not paid).

idstring nullable

An optional identifier for the verification. This is a user-defined value that can be used when creating the verification

placeOfServiceCodestring nullable

Provided place of service code for the verification

specialtyCodestring nullable

Provided specialty code for the verification

Example response

{
  "verificationId": "fb701ac1-1246-4860-b1ec-bd916b97a990",
  "created": "2024-01-01T12:00:00.000Z",
  "status": "complete.eligible",
  "id": "123456",
  "placeOfServiceCode": "11",
  "specialtyCode": "PSY",
  "benefits": [
    {
      "tier": 1,
      "accuracy": 0.84,
      "copay": 30,
      "coinsurance": 0.1,
      "deductible": {
        "total": 1000,
        "remaining": 847.56,
        "coverageLevelCode": "IND"
      },
      "outOfPocket": {
        "total": 10000,
        "remaining": 5103.21,
        "coverageLevelCode": "IND"
      }
    }
  ],
  "limitations": [
    {
      "total": 20,
      "remaining": 12
    }
  ],
  "relatedEntities": [
    {
      "id": "01260",
      "soharId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
      "name": "Magellan",
      "memberId": "00000000",
      "entityIdentifierCode": "PRP",
      "entityQualifier": "PART_A"
    }
  ],
  "patient": {
    "firstName": "JOHN",
    "lastName": "DOE",
    "dateOfBirth": "09/20/2023",
    "memberId": "00000000",
    "gender": "F",
    "subscriberRelationshipCode": "18",
    "address": {
      "address1": "1 BROADWAY",
      "address2": "P.O. BOX 123",
      "city": "LOS ANGELES",
      "state": "CA",
      "zipCode": "90210"
    }
  },
  "subscriber": {
    "firstName": "JOHN",
    "lastName": "DOE",
    "dateOfBirth": "09/20/2023",
    "gender": "M"
  },
  "plan": {
    "name": "OPEN CHOICE",
    "number": "12345678",
    "insuranceTypeCode": "HM",
    "startDate": "09/20/2023",
    "endDate": "09/20/2023",
    "networkId": "A2"
  },
  "payer": {
    "id": "60054",
    "name": "Aetna"
  },
  "group": {
    "number": "123456",
    "name": "ACME CORPORATION"
  }
}