Skip to main content
POST
Medicare Card

Authorizations

Authorization
string
header
required

Use your API token as a Bearer token in the Authorization header.

Headers

Authorization
string
required
Example:

"Bearer {your_api_token}"

Accept
string
default:application/json
Content-Type
string
default:application/json

Body

application/json
fullName1
string
required

First full name on the card.

cardExpiry
string
required

Card expiry date in DD-MM-YYYY format.

Example:

"31-12-2026"

cardNumber
string
required

Medicare card number.

cardType
enum<string>
required

Medicare card type (G, B, or Y).

Available options:
G,
B,
Y
Example:

"G"

individualRefNumber
integer
required

Individual reference number printed on the card.

Example:

1

dob
string
required

Date of birth in DD-MM-YYYY format.

Example:

"15-03-1990"

fullName2
string

Second full name on the card, if any.

fullName3
string

Third full name on the card, if any.

fullName4
string

Fourth full name on the card, if any.

metadata
object

Optional key-value pairs echoed back in the response.

Response

Request processed. Check data.isValid and verificationStatus to determine the outcome.

success
boolean
required
message
string
required
data
object
required
verificationStatus
enum<string>
required
Available options:
VERIFIED,
REJECTED
verificationStatusCode
integer
required

3 = Verified, 1 = Rejected.

transactionId
string<uuid>
required
verificationType
string
required
Example:

"australia_medicare_card"

createdAt
string
required
metadata
object | null