v1

latestOpenAPI 3.0.0MIT2026-07-22275773.2 KB

Legacy-Verifications

Get Verification V1

This API is still available but no longer supported and is planned for deprecation in a future release; users should transition to the Get Verification API.

get/v1/verifications/{verificationId}

Response

A verification

patientIdstring uuid required

The Sohar ID for the patient

verificationIdstring uuid required

The Sohar ID for the verification

timestampstring date-time required

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

statusstring required

The status of the verification

memberIdstring required

The insurance member ID

coverageStartDatestring nullable

Date on which coverage began in MM/DD/YYYY format

coverageEndDatestring nullable

Date on which coverage ends in MM/DD/YYYY format

payerIdstring uuid required

The payer ID. 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

payerNamestring required

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

planNamestring nullable

Describes the patient's plan

groupNumberstring nullable

Describes the patient's group number

groupNamestring nullable

Describes the patient's group name

insuranceTypeCodestring nullable

Describes the patient's insurance type

idstring nullable

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

Example response

{
  "patientId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
  "verificationId": "fb701ac1-1246-4860-b1ec-bd916b97a990",
  "timestamp": "2024-01-01T12:00:00.000Z",
  "status": "complete.eligible",
  "memberId": "00000000",
  "coverageStartDate": "09/20/2023",
  "coverageEndDate": "09/20/2023",
  "payerId": "60054",
  "payerName": "Aetna",
  "planName": "Open Choice",
  "groupNumber": "123456",
  "groupName": "Acme Corporation",
  "insuranceTypeCode": "HM",
  "id": "123456",
  "benefits": [
    {
      "tier": 1,
      "coinsurance": 0.1,
      "copay": 30,
      "totalDeductible": 1000,
      "remainingDeductible": 847.56,
      "outOfPocket": 10000,
      "outOfPocketRemaining": 5103.21,
      "coverageLevelCode": "IND"
    }
  ],
  "relatedEntities": [
    {
      "payerId": "01260",
      "payerName": "Magellan",
      "memberId": "00000000",
      "entityIdentifierCode": "PRP",
      "entityQualifier": "PART_A"
    }
  ],
  "patient": {
    "firstName": "John",
    "lastName": "Doe",
    "dateOfBirth": "09/20/2023",
    "state": "CA",
    "address": "1 BROADWAY, LOS ANGELES, CA 90210",
    "subscriberRelationshipCode": "18"
  },
  "subscriber": {
    "firstName": "JOHN",
    "lastName": "DOE"
  }
}