Create Verifications

Authorizations

Authorization

string

header

required

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

Body

application/json

verifications

object[]

required

verifications.dateOfBirth

string

required

The patient's birth date in MM/DD/YYYY format

verifications.firstName

string

required

The patient's first name

verifications.lastName

string

required

The patient's last name

verifications.memberId

string

required

The insurance member ID

verifications.npi

string

required

An NPI to identify the provider requesting benefits, typically a type 2 NPI

verifications.payerId

string

required

The payer ID. See the Sohar payer list

verifications.state

enum<string>

required

Two-letter US state code

Available options:

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

verifications.id

string

An optional identifier for the verification

Maximum length: 45

verifications.placeOfService

string

An optional two-digit code that describes the setting in which a service was provided

verifications.subscriber

object

An optional object to describe the subscriber related to the insurance member ID. Used when the patient is a dependent - the subscriber is typically a parent or spouse

verifications.subscriber.dateOfBirth

string

The subscriber's birth date in MM/DD/YYYY format

verifications.subscriber.firstName

string

The subscriber's first name

verifications.subscriber.lastName

string

The subscriber's last name

verifications.taxonomyCode

string

An optional taxonomy code to override the primary taxonomy code associated with the provider's NPI number

Response

207 - application/json

results

object[]

results.error

string

An error message if the request was unsuccessful

results.id

string | null

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

results.param

string

The parameter that was invalid in the request, if the request was unsuccessful

results.patientId

string

A Sohar Health ID for the patient if the request was successful

results.status

number

An HTTP status code for the request

results.verificationId

string

A Sohar Health ID for the verification if the request was successful

API Reference

Verification

Discovery

Payers

Webhooks

Resources

Legacy Endpoints

Authorizations

Body

Response