Get Verify Insurance Task

GET

https://api.ferry.health/api/v1/verify-insurance/:verifyInsuranceTaskId

GET

/api/v1/verify-insurance/:verifyInsuranceTaskId

1 curl https://api.ferry.health/api/v1/verify-insurance/ferry.task-verify-in-network.5d3ebb83-af31-41ca-9f85-e442927b8371 \
2      -H "Authorization: Bearer <token>"

Try it

200Retrieved

1 {
2   "status": "DONE",
3   "id": "ferry.task-verify-in-network.5d3ebb83-af31-41ca-9f85-e442927b8371",
4   "results": [
5     {
6       "insurancePlan": {
7         "planName": "Choice Plus",
8         "hiosId": "12345CA8910123",
9         "carrierName": "UnitedHealthCare"
10       },
11       "provider": {
12         "npi": "1234567890",
13         "address": "123 Happy Lane, San Francisco, CA 94106",
14         "url": "www.doctors.com/jane-smith"
15       },
16       "inNetworkStatus": "IN_NETWORK"
17     },
18     {
19       "insurancePlan": {
20         "planName": "Choice Plus",
21         "hiosId": "12345CA8910123",
22         "carrierName": "UnitedHealthCare"
23       },
24       "provider": {
25         "npi": "0001234567",
26         "address": "456 Medical Street, San Francisco, CA 94106",
27         "url": "www.doctors.com/jane-smith"
28       },
29       "inNetworkStatus": "OUT_OF_NETWORK"
30     }
31   ],
32   "zipCode": "94133"
33 }

Load a task by its ID.

Authentication

AuthorizationBearer

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

Path parameters

verifyInsuranceTaskIdstringRequired

The ID of the insurance-verification task.

Response

This endpoint returns an object.

IN_PROGRESSobject

We are verifying the insurance coverage of the providers.

DONEobject

We have completed our verification process.