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

# Citizenship

> Authenticate Australian citizenship certificates with official records.



## OpenAPI

````yaml api-reference-legacy/openapi.json POST /api/v1/verification/australia/certificate/citizenship
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/citizenship:
    post:
      tags:
        - Government Data
      summary: AU Citizenship
      description: Authenticate Australian citizenship certificates with official records.
      operationId: auCitizenshipCertificateVerification
      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/AuCitizenshipRequest'
            examples:
              default:
                summary: AU citizenship certificate verification request
                value:
                  acquisition_date: '1992-04-15'
                  dob: '1992-04-15'
                  family_name: <string>
                  given_name: <string>
                  stock_number: <string>
                  template_id: '{your_trust_flow_id}'
                  verification_id: '{your_created_verification_id}'
      responses:
        '200':
          description: AU citizenship 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: 1877b006-b278-49d1-8c0c-efee8b2b0b62
                  Errors: []
                  OriginatingAgencyCode: IDM001
                  VerificationRequestNumber: VI-01-01
                  VerificationResultCode: 1
components:
  schemas:
    AuCitizenshipRequest:
      type: object
      required:
        - acquisition_date
        - dob
        - family_name
        - stock_number
        - template_id
        - verification_id
      properties:
        acquisition_date:
          type: string
          format: date
          description: Date the Australian citizenship was acquired.
        dob:
          type: string
          format: date
          description: Date of birth of the individual.
        family_name:
          type: string
          description: Family name (surname) as stated on the certificate.
        given_name:
          type: string
          description: Given name as stated on the certificate for verification.
        stock_number:
          type: string
          description: Stock number found on the citizenship certificate for verification.
        template_id:
          type: integer
          description: >-
            Identifier used to categorize or group requests for tracking or
            reporting.
        verification_id:
          type: string
          description: A unique ID used to identify your 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.