curl --request POST \
--url https://dvs.idmetagroup.com/api/DVS/aec \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"BirthDate": {
"Day": 15,
"Month": 3,
"Year": 1990
},
"FamilyName": "Smith",
"State": "NSW",
"Postcode": "2000",
"Suburb": "Sydney"
}
'import requests
url = "https://dvs.idmetagroup.com/api/DVS/aec"
payload = {
"BirthDate": {
"Day": 15,
"Month": 3,
"Year": 1990
},
"FamilyName": "Smith",
"State": "NSW",
"Postcode": "2000",
"Suburb": "Sydney"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
BirthDate: {Day: 15, Month: 3, Year: 1990},
FamilyName: 'Smith',
State: 'NSW',
Postcode: '2000',
Suburb: 'Sydney'
})
};
fetch('https://dvs.idmetagroup.com/api/DVS/aec', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://dvs.idmetagroup.com/api/DVS/aec",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'BirthDate' => [
'Day' => 15,
'Month' => 3,
'Year' => 1990
],
'FamilyName' => 'Smith',
'State' => 'NSW',
'Postcode' => '2000',
'Suburb' => 'Sydney'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://dvs.idmetagroup.com/api/DVS/aec"
payload := strings.NewReader("{\n \"BirthDate\": {\n \"Day\": 15,\n \"Month\": 3,\n \"Year\": 1990\n },\n \"FamilyName\": \"Smith\",\n \"State\": \"NSW\",\n \"Postcode\": \"2000\",\n \"Suburb\": \"Sydney\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://dvs.idmetagroup.com/api/DVS/aec")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"BirthDate\": {\n \"Day\": 15,\n \"Month\": 3,\n \"Year\": 1990\n },\n \"FamilyName\": \"Smith\",\n \"State\": \"NSW\",\n \"Postcode\": \"2000\",\n \"Suburb\": \"Sydney\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://dvs.idmetagroup.com/api/DVS/aec")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"BirthDate\": {\n \"Day\": 15,\n \"Month\": 3,\n \"Year\": 1990\n },\n \"FamilyName\": \"Smith\",\n \"State\": \"NSW\",\n \"Postcode\": \"2000\",\n \"Suburb\": \"Sydney\"\n}"
response = http.request(request)
puts response.read_body{
"ActivityId": "5a1626e0-272f-4a64-b085-1068a877701d",
"OriginatingAgencyCode": "IDM001",
"VerificationRequestNumber": "VI-01-01",
"VerificationResultCode": 1
}AEC Electoral Roll
Verify an Australian AEC Electoral Roll by submitting the required AEC electoral roll details to the Australian Document Verification Service (DVS).
curl --request POST \
--url https://dvs.idmetagroup.com/api/DVS/aec \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"BirthDate": {
"Day": 15,
"Month": 3,
"Year": 1990
},
"FamilyName": "Smith",
"State": "NSW",
"Postcode": "2000",
"Suburb": "Sydney"
}
'import requests
url = "https://dvs.idmetagroup.com/api/DVS/aec"
payload = {
"BirthDate": {
"Day": 15,
"Month": 3,
"Year": 1990
},
"FamilyName": "Smith",
"State": "NSW",
"Postcode": "2000",
"Suburb": "Sydney"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
BirthDate: {Day: 15, Month: 3, Year: 1990},
FamilyName: 'Smith',
State: 'NSW',
Postcode: '2000',
Suburb: 'Sydney'
})
};
fetch('https://dvs.idmetagroup.com/api/DVS/aec', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://dvs.idmetagroup.com/api/DVS/aec",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'BirthDate' => [
'Day' => 15,
'Month' => 3,
'Year' => 1990
],
'FamilyName' => 'Smith',
'State' => 'NSW',
'Postcode' => '2000',
'Suburb' => 'Sydney'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://dvs.idmetagroup.com/api/DVS/aec"
payload := strings.NewReader("{\n \"BirthDate\": {\n \"Day\": 15,\n \"Month\": 3,\n \"Year\": 1990\n },\n \"FamilyName\": \"Smith\",\n \"State\": \"NSW\",\n \"Postcode\": \"2000\",\n \"Suburb\": \"Sydney\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://dvs.idmetagroup.com/api/DVS/aec")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"BirthDate\": {\n \"Day\": 15,\n \"Month\": 3,\n \"Year\": 1990\n },\n \"FamilyName\": \"Smith\",\n \"State\": \"NSW\",\n \"Postcode\": \"2000\",\n \"Suburb\": \"Sydney\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://dvs.idmetagroup.com/api/DVS/aec")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"BirthDate\": {\n \"Day\": 15,\n \"Month\": 3,\n \"Year\": 1990\n },\n \"FamilyName\": \"Smith\",\n \"State\": \"NSW\",\n \"Postcode\": \"2000\",\n \"Suburb\": \"Sydney\"\n}"
response = http.request(request)
puts response.read_body{
"ActivityId": "5a1626e0-272f-4a64-b085-1068a877701d",
"OriginatingAgencyCode": "IDM001",
"VerificationRequestNumber": "VI-01-01",
"VerificationResultCode": 1
}Authorizations
Use your API key in the x-api-key header.
Headers
"{your_api_key}"
Body
Show child attributes
Show child attributes
Family name on the electoral roll.
"Smith"
State of enrolment.
"NSW"
Postcode of the enrolled address.
"2000"
Suburb of the enrolled address.
"Sydney"
Given name(s) on the electoral roll.
"John"
Street name of the enrolled address.
"George"
Street type of the enrolled address.
"Street"
Street number of the enrolled address.
"100"
Unit number of the enrolled address, if any.
"5"
Habitation name of the enrolled address, if any.
""
Your unique identifier for this verification request. Defaults to a system-generated UUID if omitted.
"VI-01-01"
Response
Request processed. Check VerificationResultCode to determine whether the verification was valid (1) or invalid (2); Errors is present only when invalid.
Unique identifier assigned by DVS to this verification activity.
"5a1626e0-272f-4a64-b085-1068a877701d"
Code of the agency that originated the verification request.
"IDM001"
Echo of the request's VerificationRequestNumber.
"VI-01-01"
Result of the verification. 1 = Valid, 2 = Invalid.
1, 2 1
Present only when the verification is invalid.
Show child attributes
Show child attributes

