--- title: "Get Verification" method: GET path: "/v2/verifications/{verificationId}" tags: ["Verifications"] --- # Get Verification `GET /v2/verifications/{verificationId}` ## Response `200` A verification - FullVerificationV2Response - `verificationId` string, uuid — The Sohar ID for the verification - `created` string, date-time — An ISO 8601 date and time string describing when the verification was created - `status` string — The [status](/documentation/guides/verification#statuses) 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). - `id` string, nullable — An optional identifier for the verification. This is a user-defined value that can be used when creating the verification - `placeOfServiceCode` string, nullable — Provided place of service code for the verification - `specialtyCode` string, nullable — Provided specialty code for the verification - `benefits` BenefitsV2[] - `networkStatus` 'inn' | 'oon' — Describes the network status of the benefits `inn` In Network `oon` Out of Network - `tier` number, nullable — The benefits tier, if multiple benefits are available. This attribute will be null if only one tier is available. - `accuracy` number, nullable — Confidence score (0–1) indicating historical accuracy of copay, coinsurance, deductible, and out-of-pocket values for a customer–payer. Calculated at runtime from past verifications and returned with each benefit tier when available. - `copay` number, nullable — The co-payment value, in USD - `coinsurance` number, nullable — The co-insurance value. Has the value `1` if co-insurance is 100%, indicating that the payer will not reimburse for this network status - `deductible` Deductible - `total` number, nullable — The patient's total deductible value, in USD - `remaining` number, nullable — The patient's remaining deductible value, in USD - `coverageLevelCode` string, nullable — Indicates the coverage level of the provided deductible information. Possible values include: IND, FAM, CHD, DEP, ECH, EMP, ESP, SPC, SPO - `outOfPocket` OutOfPocket - `total` number, nullable — The patient's out of pocket maximum value, in USD. Also known as the stop loss value - `remaining` number, nullable — The patient's remaining out of pocket value, in USD. Also known as the stop loss value - `coverageLevelCode` string, nullable — Indicates the coverage level of the provided out of pocket information. Possible values include: IND, FAM, CHD, DEP, ECH, EMP, ESP, SPC, SPO - `limitations` Limitation[] — An array of limitations associated with the verification - `total` number, nullable — The total limit for the benefit - `remaining` number, nullable — The remaining limit for the benefit - `network` 'inn' | 'oon' — The network this limitation applies to `inn` In Network `oon` Out of Network - `quantityQualifierCode` 'VS' — Limitation quantity qualifier code - `relatedEntities` RelatedEntityV2[] — An array of related entities - `id` string, uuid, nullable — The ID of the related entity - `soharId` string, uuid — The internal ID of the related entity - `name` string — The name of the related entity - `memberId` string, nullable — The insurance member ID, if the related entity knows the patient by a different member ID - `entityIdentifierCode` string, nullable — Specifies the role of the related entity `VN` Vendor `PRP` Primary Payer `SEP` Secondary Payer `TTP` Tertiary Payer `X3` Utilization Management Organization `TV` Third Party Administrator `Y2` Managed Care Organization `I3` Independent Physicians Association (IPA) `PR` Payer `P5` Plan Sponsor `13` Contracted Service Provider `1P` Provider `1I` Preferred Provider Organization (PPO) `2B` Third-Party Administrator - `entityQualifier` 'PART_A' | 'PART_B' | 'PART_C' | 'PART_D', nullable — Qualifier to indicate Medicare Part. Defaults to null and currently only populated for Medicare entities. - `patient` PatientV2 - `firstName` string — The patient's first name - `lastName` string — The patient's last name - `dateOfBirth` string — The patient's birth date in MM/DD/YYYY format - `memberId` string — The insurance member ID - `gender` 'M' | 'F' | 'U' — The patient's gender code `M` Male `F` Female `U` Unknown - `subscriberRelationshipCode` '01' | '04' | '05' | '07' | '10' | '15' | '17' | '18' | '19' | '20' | '21' | '22' | '23' | '24' | '26' | '29' | '30' | '31' | '32' | '33' | '36' | '39' | '40' | '41' | '43' | '53' | 'G8', nullable — Describes the relationship between the patient and the subscriber `01` Spouse `04` Grandfather or Grandmother `05` Grandson or Granddaughter `07` Nephew or Niece `10` Foster Child `15` Ward of the Court `17` Stepson or Stepdaughter `18` Self `19` Child `20` Employee `21` Unknown `22` Handicapped/Dependent `23` Sponsored Dependent `24` Dependent of Minor Dependent `26` Guardian `29` Significant Other `30` Both Parents - The legal custody of the student is with both parents `31` Court Appointed Guardian `32` Mother `33` Father `36` Emancipated Minor `39` Organ Donor `40` Cadaver Donor `41` Injured Plaintiff `43` Child Where Insured Has No Financial Responsibility `53` Life Partner `G8` Other Relationship - `address` Address - `address1` string, nullable — The first line of the patient's address - `address2` string, nullable — The second line of the patient's address - `city` string, nullable — The patient's city - `state` 'AK' | 'AL' | 'AR' | 'AZ' | 'CA' | 'CO' | 'CT' | 'DC' | 'DE' | 'FL' | 'GA' | 'HI' | 'IA' | 'ID' | 'IL' | 'IN' | 'KS' | 'KY' | 'LA' | 'MA' | 'MD' | 'ME' | 'MI' | 'MN' | 'MO' | 'MS' | 'MT' | 'NC' | 'ND' | 'NE' | 'NH' | 'NJ' | 'NM' | 'NV' | 'NY' | 'OH' | 'OK' | 'OR' | 'PA' | 'RI' | 'SC' | 'SD' | 'TN' | 'TX' | 'UT' | 'VA' | 'VT' | 'WA' | 'WI' | 'WV' | 'WY' — The patient's state - `zipCode` string, nullable — The patient's zip code - `subscriber` SubscriberV2 - `firstName` string, nullable — The subscriber's first name - `lastName` string, nullable — The subscriber's last name - `dateOfBirth` string, nullable — The subscriber's birth date in MM/DD/YYYY format - `gender` 'M' | 'F' | 'U' — The subscriber's gender code `M` Male `F` Female `U` Unknown - `plan` Plan - `name` string, nullable — Describes the patient's plan - `number` string, nullable — The plan's identification number - `insuranceTypeCode` string, nullable — Describes the patient's [insurance type](https://x12.org/codes/insurance-descriptor-codes) - `startDate` string, nullable — Date on which coverage began in MM/DD/YYYY format - `endDate` string, nullable — Date on which coverage ends in MM/DD/YYYY format - `networkId` string, nullable — The plan's network identifier - `payer` Payer - `id` string, uuid — The [payer ID](https://docs.soharhealth.com/api-reference/payers/get-payers). Note that this value may be different to the value provided in the original request if the original payer was incorrect and the correct payer has been found - `name` string — The payer's name. Note that this value may be different to the value provided in the original request if the original payer was incorrect and the correct payer has been found - `group` Group - `number` string, nullable — Describes the patient's group number - `name` string, nullable — Describes the patient's group name ## Other responses - `403` — Unauthorized - `404` — Not found - `500` — Internal error --- [API](https://skmtc.dev/soharhealth/apis/sohar-api.md) · [All operations](https://skmtc.dev/soharhealth/apis/sohar-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/soharhealth/sohar-api/revisions/2cb5fa45c18c/schema)