Skip to main content
GET
Get Verification

Authorizations

Authorization
string
header
required

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

Response

A verification

verificationId
string<uuid>

The Sohar ID for the verification

Example:

"fb701ac1-1246-4860-b1ec-bd916b97a990"

created
string<date-time>

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

Example:

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

status
string

The status of the verification

Example:

"complete.eligible"

statusReason
enum<string> | null

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).

Available options:
INACTIVE,
NON_COVERED,
CONTACT_PAYER_REQUIRED,
ACTIVE_PENDING_INVESTIGATION
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"

placeOfServiceCode
string | null

Provided place of service code for the verification

Example:

"11"

specialtyCode
string | null

Provided specialty code for the verification

Example:

"PSY"

benefits
object[]
limitations
object[]

An array of limitations associated with the verification

An array of related entities

patient
object
subscriber
object
plan
object
payer
object
group
object