Skip to main content
POST
/
v1
/
au
/
medicare
/
cards
Create Medicare card
curl --request POST \
  --url https://api.halth.com/v1/au/medicare/cards \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "memberNumber": "3951330061",
  "referenceNumber": "1",
  "lastName": "Haywood",
  "dateOfBirth": "1975-04-03",
  "locationId": "prlo_39SaCy77MShwXBMzwFVSMHOtXdq",
  "firstName": "Brant",
  "secondInitial": "B",
  "sex": "M"
}
'
{
  "id": "<string>",
  "memberNumberLast4": "<string>",
  "referenceNumber": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "fingerprint": "<string>",
  "firstName": "<string>",
  "lastName": "<string>",
  "dateOfBirth": "<string>",
  "verified": true,
  "secondInitial": "<string>",
  "sex": "<string>",
  "verifiedAt": "2023-11-07T05:31:56Z"
}

Documentation Index

Fetch the complete documentation index at: https://docs.halth.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Provide your API key as a Bearer token

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

Pattern: /^[1-9]$/
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"

​
locationId
string

Location ID to use when submitting the verification request. When omitted, the software vendor location ID will be used.

Example:

"prlo_39SaCy77MShwXBMzwFVSMHOtXdq"

​
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
​
referenceNumber
string
required
​
createdAt
string<date-time>
required
​
fingerprint
string
required
​
firstName
string
required
​
lastName
string
required
​
dateOfBirth
string
required
​
verified
boolean
required
​
secondInitial
string
​
sex
string
​
verifiedAt
string<date-time>