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

# Birth Certificate

> Verify Australian birth certificates against registry data.



## OpenAPI

````yaml api-reference/openapi.json POST /api/v3/verifications/australia/birth-certificate
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: 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/birth-certificate:
    post:
      tags:
        - Government Data
      summary: AU Birth Certificate
      description: Verify Australian birth certificates against registry data.
      operationId: auBirthCertificateVerificationV3
      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/AuBirthCertificateRequest'
            examples:
              default:
                summary: AU birth certificate verification request
                value:
                  dob: ''
                  registration_state: NSW
                  trustFlowId: 0
                  trustValidationId: '{your_trust_validation_id}'
      responses:
        '200':
          description: AU birth certificate verification processed successfully
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuBirthCertificateV3Response'
              example:
                success: true
                message: Australia Birth Certificate processed successfully
                data:
                  isValid: true
                  result: Record Match
                  documentType: Birth Certificate
                  registrationState: NSW
                  registrationNumber: '1234567'
                  registrationDate: '2010-05-12'
                  certificateNumber: BC-998877
                  datePrinted: '2010-06-01'
                  registrationYear: '2010'
                  matchedFields:
                    familyName: true
                    givenName: true
                    birthDate: true
                verificationStatus: VERIFIED
                verificationStatusCode: 3
                trustFlowId: 0
                trustValidationId: '{your_trust_validation_id}'
                verificationType: australia_birth_certificate
                metadata: null
components:
  schemas:
    AuBirthCertificateRequest:
      type: object
      required:
        - dob
        - registration_state
        - trustFlowId
        - trustValidationId
      properties:
        certificate_number:
          type: string
          description: Unique number printed on the birth certificate.
        date_printed:
          type: string
          description: >-
            Date when the certificate was issued or printed in `YYYY-MM-DD`
            format.
        dob:
          type: string
          description: Date of birth of the individual in `YYYY-MM-DD` format.
        family_name:
          type: string
          description: Family name of the individual.
        given_name:
          type: string
          description: Given name of the individual.
        registration_date:
          type: string
          description: Date of registration in `YYYY-MM-DD` format.
        registration_number:
          type: string
          description: Official birth registration number.
        registration_state:
          type: string
          description: Australian state where the birth was registered.
          enum:
            - ACT
            - NSW
            - NT
            - QLD
            - SA
            - TAS
            - VIC
            - WA
        registration_year:
          type: integer
          description: Year of registration.
        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.
    AuBirthCertificateV3Response:
      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
            result:
              type: string
            documentType:
              type: string
            registrationState:
              type: string
            registrationNumber:
              type: string
            registrationDate:
              type: string
              format: date
            certificateNumber:
              type: string
            datePrinted:
              type: string
              format: date
            registrationYear:
              type: string
            matchedFields:
              type: object
              properties:
                familyName:
                  type: boolean
                givenName:
                  type: boolean
                birthDate:
                  type: boolean
              additionalProperties:
                type: boolean
        verificationStatus:
          type: string
        verificationStatusCode:
          type: integer
        trustFlowId:
          type: integer
        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.

````

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