Get Policy

GET

/api/policies/:id

GET

/api/policies/:id

1 curl https://app.usebridge.com/api/policies/id \
2      -H "X-API-Key: <apiKey>"

Try it

200Retrieved

1 {
2   "id": "id",
3   "payerId": "payerId",
4   "payer": {
5     "id": "id",
6     "code": "code",
7     "name": "name",
8     "memberId": true,
9     "hint": "hint"
10   },
11   "status": "PENDING",
12   "state": "AL",
13   "planName": "planName",
14   "person": {
15     "firstName": "firstName",
16     "lastName": "lastName",
17     "middleName": "middleName",
18     "dateOfBirth": "2024-01-15T09:30:00Z"
19   },
20   "errors": [
21     {
22       "code": "code",
23       "message": "message"
24     },
25     {
26       "code": "code",
27       "message": "message"
28     }
29   ],
30   "memberId": "memberId",
31   "policyHolder": {
32     "firstName": "firstName",
33     "lastName": "lastName",
34     "middleName": "middleName",
35     "dateOfBirth": "2024-01-15T09:30:00Z"
36   },
37   "relationship": "SELF",
38   "patientId": "patientId",
39   "latest": {
40     "id": "id",
41     "plan": "plan",
42     "validatedAt": "2024-01-15T09:30:00Z",
43     "effectiveFrom": "2024-01-15T09:30:00Z",
44     "effectiveTo": "2024-01-15T09:30:00Z"
45   }
46 }

Path parameters

idstringRequired

Response

This endpoint returns an object.

idstring

payerIdstring

payerobject

statusenum

Allowed values:

stateenum

planNamestring or null

personobject or null

errorslist of objects or null

memberIdstring or null

policyHolderobject or null

relationshipenum or null

Allowed values:

patientIdstring or null

latestobject or null

Path parameters

Headers

Response