Verifications are a core concept of the Sohar platform. A Verification represents a request for eligibility status and benefits information for a given patient.

Webhooks

The Sohar service operates asynchronously, utilizing webhooks to facilitate real-time interactions. We use Svix to send webhook events; for more information please refer to their documentation.

This section provides detailed information about the webhooks triggered by specific events. Webhooks can be configured in the Sohar dashboard.

Events

verification.updated

Occurs whenever a production verification has been completed.

sandbox.verification.updated

Occurs whenever a sandbox verification has been completed.

verification.pending

Occurs whenever a production verification has not been resolved immediately.

sandbox.verification.pending

Occurs whenever a sandbox verification has not been resolved immediately.

Attributes

{
	"verificationId": "990cdad8-1438-4bbd-8b55-120b56e87540",
	"id": "123456",
	"status": "complete.eligible"
	...
}
verificationId
string
required

A unique identifier for the verification.

id
string

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

status
string
required

The status of the verification.

Statuses

StatusDescription
complete.eligibleThe verification was successfully completed; Patient is confirmed active coverage and covered for the provided taxonomy code.
complete.ineligibleThe verification was successfully completed; Patient is either inactive and/or not covered for the provided taxonomy code.
error.member.idThe member ID was not recognized by the payer, or a different payer ID should be used.
error.member.dobThe patient’s date of birth was not recognized by the payer, or a different payer ID should be used.
error.member.nameThe patient’s name was not recognized by the payer, or a different payer ID should be used. This is often due to incorrect spelling or nicknames.
error.payerThe payer has been unavailable for over 24 hours and the Sohar Operations team have been unable to resolve the verification via payer portal or phone call.
error.payer.npiThe provided NPI is not recognized by the payer. Some payers require an NPI on file in order to provide benefits. Some payers require a rendering NPI in order to provide benefits, for example Blue Cross Blue Shield of Texas.
pendingThe verification could not be resolved immediately, typically because the payer API was unavailable. A verification with this status will be followed by one of the statuses listed above.

Sandbox Values

Use the following payerId and memberId values in the sandbox environment for pre-defined responses.

Payer IDMember IDStatus
6005400000000complete.eligible
6005400000001complete.ineligible
6005410000000error.member.id
6005410000001error.member.dob
6005410000002error.member.name
OSCARerror.payer.npi
06111pending