Skip to main content
POST
Create Cost Estimate

Authorizations

Authorization
string
header
required

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

Body

application/json
verificationId
string<uuid>
required

A Sohar Verification ID

Example:

"fb701ac1-1246-4860-b1ec-bd916b97a990"

tin
string
required

A Tax Identification Number (9 digits)

Example:

"752326127"

networkStatus
enum<string>
required

Determines whether the benefits apply to patients in or out of network

Available options:
inn,
oon
Example:

"inn"

lines
object[]
required

An array of billing lines with codes and contracted rates

Minimum array length: 1
tier
number | null

The benefits tier, if multiple benefits are available

Example:

1

Response

A cost estimate

requestId
string<uuid>
required

Unique identifier for the cost estimate request

Example:

"0942a568-b015-438e-b7be-d0234f401f35"

verificationId
string<uuid>
required

The Sohar ID for the verification used to create this cost estimate

Example:

"fb701ac1-1246-4860-b1ec-bd916b97a990"

paidAmount
number
required

The total amount paid by the payer in USD

Example:

80

patientResponsibility
number
required

The total amount owed by the patient in USD

Example:

120

postDeductiblePatientResponsibility
number | null
required

The total amount owed by the patient in USD when the remaining deductible is zero. Null when no deductible remains.

Example:

60

lines
object[]
required

Cost estimate breakdown for each billing line