GET
/
v1
/
verifications
/
{verificationId}
curl --request GET \
  --url https://api.soharhealth.com/v1/verifications/{verificationId} \
  --header 'Authorization: Bearer <token>'
{
  "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": [
    {
      "networkStatus": "inn",
      "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"
    }
  ],
  "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"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

200
application/json
A verification
​
patientId
string
required

The Sohar ID for the patient

Example:

"f47ac10b-58cc-4372-a567-0e02b2c3d479"

​
verificationId
string
required

The Sohar ID for the verification

Example:

"fb701ac1-1246-4860-b1ec-bd916b97a990"

​
timestamp
string
required

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

Example:

"2024-01-01T12:00:00.000Z"

​
status
string
required

The status of the verification

Example:

"complete.eligible"

​
memberId
string
required

The insurance member ID

Example:

"00000000"

​
payerId
string
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

Example:

"60054"

​
payerName
string
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

Example:

"Aetna"

​
benefits
object[]
required
​
relatedEntities
object[]
required

An array of related entities

​
patient
object
required
​
subscriber
object
required
​
coverageStartDate
string | null

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

Example:

"09/20/2023"

​
coverageEndDate
string | null

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

Example:

"09/20/2023"

​
planName
string | null

Describes the patient's plan

Example:

"Open Choice"

​
groupNumber
string | null

Describes the patient's group number

Example:

"123456"

​
groupName
string | null

Describes the patient's group name

Example:

"Acme Corporation"

​
insuranceTypeCode
string | null

Describes the patient's insurance type

Example:

"HM"

​
id
string | null

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

Example:

"123456"

Create Verifications V1