Change of Name Certificate
curl --request POST \
--url https://dvs.idmetagroup.com/api/DVS/certificate/changeOfName \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"FamilyName": "Smith",
"GivenName": "John",
"BirthDate": {
"Day": 15,
"Month": 3,
"Year": 1990
},
"RegistrationNumber": "123456",
"RegistrationState": "NSW",
"RegistrationDate": "2015-01-10",
"CertificateNumber": "987654321"
}
'import requests
url = "https://dvs.idmetagroup.com/api/DVS/certificate/changeOfName"
payload = {
"FamilyName": "Smith",
"GivenName": "John",
"BirthDate": {
"Day": 15,
"Month": 3,
"Year": 1990
},
"RegistrationNumber": "123456",
"RegistrationState": "NSW",
"RegistrationDate": "2015-01-10",
"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',
BirthDate: {Day: 15, Month: 3, Year: 1990},
RegistrationNumber: '123456',
RegistrationState: 'NSW',
RegistrationDate: '2015-01-10',
CertificateNumber: '987654321'
})
};
fetch('https://dvs.idmetagroup.com/api/DVS/certificate/changeOfName', 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/changeOfName",
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',
'BirthDate' => [
'Day' => 15,
'Month' => 3,
'Year' => 1990
],
'RegistrationNumber' => '123456',
'RegistrationState' => 'NSW',
'RegistrationDate' => '2015-01-10',
'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/changeOfName"
payload := strings.NewReader("{\n \"FamilyName\": \"Smith\",\n \"GivenName\": \"John\",\n \"BirthDate\": {\n \"Day\": 15,\n \"Month\": 3,\n \"Year\": 1990\n },\n \"RegistrationNumber\": \"123456\",\n \"RegistrationState\": \"NSW\",\n \"RegistrationDate\": \"2015-01-10\",\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/changeOfName")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"FamilyName\": \"Smith\",\n \"GivenName\": \"John\",\n \"BirthDate\": {\n \"Day\": 15,\n \"Month\": 3,\n \"Year\": 1990\n },\n \"RegistrationNumber\": \"123456\",\n \"RegistrationState\": \"NSW\",\n \"RegistrationDate\": \"2015-01-10\",\n \"CertificateNumber\": \"987654321\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://dvs.idmetagroup.com/api/DVS/certificate/changeOfName")
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 \"BirthDate\": {\n \"Day\": 15,\n \"Month\": 3,\n \"Year\": 1990\n },\n \"RegistrationNumber\": \"123456\",\n \"RegistrationState\": \"NSW\",\n \"RegistrationDate\": \"2015-01-10\",\n \"CertificateNumber\": \"987654321\"\n}"
response = http.request(request)
puts response.read_body{
"ActivityId": "5a1626e0-272f-4a64-b085-1068a877701d",
"OriginatingAgencyCode": "IDM001",
"VerificationRequestNumber": "VI-01-01",
"VerificationResultCode": 1
}Australia DVS
Change of Name Certificate
Verify an Australian Change of Name Certificate by submitting the required change of name certificate details to the Australian Document Verification Service (DVS).
POST
/
api
/
DVS
/
certificate
/
changeOfName
Change of Name Certificate
curl --request POST \
--url https://dvs.idmetagroup.com/api/DVS/certificate/changeOfName \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"FamilyName": "Smith",
"GivenName": "John",
"BirthDate": {
"Day": 15,
"Month": 3,
"Year": 1990
},
"RegistrationNumber": "123456",
"RegistrationState": "NSW",
"RegistrationDate": "2015-01-10",
"CertificateNumber": "987654321"
}
'import requests
url = "https://dvs.idmetagroup.com/api/DVS/certificate/changeOfName"
payload = {
"FamilyName": "Smith",
"GivenName": "John",
"BirthDate": {
"Day": 15,
"Month": 3,
"Year": 1990
},
"RegistrationNumber": "123456",
"RegistrationState": "NSW",
"RegistrationDate": "2015-01-10",
"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',
BirthDate: {Day: 15, Month: 3, Year: 1990},
RegistrationNumber: '123456',
RegistrationState: 'NSW',
RegistrationDate: '2015-01-10',
CertificateNumber: '987654321'
})
};
fetch('https://dvs.idmetagroup.com/api/DVS/certificate/changeOfName', 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/changeOfName",
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',
'BirthDate' => [
'Day' => 15,
'Month' => 3,
'Year' => 1990
],
'RegistrationNumber' => '123456',
'RegistrationState' => 'NSW',
'RegistrationDate' => '2015-01-10',
'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/changeOfName"
payload := strings.NewReader("{\n \"FamilyName\": \"Smith\",\n \"GivenName\": \"John\",\n \"BirthDate\": {\n \"Day\": 15,\n \"Month\": 3,\n \"Year\": 1990\n },\n \"RegistrationNumber\": \"123456\",\n \"RegistrationState\": \"NSW\",\n \"RegistrationDate\": \"2015-01-10\",\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/changeOfName")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"FamilyName\": \"Smith\",\n \"GivenName\": \"John\",\n \"BirthDate\": {\n \"Day\": 15,\n \"Month\": 3,\n \"Year\": 1990\n },\n \"RegistrationNumber\": \"123456\",\n \"RegistrationState\": \"NSW\",\n \"RegistrationDate\": \"2015-01-10\",\n \"CertificateNumber\": \"987654321\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://dvs.idmetagroup.com/api/DVS/certificate/changeOfName")
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 \"BirthDate\": {\n \"Day\": 15,\n \"Month\": 3,\n \"Year\": 1990\n },\n \"RegistrationNumber\": \"123456\",\n \"RegistrationState\": \"NSW\",\n \"RegistrationDate\": \"2015-01-10\",\n \"CertificateNumber\": \"987654321\"\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
Example:
"{your_api_key}"
Body
application/json
Family name before the change.
Example:
"Smith"
Given name(s) before the change.
Example:
"John"
Show child attributes
Show child attributes
Change of name registration number.
Example:
"123456"
State that registered the change of name.
Example:
"NSW"
Date the change of name was registered.
Example:
"2015-01-10"
Certificate number.
Example:
"987654321"
Family name after the change.
Example:
"Jones"
Given name(s) after the change.
Example:
"Jane"
Year the change of name was registered.
Example:
"2015"
Date the certificate was printed.
Example:
"2015-01-15"
Your unique identifier for this verification request. Defaults to a system-generated UUID if omitted.
Example:
"VI-01-01"
Response
200 - application/json
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.
Example:
"5a1626e0-272f-4a64-b085-1068a877701d"
Code of the agency that originated the verification request.
Example:
"IDM001"
Echo of the request's VerificationRequestNumber.
Example:
"VI-01-01"
Result of the verification. 1 = Valid, 2 = Invalid.
Available options:
1, 2 Example:
1
Present only when the verification is invalid.
Show child attributes
Show child attributes