Skip to main content
POST
AEC Electoral Roll

Authorizations

Authorization
string
header
required

Use your API token as a Bearer token in the Authorization header.

Headers

Authorization
string
required
Example:

"Bearer {your_api_token}"

Accept
string
default:application/json
Content-Type
string
default:application/json

Body

application/json
dob
string
required

Date of birth in DD-MM-YYYY format.

Example:

"15-03-1990"

familyName
string
required

Family name on the electoral roll.

state
string
required

State of enrolment.

Example:

"NSW"

postcode
string
required

Postcode of the enrolled address.

Example:

"2000"

suburb
string
required

Suburb of the enrolled address.

Example:

"Sydney"

givenName
string

Given name(s) on the electoral roll.

streetName
string

Street name of the enrolled address.

streetType
string

Street type of the enrolled address.

streetNumber
string

Street number of the enrolled address.

unitNumber
string

Unit number of the enrolled address, if any.

habitationName
string

Habitation name of the enrolled address, if any.

metadata
object

Optional key-value pairs echoed back in the response.

Response

Request processed. Check data.isValid and verificationStatus to determine the outcome.

success
boolean
required
message
string
required
data
object
required
verificationStatus
enum<string>
required
Available options:
VERIFIED,
REJECTED
verificationStatusCode
integer
required

3 = Verified, 1 = Rejected.

transactionId
string<uuid>
required
verificationType
string
required
Example:

"australia_aec"

createdAt
string
required
metadata
object | null