Skip to main content
GET
/
medicare
/
cardholders
List Medicare cardholders
curl --request GET \
  --url https://api.example.com/medicare/cardholders
{
  "items": [
    {
      "id": "<string>",
      "referenceNumber": "<string>",
      "lastName": "<string>",
      "dateOfBirth": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "verified": true,
      "firstName": "<string>",
      "secondInitial": "<string>",
      "sex": "<string>",
      "verifiedAt": "2023-11-07T05:31:56Z",
      "medicareCard": {
        "id": "<string>",
        "memberNumberLast4": "<string>",
        "defaultReferenceNumber": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "fingerprint": "<string>",
        "cardholders": "<array>"
      },
      "verifications": [
        {
          "id": "mdvf_1234567890",
          "status": "matched",
          "medicareCard": {
            "fingerprint": "236510e8c462371d40e5c9e3d39f9ca9ad7c353c7e8c1e2c627c8f86373b0512",
            "referenceNumber": "1"
          },
          "createdAt": "2025-01-01T00:00:00.000Z",
          "effectiveDate": "2025-01-01",
          "message": "Patient is eligible to claim for Medicare with details provided.",
          "adviceCode": "check_date_of_birth"
        }
      ]
    }
  ],
  "page": 1,
  "limit": 10,
  "totalItems": 100,
  "totalPages": 10
}

Query Parameters

page
number
default:1

Page number

Required range: 1 <= x <= 9007199254740991
Example:

1

limit
number
default:10

Number of items per page

Required range: 1 <= x <= 200
Example:

10

q
string

Query string to search for cardholders

Required string length: 1 - 255

Response

200 - application/json
items
object[]
page
number
Example:

1

limit
number
Example:

10

totalItems
number
Example:

100

totalPages
number
Example:

10