API Reference
Create Verifications V1
This API is still available but no longer supported and is planned for deprecation in a future release; users should transition to the Create Verifications API.
curl --request POST \
--url https://api.soharhealth.com/v1/verifications/batch \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"verifications": [
{
"firstName": "John",
"lastName": "Doe",
"dateOfBirth": "09/20/2023",
"state": "CA",
"memberId": "00000000",
"payerId": "62308",
"npi": "0123456789",
"taxonomyCode": "2084P0800X",
"placeOfService": "02",
"id": "123456",
"subscriber": {
"firstName": "<string>",
"lastName": "<string>",
"dateOfBirth": "09/20/2023"
}
}
]
}'{
"results": [
{
"status": 201,
"patientId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"verificationId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"error": "invalid_request_error",
"param": "memberId",
"id": "123456"
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
The patient's first name
"John"
The patient's last name
"Doe"
The patient's birth date in MM/DD/YYYY format
"09/20/2023"
Two-letter US state code
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 "CA"
The insurance member ID
"00000000"
The payer ID. See the Sohar payer list
"62308"
An NPI to identify the provider requesting benefits, typically a type 2 NPI
"0123456789"
An optional taxonomy code to override the primary taxonomy code associated with the provider's NPI number
"2084P0800X"
An optional two-digit code that describes the setting in which a service was provided
"02"
An optional identifier for the verification
45"123456"
An optional object to describe the subscriber related to the insurance member ID. Used when the patient is a dependent - the subscriber is typically a parent or spouse
Response
An HTTP status code for the request
201
A Sohar ID for the patient if the request was successful
"f47ac10b-58cc-4372-a567-0e02b2c3d479"
A Sohar ID for the verification if the request was successful
"f47ac10b-58cc-4372-a567-0e02b2c3d479"
An error message if the request was unsuccessful
"invalid_request_error"
The parameter that was invalid in the request, if the request was unsuccessful
"memberId"
An optional identifier for the verification. This is a user-defined value that can be used when creating the verification
"123456"
curl --request POST \
--url https://api.soharhealth.com/v1/verifications/batch \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"verifications": [
{
"firstName": "John",
"lastName": "Doe",
"dateOfBirth": "09/20/2023",
"state": "CA",
"memberId": "00000000",
"payerId": "62308",
"npi": "0123456789",
"taxonomyCode": "2084P0800X",
"placeOfService": "02",
"id": "123456",
"subscriber": {
"firstName": "<string>",
"lastName": "<string>",
"dateOfBirth": "09/20/2023"
}
}
]
}'{
"results": [
{
"status": 201,
"patientId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"verificationId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"error": "invalid_request_error",
"param": "memberId",
"id": "123456"
}
]
}