Get Policy

{
  "id": "id",
  "payerId": "payerId",
  "payer": {
    "id": "id",
    "code": "code",
    "name": "name",
    "memberId": true,
    "hint": "hint"
  },
  "status": "PENDING",
  "state": "AL",
  "externalId": "externalId",
  "planName": "planName",
  "person": {
    "firstName": "firstName",
    "lastName": "lastName",
    "middleName": "middleName",
    "dateOfBirth": "2024-01-15T09:30:00Z"
  },
  "errors": [
    {
      "code": "code",
      "message": "message"
    },
    {
      "code": "code",
      "message": "message"
    }
  ],
  "memberId": "memberId",
  "policyHolder": {
    "firstName": "firstName",
    "lastName": "lastName",
    "middleName": "middleName",
    "dateOfBirth": "2024-01-15T09:30:00Z"
  },
  "relationship": "SELF",
  "patientId": "patientId",
  "latest": {
    "id": "id",
    "plan": "plan",
    "validatedAt": "2024-01-15T09:30:00Z",
    "effectiveFrom": "2024-01-15T09:30:00Z",
    "effectiveTo": "2024-01-15T09:30:00Z"
  }
}

Authentication

X-API-Keystring

API Key authentication via header

Path parameters

idstringRequired

Response

This endpoint returns an object.

idstring

payerIdstring

payerobject

statusenum

Allowed values:

stateenum

2 letter US state code

externalIdstringOptional

planNamestringOptional

personobjectOptional

errorslist of objectsOptional

memberIdstringOptional

policyHolderobjectOptional

relationshipenumOptional

Allowed values:

patientIdstringOptional

latestobjectOptional