> ## Documentation Index
> Fetch the complete documentation index at: https://docs.idmetagroup.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Medicare

> Verify Australian Medicare card details against health authority databases.



## OpenAPI

````yaml api-reference/openapi.json POST /api/v3/verifications/australia/medicare-card
openapi: 3.0.3
info:
  title: IDmeta API
  description: IDmeta verification and integration API.
  license:
    name: MIT
  version: 1.0.0
servers:
  - url: https://{environment-subdomain}.idmetagroup.com
    description: Your environment (replace `{environment-subdomain}`)
    variables:
      environment-subdomain:
        default: integrate
        description: IDmeta environment subdomain
security:
  - bearerAuth: []
tags:
  - name: Processes
    description: Verification process endpoints
  - name: Trust Flow Links
    description: Trust Flow link generation endpoints
  - name: Compliance
    description: Compliance verification endpoints
  - name: Government Data
    description: Government data verification endpoints
  - name: Alternative Verifications
    description: Alternative verification and intelligence endpoints
  - name: OCR
    description: Document OCR extraction endpoints
paths:
  /api/v3/verifications/australia/medicare-card:
    post:
      tags:
        - Government Data
      summary: AU Medicare Card
      description: >-
        Verify Australian Medicare card details against health authority
        databases.
      operationId: auMedicareCardVerificationV3
      parameters:
        - name: Accept
          in: header
          required: false
          schema:
            type: string
            default: application/json
        - name: Content-Type
          in: header
          required: false
          schema:
            type: string
            default: application/json
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AuMedicareCardRequest'
            examples:
              default:
                summary: AU Medicare card verification request
                value:
                  card_expiry: ''
                  card_number: ''
                  card_type: ''
                  dob: ''
                  individual_reference_number: ''
                  name1: ''
                  name2: ''
                  name3: ''
                  name4: ''
                  trustFlowId: 0
                  trustValidationId: '{your_trust_validation_id}'
      responses:
        '200':
          description: AU Medicare card verification processed successfully
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuMedicareCardV3Response'
              example:
                success: true
                message: Australia Medicare Card processed successfully
                data:
                  isValid: true
                verificationStatus: VERIFIED
                verificationStatusCode: 3
                trustFlowId: 0
                trustValidationId: '{your_trust_validation_id}'
                verificationType: australia_medicare_card
                metadata: null
components:
  schemas:
    AuMedicareCardRequest:
      type: object
      required:
        - card_expiry
        - card_number
        - card_type
        - individual_reference_number
        - name1
        - trustFlowId
        - trustValidationId
      properties:
        card_expiry:
          type: string
          description: Expiry date of the card in `YYYY-MM` format.
        card_number:
          type: string
          description: 10 digit card number associated with the individual.
        card_type:
          type: string
          description: Type of the card (for example G, B, or Y).
        dob:
          type: string
          description: Date of birth of the individual in `YYYY-MM-DD` format.
        individual_reference_number:
          type: string
          description: Reference number identifying the individual (1-9).
        name1:
          type: string
          description: Primary name field (usually full name or surname).
        name2:
          type: string
          description: Optional additional name field.
        name3:
          type: string
          description: Optional additional name field.
        name4:
          type: string
          description: Optional additional name field.
        trustFlowId:
          type: integer
          description: >-
            Identifier used to categorize or group requests for tracking or
            reporting.
        trustValidationId:
          type: string
          description: A unique ID used to identify your verification request.
    AuMedicareCardV3Response:
      type: object
      required:
        - success
        - message
        - data
        - verificationStatus
        - verificationStatusCode
        - trustFlowId
        - trustValidationId
        - verificationType
      properties:
        success:
          type: boolean
        message:
          type: string
        data:
          type: object
          properties:
            isValid:
              type: boolean
            errors:
              type: array
              items:
                type: object
                properties:
                  Field:
                    type: string
                  Message:
                    type: string
                  Source:
                    type: string
                additionalProperties: true
        verificationStatus:
          type: string
        verificationStatusCode:
          type: integer
        trustFlowId:
          type: integer
          description: Trust flow identifier.
        trustValidationId:
          type: string
        verificationType:
          type: string
        metadata:
          type: object
          nullable: true
          additionalProperties: true
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Use `Bearer {your_api_token}` in the Authorization header.

````