Before using this guide you will need a developer account and an access token. You can contact us about creating a developer account here. To get an access token, review the authentication and access tokens guide.
Before making changes, you’ll want to understand the current insurance ecosystem: plans available, categories, and what's already mapped for a provider location.
There are multiple levels of insurance information granularity you can retrieve via endpoints.
Retrieve a list of insurance plans
Use this endpoint to fetch a list of insurance plans based on filters like:
- Status:
active
,inactive
,deleted
- Plan Type:
hmo
,ppo
,epo
,pos
, etc. - Program Type:
commercial
,medicare
,medicaid
, etc. - Care Category:
health
,dental
,vision
- State: e.g.,
NY
,CA
- Sandbox
https://api-developer-sandbox.zocdoc.com/v1/insurance_plans
- Production
https://api-developer.zocdoc.com/v1/insurance_plans
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://api-developer-sandbox.zocdoc.com/v1/insurance_plans?page=0&page_size=100&status=inactive&state=NY&plan_type=hmo&program_type=commercial&care_category=health' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
Get details of a specific insurance plan
Returns detailed info about a specific insurance plan. Use this to populate plan descriptions or review coverage specifics.
- Sandbox
https://api-developer-sandbox.zocdoc.com/v1/insurance_plans/{insurance_plan_id}
- Production
https://api-developer.zocdoc.com/v1/insurance_plans/{insurance_plan_id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
https://api-developer-sandbox.zocdoc.com/v1/insurance_plans/ip_2224 \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
See current insurance mappings for a provider location
Fetches the insurance plans currently mapped to a specific provider location, grouped by:
- Carrier
- Program
- Network
This endpoint only supports providers with insurance mappings at the provider_location level. Requests for providers with insurance mappings at other entity levels will return a 409 conflict error.
For more information on each plan such as the name and other details you need to use the insurance_plans
endpoint above.
- Sandbox
https://api-developer-sandbox.zocdoc.com/v1/provider_locations/{provider_location_id}/insurance_mappings
- Production
https://api-developer.zocdoc.com/v1/provider_locations/{provider_location_id}/insurance_mappings
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://api-developer-sandbox.zocdoc.com/v1/provider_locations/{provider_location_id}/insurance_mappings' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
Submit a request to add, remove, or replace insurance mappings.
This is an asynchronous operation. Processing time varies depending on the volume of changes. For most cases, it completes instantaneously.
List of insurance plan ids
- Sandbox
https://api-developer-sandbox.zocdoc.com/v1/provider_locations/{provider_location_id}/insurance_mappings
- Production
https://api-developer.zocdoc.com/v1/provider_locations/{provider_location_id}/insurance_mappings
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
'https://api-developer-sandbox.zocdoc.com/v1/provider_locations/{provider_location_id}/insurance_mappings' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"insurance_plan_ids": [
"string"
],
"operation": "Add"
}'
- Sandbox
https://api-developer-sandbox.zocdoc.com/v1/provider_locations/{provider_location_id}/insurance_mappings
- Production
https://api-developer.zocdoc.com/v1/provider_locations/{provider_location_id}/insurance_mappings
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://api-developer-sandbox.zocdoc.com/v1/provider_locations/{provider_location_id}/insurance_mappings' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>'