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

> Verify an Australian Marriage Certificate by submitting the required marriage certificate details to the Australian Document Verification Service (DVS).



## OpenAPI

````yaml api-reference/australia-dvs/au-dvs-marriage-certificate/au-dvs-marriage-certificate.openapi.json POST /api/DVS/certificate/marriage
openapi: 3.0.3
info:
  title: Australia DVS API - Marriage Certificate
  version: 1.0.0
servers:
  - url: https://dvs.idmetagroup.com
security:
  - apiKeyAuth: []
paths:
  /api/DVS/certificate/marriage:
    post:
      tags:
        - Australia DVS
      summary: Marriage Certificate
      description: >-
        Verify an Australian Marriage Certificate by submitting the required
        marriage certificate details to the Australian Document Verification
        Service (DVS).
      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
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
            example: '{your_api_key}'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - FamilyName
                - GivenName
                - DateOfEvent
                - RegistrationNumber
                - RegistrationState
                - RegistrationDate
                - CertificateNumber
              properties:
                FamilyName:
                  type: string
                  description: Family name of the first party.
                  example: Smith
                GivenName:
                  type: string
                  description: Given name(s) of the first party.
                  example: John
                FamilyName2:
                  type: string
                  description: Family name of the second party.
                  example: Jones
                GivenName2:
                  type: string
                  description: Given name(s) of the second party.
                  example: Jane
                DateOfEvent:
                  type: object
                  required:
                    - Day
                    - Month
                    - Year
                  properties:
                    Day:
                      type: integer
                      example: 15
                    Month:
                      type: integer
                      example: 3
                    Year:
                      type: integer
                      example: 1990
                RegistrationNumber:
                  type: string
                  description: Marriage registration number.
                  example: '123456'
                RegistrationState:
                  type: string
                  description: State that registered the marriage.
                  example: NSW
                RegistrationDate:
                  type: string
                  description: Date the marriage was registered.
                  example: '2018-08-25'
                RegistrationYear:
                  type: string
                  description: Year the marriage was registered.
                  example: '2018'
                DatePrinted:
                  type: string
                  description: Date the certificate was printed.
                  example: '2018-09-01'
                CertificateNumber:
                  type: string
                  description: Certificate number.
                  example: '987654321'
                VerificationRequestNumber:
                  type: string
                  description: >-
                    Your unique identifier for this verification request.
                    Defaults to a system-generated UUID if omitted.
                  example: VI-01-01
            example:
              FamilyName: Smith
              GivenName: John
              FamilyName2: Jones
              GivenName2: Jane
              DateOfEvent:
                Day: 15
                Month: 3
                Year: 1990
              RegistrationNumber: '123456'
              RegistrationState: NSW
              RegistrationDate: '2018-08-25'
              RegistrationYear: '2018'
              DatePrinted: '2018-09-01'
              CertificateNumber: '987654321'
              VerificationRequestNumber: VI-01-01
      responses:
        '200':
          description: >-
            Request processed. Check `VerificationResultCode` to determine
            whether the verification was valid (`1`) or invalid (`2`); `Errors`
            is present only when invalid.
          content:
            application/json:
              schema:
                type: object
                properties:
                  ActivityId:
                    type: string
                    description: >-
                      Unique identifier assigned by DVS to this verification
                      activity.
                    example: 5a1626e0-272f-4a64-b085-1068a877701d
                  OriginatingAgencyCode:
                    type: string
                    description: >-
                      Code of the agency that originated the verification
                      request.
                    example: IDM001
                  VerificationRequestNumber:
                    type: string
                    description: Echo of the request's VerificationRequestNumber.
                    example: VI-01-01
                  VerificationResultCode:
                    type: integer
                    description: Result of the verification. `1` = Valid, `2` = Invalid.
                    enum:
                      - 1
                      - 2
                    example: 1
                  Errors:
                    type: array
                    description: Present only when the verification is invalid.
                    items:
                      type: object
                      properties:
                        Field:
                          type: string
                          example: DateOfEvent
                        Message:
                          type: string
                          example: Date of event does not match.
                        Source:
                          type: string
                          example: Issuer
              examples:
                successful:
                  summary: Valid verification
                  value:
                    ActivityId: 5a1626e0-272f-4a64-b085-1068a877701d
                    OriginatingAgencyCode: IDM001
                    VerificationRequestNumber: VI-01-01
                    VerificationResultCode: 1
                invalid:
                  summary: Invalid verification (still HTTP 200)
                  value:
                    ActivityId: 5a1626e0-272f-4a64-b085-1068a877701d
                    Errors:
                      - Field: DateOfEvent
                        Message: Date of event does not match.
                        Source: Issuer
                    OriginatingAgencyCode: IDM001
                    VerificationRequestNumber: VI-01-01
                    VerificationResultCode: 2
components:
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: Use your API key in the `x-api-key` header.

````