Skip to main content
POST
/
v1
/
discovery
Create Discovery
curl --request POST \
  --url https://api.soharhealth.com/v1/discovery \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "firstName": "John",
  "lastName": "Doe",
  "dateOfBirth": "01/01/2000",
  "state": "CA",
  "npi": "0123456789",
  "zipCode": "90210",
  "id": "123456"
}
'
{
  "discoveryId": "fb701ac1-1246-4860-b1ec-bd916b97a990",
  "id": "123456"
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
firstName
string
required

The patient's first name

Example:

"John"

​
lastName
string
required

The patient's last name

Example:

"Doe"

​
dateOfBirth
string
required

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

Example:

"09/20/2023"

​
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
Example:

"CA"

​
npi
string
required

A Type 1 or Type 2 NPI

Example:

"0123456789"

​
zipCode
string

An optional parameter to improve patient matching confidence

Example:

"90210"

​
payerId
string

An optional parameter to prioritize the specified payer. See the Sohar payer list

Example:

"62308"

​
id
string

An optional user defined identifier for the discovery

Maximum string length: 255
Example:

"123456"

Response

A discovery ID

​
discoveryId
string

The Sohar ID for the discovery

Example:

"fb701ac1-1246-4860-b1ec-bd916b97a990"

​
id
string | null

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

Example:

"123456"