API Reference
Get Verification
curl --request GET \
--url https://api.soharhealth.com/v2/verifications/{verificationId} \
--header 'Authorization: Bearer <token>'{
"verificationId": "fb701ac1-1246-4860-b1ec-bd916b97a990",
"created": "2024-01-01T12:00:00.000Z",
"status": "complete.eligible",
"id": "123456",
"benefits": [
{
"networkStatus": "inn",
"tier": 1,
"copay": 30,
"coinsurance": 0.1,
"deductible": {
"total": 1000,
"remaining": 847.56,
"coverageLevelCode": "IND"
},
"outOfPocket": {
"total": 10000,
"remaining": 5103.21
}
}
],
"relatedEntities": [
{
"id": "01260",
"name": "Magellan",
"memberId": "00000000",
"entityIdentifierCode": "PRP"
}
],
"patient": {
"firstName": "JOHN",
"lastName": "DOE",
"dateOfBirth": "09/20/2023",
"memberId": "00000000",
"subscriberRelationshipCode": "18",
"address": {
"address1": "1 BROADWAY",
"address2": "P.O. BOX 123",
"city": "LOS ANGELES",
"state": "CA",
"zipCode": "90210"
}
},
"subscriber": {
"firstName": "JOHN",
"lastName": "DOE"
},
"plan": {
"name": "OPEN CHOICE",
"insuranceTypeCode": "HM",
"startDate": "09/20/2023",
"endDate": "09/20/2023"
},
"payer": {
"id": "60054",
"name": "Aetna"
},
"group": {
"number": "123456",
"name": "ACME CORPORATION"
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Response
The Sohar ID for the verification
"fb701ac1-1246-4860-b1ec-bd916b97a990"
An ISO 8601 date and time string describing when the verification was created
"2024-01-01T12:00:00.000Z"
An optional identifier for the verification. This is a user-defined value that can be used when creating the verification
"123456"
Describes the network status of the benefits
inn In Network
oon Out of Network
inn, oon The benefits tier, if multiple benefits are available. This attribute will be null if only one tier is available.
1
The co-payment value, in USD
30
The co-insurance value. Has the value 1 if co-insurance is 100%, indicating that the payer will not reimburse for this network status
0.1
The patient's total deductible value, in USD
1000
The patient's remaining deductible value, in USD
847.56
Indicates the coverage level of the provided deductible information. Possible values include: IND, FAM, CHD, DEP, ECH, EMP, ESP, SPC, SPO
"IND"
An array of related entities
The ID of the related entity
"01260"
The name of the related entity
"Magellan"
The insurance member ID, if the related entity knows the patient by a different member ID
"00000000"
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
VN, PRP, SEP, TTP, X3, TV, Y2, I3, PR, P5, 1P, 1I, 2B "PRP"
The patient's first name
"JOHN"
The patient's last name
"DOE"
The patient's birth date in MM/DD/YYYY format
"09/20/2023"
The insurance member ID
"00000000"
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
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 "18"
The first line of the patient's address
"1 BROADWAY"
The second line of the patient's address
"P.O. BOX 123"
The patient's city
"LOS ANGELES"
The patient's 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 "CA"
The patient's zip code
"90210"
Describes the patient's plan
"OPEN CHOICE"
Describes the patient's insurance type
"HM"
Date on which coverage began in MM/DD/YYYY format
"09/20/2023"
Date on which coverage ends in MM/DD/YYYY format
"09/20/2023"
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
"60054"
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
"Aetna"
curl --request GET \
--url https://api.soharhealth.com/v2/verifications/{verificationId} \
--header 'Authorization: Bearer <token>'{
"verificationId": "fb701ac1-1246-4860-b1ec-bd916b97a990",
"created": "2024-01-01T12:00:00.000Z",
"status": "complete.eligible",
"id": "123456",
"benefits": [
{
"networkStatus": "inn",
"tier": 1,
"copay": 30,
"coinsurance": 0.1,
"deductible": {
"total": 1000,
"remaining": 847.56,
"coverageLevelCode": "IND"
},
"outOfPocket": {
"total": 10000,
"remaining": 5103.21
}
}
],
"relatedEntities": [
{
"id": "01260",
"name": "Magellan",
"memberId": "00000000",
"entityIdentifierCode": "PRP"
}
],
"patient": {
"firstName": "JOHN",
"lastName": "DOE",
"dateOfBirth": "09/20/2023",
"memberId": "00000000",
"subscriberRelationshipCode": "18",
"address": {
"address1": "1 BROADWAY",
"address2": "P.O. BOX 123",
"city": "LOS ANGELES",
"state": "CA",
"zipCode": "90210"
}
},
"subscriber": {
"firstName": "JOHN",
"lastName": "DOE"
},
"plan": {
"name": "OPEN CHOICE",
"insuranceTypeCode": "HM",
"startDate": "09/20/2023",
"endDate": "09/20/2023"
},
"payer": {
"id": "60054",
"name": "Aetna"
},
"group": {
"number": "123456",
"name": "ACME CORPORATION"
}
}