Sign in

v1

latestOpenAPI 3.0.0MIT2026-07-22275773.2 KB
Discovery

Create Discovery V1

post/v1/discovery

Request body

firstNamestring required

The patient's first name

lastNamestring required

The patient's last name

dateOfBirthstring required

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

state'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' required

Two-letter US state code

npistring required

A Type 1 or Type 2 NPI

zipCodestring

An optional parameter to improve patient matching confidence

payerIdstring

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

idstring

An optional user defined identifier for the discovery

Example request

{
  "firstName": "John",
  "lastName": "Doe",
  "dateOfBirth": "09/20/2023",
  "state": "CA",
  "npi": "0123456789",
  "zipCode": "90210",
  "payerId": "62308",
  "id": "123456"
}

Response

A discovery ID

discoveryIdstring

The Sohar ID for the discovery

idstring nullable

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

Example response

{
  "discoveryId": "fb701ac1-1246-4860-b1ec-bd916b97a990",
  "id": "123456"
}