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

# AEC Electoral Roll

> Verify an Australian AEC Electoral Roll by submitting the required AEC electoral roll details to the Australian Document Verification Service (DVS).



## OpenAPI

````yaml api-reference-legacy/australia-dvs/au-dvs-aec-electoral/au-dvs-aec-electoral.openapi.json POST /api/DVS/aec
openapi: 3.0.3
info:
  title: Australia DVS API - AEC Electoral Roll
  version: 1.0.0
servers:
  - url: https://dvs.idmetagroup.com
security:
  - apiKeyAuth: []
paths:
  /api/DVS/aec:
    post:
      tags:
        - Australia DVS
      summary: AEC Electoral Roll
      description: >-
        Verify an Australian AEC Electoral Roll by submitting the required AEC
        electoral roll 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:
                - BirthDate
                - FamilyName
                - State
                - Postcode
                - Suburb
              properties:
                BirthDate:
                  type: object
                  required:
                    - Day
                    - Month
                    - Year
                  properties:
                    Day:
                      type: integer
                      example: 15
                    Month:
                      type: integer
                      example: 3
                    Year:
                      type: integer
                      example: 1990
                FamilyName:
                  type: string
                  description: Family name on the electoral roll.
                  example: Smith
                GivenName:
                  type: string
                  description: Given name(s) on the electoral roll.
                  example: John
                State:
                  type: string
                  description: State of enrolment.
                  example: NSW
                Postcode:
                  type: string
                  description: Postcode of the enrolled address.
                  example: '2000'
                Suburb:
                  type: string
                  description: Suburb of the enrolled address.
                  example: Sydney
                StreetName:
                  type: string
                  description: Street name of the enrolled address.
                  example: George
                StreetType:
                  type: string
                  description: Street type of the enrolled address.
                  example: Street
                StreetNumber:
                  type: string
                  description: Street number of the enrolled address.
                  example: '100'
                UnitNumber:
                  type: string
                  description: Unit number of the enrolled address, if any.
                  example: '5'
                HabitationName:
                  type: string
                  description: Habitation name of the enrolled address, if any.
                  example: ''
                VerificationRequestNumber:
                  type: string
                  description: >-
                    Your unique identifier for this verification request.
                    Defaults to a system-generated UUID if omitted.
                  example: VI-01-01
            example:
              BirthDate:
                Day: 15
                Month: 3
                Year: 1990
              FamilyName: Smith
              GivenName: John
              State: NSW
              Postcode: '2000'
              Suburb: Sydney
              StreetName: George
              StreetType: Street
              StreetNumber: '100'
              UnitNumber: '5'
              HabitationName: ''
              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: FamilyName
                        Message:
                          type: string
                          example: Family name 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: FamilyName
                        Message: Family name 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.

````

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