curl --request POST \
--url https://dvs.idmetagroup.com/api/DVS/certificate/marriage \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"FamilyName": "Smith",
"GivenName": "John",
"DateOfEvent": {
"Day": 15,
"Month": 3,
"Year": 1990
},
"RegistrationNumber": "123456",
"RegistrationState": "NSW",
"RegistrationDate": "2018-08-25",
"CertificateNumber": "987654321"
}
'import requests
url = "https://dvs.idmetagroup.com/api/DVS/certificate/marriage"
payload = {
"FamilyName": "Smith",
"GivenName": "John",
"DateOfEvent": {
"Day": 15,
"Month": 3,
"Year": 1990
},
"RegistrationNumber": "123456",
"RegistrationState": "NSW",
"RegistrationDate": "2018-08-25",
"CertificateNumber": "987654321"
}
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({
FamilyName: 'Smith',
GivenName: 'John',
DateOfEvent: {Day: 15, Month: 3, Year: 1990},
RegistrationNumber: '123456',
RegistrationState: 'NSW',
RegistrationDate: '2018-08-25',
CertificateNumber: '987654321'
})
};
fetch('https://dvs.idmetagroup.com/api/DVS/certificate/marriage', 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/certificate/marriage",
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([
'FamilyName' => 'Smith',
'GivenName' => 'John',
'DateOfEvent' => [
'Day' => 15,
'Month' => 3,
'Year' => 1990
],
'RegistrationNumber' => '123456',
'RegistrationState' => 'NSW',
'RegistrationDate' => '2018-08-25',
'CertificateNumber' => '987654321'
]),
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/certificate/marriage"
payload := strings.NewReader("{\n \"FamilyName\": \"Smith\",\n \"GivenName\": \"John\",\n \"DateOfEvent\": {\n \"Day\": 15,\n \"Month\": 3,\n \"Year\": 1990\n },\n \"RegistrationNumber\": \"123456\",\n \"RegistrationState\": \"NSW\",\n \"RegistrationDate\": \"2018-08-25\",\n \"CertificateNumber\": \"987654321\"\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/certificate/marriage")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"FamilyName\": \"Smith\",\n \"GivenName\": \"John\",\n \"DateOfEvent\": {\n \"Day\": 15,\n \"Month\": 3,\n \"Year\": 1990\n },\n \"RegistrationNumber\": \"123456\",\n \"RegistrationState\": \"NSW\",\n \"RegistrationDate\": \"2018-08-25\",\n \"CertificateNumber\": \"987654321\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://dvs.idmetagroup.com/api/DVS/certificate/marriage")
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 \"FamilyName\": \"Smith\",\n \"GivenName\": \"John\",\n \"DateOfEvent\": {\n \"Day\": 15,\n \"Month\": 3,\n \"Year\": 1990\n },\n \"RegistrationNumber\": \"123456\",\n \"RegistrationState\": \"NSW\",\n \"RegistrationDate\": \"2018-08-25\",\n \"CertificateNumber\": \"987654321\"\n}"
response = http.request(request)
puts response.read_bodyMarriage Certificate
Verify an Australian Marriage Certificate by submitting the required marriage certificate details to the Australian Document Verification Service (DVS).
curl --request POST \
--url https://dvs.idmetagroup.com/api/DVS/certificate/marriage \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"FamilyName": "Smith",
"GivenName": "John",
"DateOfEvent": {
"Day": 15,
"Month": 3,
"Year": 1990
},
"RegistrationNumber": "123456",
"RegistrationState": "NSW",
"RegistrationDate": "2018-08-25",
"CertificateNumber": "987654321"
}
'import requests
url = "https://dvs.idmetagroup.com/api/DVS/certificate/marriage"
payload = {
"FamilyName": "Smith",
"GivenName": "John",
"DateOfEvent": {
"Day": 15,
"Month": 3,
"Year": 1990
},
"RegistrationNumber": "123456",
"RegistrationState": "NSW",
"RegistrationDate": "2018-08-25",
"CertificateNumber": "987654321"
}
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({
FamilyName: 'Smith',
GivenName: 'John',
DateOfEvent: {Day: 15, Month: 3, Year: 1990},
RegistrationNumber: '123456',
RegistrationState: 'NSW',
RegistrationDate: '2018-08-25',
CertificateNumber: '987654321'
})
};
fetch('https://dvs.idmetagroup.com/api/DVS/certificate/marriage', 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/certificate/marriage",
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([
'FamilyName' => 'Smith',
'GivenName' => 'John',
'DateOfEvent' => [
'Day' => 15,
'Month' => 3,
'Year' => 1990
],
'RegistrationNumber' => '123456',
'RegistrationState' => 'NSW',
'RegistrationDate' => '2018-08-25',
'CertificateNumber' => '987654321'
]),
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/certificate/marriage"
payload := strings.NewReader("{\n \"FamilyName\": \"Smith\",\n \"GivenName\": \"John\",\n \"DateOfEvent\": {\n \"Day\": 15,\n \"Month\": 3,\n \"Year\": 1990\n },\n \"RegistrationNumber\": \"123456\",\n \"RegistrationState\": \"NSW\",\n \"RegistrationDate\": \"2018-08-25\",\n \"CertificateNumber\": \"987654321\"\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/certificate/marriage")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"FamilyName\": \"Smith\",\n \"GivenName\": \"John\",\n \"DateOfEvent\": {\n \"Day\": 15,\n \"Month\": 3,\n \"Year\": 1990\n },\n \"RegistrationNumber\": \"123456\",\n \"RegistrationState\": \"NSW\",\n \"RegistrationDate\": \"2018-08-25\",\n \"CertificateNumber\": \"987654321\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://dvs.idmetagroup.com/api/DVS/certificate/marriage")
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 \"FamilyName\": \"Smith\",\n \"GivenName\": \"John\",\n \"DateOfEvent\": {\n \"Day\": 15,\n \"Month\": 3,\n \"Year\": 1990\n },\n \"RegistrationNumber\": \"123456\",\n \"RegistrationState\": \"NSW\",\n \"RegistrationDate\": \"2018-08-25\",\n \"CertificateNumber\": \"987654321\"\n}"
response = http.request(request)
puts response.read_bodyAuthorizations
Use your API key in the x-api-key header.
Headers
"{your_api_key}"
Body
Family name of the first party.
"Smith"
Given name(s) of the first party.
"John"
Show child attributes
Show child attributes
Marriage registration number.
"123456"
State that registered the marriage.
"NSW"
Date the marriage was registered.
"2018-08-25"
Certificate number.
"987654321"
Family name of the second party.
"Jones"
Given name(s) of the second party.
"Jane"
Year the marriage was registered.
"2018"
Date the certificate was printed.
"2018-09-01"
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

