> ## 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.

# Marriage Certificate

> Authenticate Australian marriage certificates via official sources.



## OpenAPI

````yaml api-reference-legacy/openapi.json POST /api/v1/verification/australia/certificate/marriage
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
        enum:
          - integrate
          - api.ph
        description: >-
          IDmeta environment subdomain. Use `api.ph` for
          portalph.idmetagroup.com and `integrate` for verify.idmetagroup.com.
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/certificate/marriage:
    post:
      tags:
        - Government Data
      summary: AU Marriage Certificate
      description: Authenticate Australian marriage certificates via official sources.
      operationId: auMarriageCertificateVerification
      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/AuMarriageCertificateRequest'
            examples:
              default:
                summary: AU marriage certificate verification request
                value:
                  bride_family_name: <string>
                  bride_given_name: <string>
                  groom_family_name: <string>
                  groom_given_name: <string>
                  certificate_number: <string>
                  date_printed: 05-06-2024
                  doe: 01-05-2024
                  registration_date: 10-05-2024
                  registration_number: <string>
                  registration_state: <string>
                  registration_year: <string>
                  template_id: '{your_trust_flow_id}'
                  verification_id: '{your_created_verification_id}'
      responses:
        '200':
          description: AU marriage certificate 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: 235a8b63-c298-4ec1-8c41-2c82459a7d93
                  Errors: []
                  OriginatingAgencyCode: IDM001
                  VerificationRequestNumber: VI-01-01
                  VerificationResultCode: 1
components:
  schemas:
    AuMarriageCertificateRequest:
      type: object
      required:
        - doe
        - registration_state
        - template_id
        - verification_id
      properties:
        bride_family_name:
          type: string
          description: Family name of the bride for verification.
        bride_given_name:
          type: string
          description: Given name of the bride.
        groom_family_name:
          type: string
          description: Family name of the groom.
        groom_given_name:
          type: string
          description: Given name of the groom.
        certificate_number:
          type: string
          description: Certificate number issued for the marriage for verification.
        date_printed:
          type: string
          description: Date the certificate was printed.
        doe:
          type: string
          description: Date of event (for example, marriage).
        registration_date:
          type: string
          description: Date the marriage was registered.
        registration_number:
          type: string
          description: Unique registration number.
        registration_state:
          type: string
          description: State where the marriage was registered (for example WA).
        registration_year:
          type: integer
          description: Year the marriage was registered.
        template_id:
          type: string
          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.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.