> ## 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-legacy/openapi.json POST /api/v1/verification/australia/medicare
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: Compliance
    description: Compliance verification endpoints
  - name: Government Data
    description: Government data verification endpoints
paths:
  /api/v1/verification/australia/medicare:
    post:
      tags:
        - Government Data
      summary: AU Medicare Card
      description: >-
        Verify Australian Medicare card details against health authority
        databases.
      operationId: auMedicareCardVerification
      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: 2026-03
                  card_number: '123'
                  card_type: <string>
                  dob: '2025-08-05'
                  individual_reference_number: '123'
                  name1: <string>
                  name2: <string>
                  name3: <string>
                  name4: <string>
                  template_id: '{your_trust_flow_id}'
                  verification_id: '{your_created_verification_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/AuRegistryVerificationResponse'
              example:
                status: true
                message: OK
                result:
                  ActivityId: 00000000-0000-0000-0000-000000000000
                  Errors: []
                  OriginatingAgencyCode: IDM001
                  VerificationRequestNumber: VI-01-01
                  VerificationResultCode: 1
components:
  schemas:
    AuMedicareCardRequest:
      type: object
      required:
        - card_expiry
        - card_number
        - card_type
        - individual_reference_number
        - name1
        - template_id
        - verification_id
      properties:
        card_expiry:
          type: string
          description: Expiry date of the card (Year-Month).
        card_number:
          type: integer
          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
          format: date
          description: Date of birth of the individual.
        individual_reference_number:
          type: integer
          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.
        template_id:
          type: integer
          description: Internal template identifier.
        verification_id:
          type: string
          description: Unique ID for the verification request.
    AuRegistryVerificationResponse:
      type: object
      properties:
        status:
          type: boolean
        message:
          type: string
        result:
          type: object
          properties:
            ActivityId:
              type: string
            Errors:
              type: array
              items:
                type: object
                additionalProperties: true
            OriginatingAgencyCode:
              type: string
            VerificationRequestNumber:
              type: string
            VerificationResultCode:
              type: integer
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Use `Bearer {your_api_token}` in the Authorization header.

````