Skip to main content
GET
Get Pulse

Authorizations

Authorization
string
header
required

Include an OAuth 2.0 bearer token in the Authorization header. See Authentication.

Response

A pulse

pulseId
string<uuid>

The Sohar ID for the request

Example:

"fb701ac1-1246-4860-b1ec-bd916b97a991"

id
string | null

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

Example:

"123456"

status
string

Describes the status of the request

Example:

"complete.active"

statusReason
enum<string> | null

Reason for the pulse status when status is "complete.inactive" 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 pulse requires manual payer contact, 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), REFERRAL_REQUIRED indicates the requested service requires a referral.

Available options:
INACTIVE,
NON_COVERED,
CONTACT_PAYER_REQUIRED,
ACTIVE_PENDING_INVESTIGATION,
REFERRAL_REQUIRED
plan
object
payer
object
group
object
patient
object
benefits
object[]