Skip to main content
POST
/
medicare
/
cards
Create Medicare card
curl --request POST \
  --url https://api.example.com/medicare/cards \
  --header 'Content-Type: application/json' \
  --data '
{
  "memberNumber": "3951330061",
  "referenceNumber": "1",
  "lastName": "Haywood",
  "dateOfBirth": "1975-04-03",
  "firstName": "Brant",
  "secondInitial": "B",
  "sex": "M"
}
'
{
  "id": "<string>",
  "memberNumberLast4": "<string>",
  "defaultReferenceNumber": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "fingerprint": "<string>",
  "cardholders": [
    {
      "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": "<unknown>",
      "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"
        }
      ]
    }
  ]
}

Query Parameters

verify
boolean

Whether to verify the Medicare card after creation

Body

application/json
memberNumber
string
required

Member number

Required string length: 10
Example:

"3951330061"

referenceNumber
string
required

Individual reference number / position on card

Example:

"1"

lastName
string
required

Last name

Required string length: 1 - 40
Example:

"Haywood"

dateOfBirth
string
required

Date of birth in format yyyy-mm-dd

Example:

"1975-04-03"

firstName
string

First name

Required string length: 1 - 40
Example:

"Brant"

secondInitial
string

Second initial

Required string length: 1
Example:

"B"

sex
enum<string>

Sex

Available options:
M,
F,
U
Example:

"M"

Response

201 - application/json
id
string
required
memberNumberLast4
string
required
defaultReferenceNumber
string
required
createdAt
string<date-time>
required
fingerprint
string
required
cardholders
object[]