curl --request POST \
--url https://dvs.idmetagroup.com/api/DVS/immigration \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"FamilyName": "Smith",
"GivenName": "John",
"BirthDate": {
"Day": 15,
"Month": 3,
"Year": 1990
},
"ImmiCardNumber": "ABC1234567890"
}
'import requests
url = "https://dvs.idmetagroup.com/api/DVS/immigration"
payload = {
"FamilyName": "Smith",
"GivenName": "John",
"BirthDate": {
"Day": 15,
"Month": 3,
"Year": 1990
},
"ImmiCardNumber": "ABC1234567890"
}
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},
ImmiCardNumber: 'ABC1234567890'
})
};
fetch('https://dvs.idmetagroup.com/api/DVS/immigration', 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/immigration",
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
],
'ImmiCardNumber' => 'ABC1234567890'
]),
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/immigration"
payload := strings.NewReader("{\n \"FamilyName\": \"Smith\",\n \"GivenName\": \"John\",\n \"BirthDate\": {\n \"Day\": 15,\n \"Month\": 3,\n \"Year\": 1990\n },\n \"ImmiCardNumber\": \"ABC1234567890\"\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/immigration")
.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 \"ImmiCardNumber\": \"ABC1234567890\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://dvs.idmetagroup.com/api/DVS/immigration")
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 \"ImmiCardNumber\": \"ABC1234567890\"\n}"
response = http.request(request)
puts response.read_body{
"ActivityId": "5a1626e0-272f-4a64-b085-1068a877701d",
"OriginatingAgencyCode": "IDM001",
"VerificationRequestNumber": "VI-01-01",
"VerificationResultCode": 1
}Immigration Card (ImmiCard)
Verify an Australian Immigration Card (ImmiCard) by submitting the required immigration card details to the Australian Document Verification Service (DVS).
curl --request POST \
--url https://dvs.idmetagroup.com/api/DVS/immigration \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"FamilyName": "Smith",
"GivenName": "John",
"BirthDate": {
"Day": 15,
"Month": 3,
"Year": 1990
},
"ImmiCardNumber": "ABC1234567890"
}
'import requests
url = "https://dvs.idmetagroup.com/api/DVS/immigration"
payload = {
"FamilyName": "Smith",
"GivenName": "John",
"BirthDate": {
"Day": 15,
"Month": 3,
"Year": 1990
},
"ImmiCardNumber": "ABC1234567890"
}
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},
ImmiCardNumber: 'ABC1234567890'
})
};
fetch('https://dvs.idmetagroup.com/api/DVS/immigration', 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/immigration",
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
],
'ImmiCardNumber' => 'ABC1234567890'
]),
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/immigration"
payload := strings.NewReader("{\n \"FamilyName\": \"Smith\",\n \"GivenName\": \"John\",\n \"BirthDate\": {\n \"Day\": 15,\n \"Month\": 3,\n \"Year\": 1990\n },\n \"ImmiCardNumber\": \"ABC1234567890\"\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/immigration")
.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 \"ImmiCardNumber\": \"ABC1234567890\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://dvs.idmetagroup.com/api/DVS/immigration")
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 \"ImmiCardNumber\": \"ABC1234567890\"\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
Family name on the ImmiCard.
"Smith"
Given name(s) on the ImmiCard.
"John"
Show child attributes
Show child attributes
ImmiCard number.
"ABC1234567890"
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

