This guide provides clear instructions on how to integrate the Sanctum API into your application for authentication and user management. Follow the steps and examples below to get started quickly and effectively.
CSRF Cookie
Before making any POST requests, you need to retrieve a CSRF token. This token is necessary for authentication and should be included in the headers of subsequent requests.
RequestMethod: GET URL: /sanctum/csrf-cookieThis request will set the CSRF token in the cookies, which can be used in subsequent requests.
User Authentication
To authenticate a user, you need to make a POST request to the login endpoint. This request requires the CSRF token retrieved from the previous step.
Steps to Authenticate Fetch CSRF Token is to make the following request to retrieve the CSRF token.
RequestMethod: GET URL: /sanctum/csrf-cookieLogin Request
Use the CSRF token from the previous step in the headers of your POST request to the login endpoint.
RequestMethod: POST URL: /loginHeaders: Accept: application/json X-XSRF-TOKEN: [CSRF token]Body: email (text) - User email address. password (text) - User password.
Retrieve User Information
Once the user is authenticated, you can retrieve their information using a GET request to the user endpoint. Steps to Retrieve User Information Ensure User is Authenticated Make sure the user is authenticated by following the steps in the User Authentication section. Get User Information Make a GET request to /api/user to fetch the authenticated user details.
RequestMethod: GET URL: /api/userHeaders: Include the authentication headers if necessaryUser Logout
To log out the authenticated user, make a POST request to the logout endpoint. Steps to Logout Ensure User is Authenticated Make sure the user is authenticated by following the steps in the User Authentication section.
RequestMethod: POST URL: /logoutCSRF Cookie
Request:{
curl -X GET "https://b2b-dev.idmetagroup.com/sanctum/csrf-cookie"
}{
function getCSRFCookie() {
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://b2b-dev.idmetagroup.com/sanctum/csrf-cookie");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
return $response;
}
}User Authentication
Request:{
curl -X GET "https://b2b-dev.idmetagroup.com/sanctum/csrf-cookie"
}{
function userAuth() {
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://b2b-dev.idmetagroup.com/sanctum/csrf-cookie");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
return $response;
}
}Login Request
Request:{
curl Copy code curl -X POST "https://b2b-dev.idmetagroup.com/login"-H "Accept: application/json"-H "X-XSRF-TOKEN: [CSRF token]"-F "email=example@domain.com"-F"password=yourpassword"
}{
function loginRequest($email, $password, $csrfToken) {
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://b2b-dev.idmetagroup.com/login");
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
"Accept: application/json",
"X-XSRF-TOKEN: $csrfToken"
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, [
'email' => $email,
'password' => $password
]);
$response = curl_exec($ch);
curl_close($ch);
return $response;
}
}Retrieve User Information
Request:{
curl Copy code curl -X GET "https://b2b-dev.idmetagroup.com/api/user"
}{
function retrieveUserInformation() {
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://b2b-dev.idmetagroup.com/api/user");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
return $response;
}
}User Logout
Request:{
curl Copy code curl -X POST "https://b2b-dev.idmetagroup.com/logout"
}{
function logout() {
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://b2b-dev.idmetagroup.com/logout");
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
return $response;
}
}Pre-request Script for Postman
To handle CSRF tokens automatically in Postman, use the following pre-request script:
Request:{
const jar = pm.cookies.jar();
jar.get("https://dashboard2.idmetagroup.com", "XSRF-TOKEN", (err, cookie) => {
pm.request.addHeader({
key: "X-XSRF-TOKEN",
value: cookie
});
pm.request.addHeader({
key: "Referer",
value: "https://dashboard2.idmetagroup.com"
});
});
}{
function preRequestScript() {
$url = "https://dashboard2.idmetagroup.com";
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HEADER, true);
$response = curl_exec($ch);
$header_size = curl_getinfo($ch, CURLINFO_HEADER_SIZE);
$header = substr($response, 0, $header_size);
preg_match('/^Set-Cookie:s*([^;]*)/mi', $header, $matches);
$cookie = $matches[1];
curl_close($ch);
$headers = [
"X-XSRF-TOKEN: $cookie",
"Referer: https://dashboard2.idmetagroup.com"
];
return $headers;
}}Endpoint: POST /v1/verification/aml
Request:{
{
"countries": [
"ID",
"MY"
],
"datasets": [
"SAN"
],
"dob": "1999-12-31",
"name": "String"
}
}{
"countries": [
"ID",
"MY"
],
"datasets": [
"SAN"
],
"dob": "1999-12-31",
"name": "String"
}Responses:{
200 OK:
{
"status": true,
"message": "OK",
"result": {
"results": {
"matchCount": 0,
"matches": []
}
}
}
401 Unauthorized: Invalid or missing access token.
Example cURL:
bash curl -X 'POST' '{{baseUrl}}/v1/verification/aml' -H 'Accept: application/json' -H 'Content-Type: application/json' -H 'Authorization: {{accessToken}}' -d '{
"countries": [
"ID",
"MY"
],
"datasets": [
"SAN"
],
"dob": "1999-12-31",
"name": "String"
}'
}{
"200 OK": {
"status": true,
"message": "OK",
"result": {
"results": {
"matchCount": 0,
"matches": []
}
}
},
"401 Unauthorized": "Invalid or missing access token.",
"Example cURL": "bash curl -X 'POST' \
'{{baseUrl}}/v1/verification/aml' \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'Authorization: {{accessToken}}' \
-d '"countries": [
"ID",
"MY"
],
"datasets": [
"SAN"
],
"dob": "1999-12-31",
"name": "String"'"
}Endpoint: GET /v1/verification/aml/{{pdfResultId}}
Request:{
No request body required.
Headers:
makefile
Accept: application/pdf
Authorization: {{accessToken}}
}{
"No request body required.",
"Headers": {
"Accept": "application/pdf",
"Authorization": "{{accessToken}}"
}
}Responses:{
No response example is provided in the collection.
Example cURL:
bash
curl -X 'GET' '{{baseUrl}}/v1/verification/aml/{{pdfResultId}}' -H 'Accept: application/pdf' -H 'Authorization: {{accessToken}}'
}{
"No response example is provided in the collection.",
"Example cURL": "bash curl -X 'GET' \
'{{baseUrl}}/v1/verification/aml/{{pdfResultId}}' \
-H 'Accept: application/pdf' \
-H 'Authorization: {{accessToken}}'"
}Endpoint: POST /v1/verification/biometricsfacecompare
Request:{
Header:
{
"accept": "application/json",
"Authorization": "{{accessToken}}"
}
Body (form-data):
form
image1=@/path/to/your/image1.jpg;type=image/jpeg
image2=@/path/to/your/image2.png;type=image/png
}{
Header: {
"accept": "application/json",
"Authorization": "{{accessToken}}"
},
Body (form-data): {
image1=@/path/to/your/image1.jpg;type=image/jpeg
image2=@/path/to/your/image2.png;type=image/png
}
}Responses:{
200 OK: Face comparison successful.
401 Unauthorized: Invalid or missing access token.
Example cURL:
bash curl -X 'POST' '{{baseUrl}}/v1/verification/biometricsfacecompare' -H 'accept: application/json' -H 'Authorization: {{accessToken}}' -F 'image1=@/path/to/your/image1.jpg;type=image/jpeg' -F 'image2=@/path/to/your/image2.png;type=image/png'
}{
200 OK: Face comparison successful.
401 Unauthorized: Invalid or missing access token.
Example cURL:
bash curl -X 'POST' '{{baseUrl}}/v1/verification/biometricsfacecompare' -H 'accept: application/json' -H 'Authorization: {{accessToken}}' -F 'image1=@/path/to/your/image1.jpg;type=image/jpeg' -F 'image2=@/path/to/your/image2.png;type=image/png'
}Endpoint: POST /v1/verification/biometricsregistration
Request:{
Header:
json
{
"accept": "application/json",
"Authorization": "{{accessToken}}"
}
Body (form-data):
form
username=String
image=@/path/to/your/image.jpg;type=image/jpeg
}{
$jsonCode = [
"Header" => [
"accept" => "application/json",
"Authorization" => "{{accessToken}}"
],
"Body (form-data)" => [
"username" => "String",
"image" => "@/path/to/your/image.jpg;type=image/jpeg"
]
];
}Responses:{
200 OK: Registration successful.
401 Unauthorized: Invalid or missing access token.
Example cURL:
bash
curl -X 'POST' '{{baseUrl}}/v1/verification/biometricsregistration' -H 'accept: application/json' -H 'Authorization: {{accessToken}}' -F 'username=String' -F 'image=@/path/to/your/image.jpg;type=image/jpeg'
}{
200 OK: Registration successful.
401 Unauthorized: Invalid or missing access token.
Example cURL:
bash curl -X 'POST' '{{baseUrl}}/v1/verification/biometricsregistration' -H 'accept: application/json' -H 'Authorization: {{accessToken}}' -F 'username=String' -F 'image=@/path/to/your/image.jpg;type=image/jpeg'
}Endpoint: POST /v1/verification/biometricsverification
Request:{
$jsonCode = [
"Header" => [
"accept" => "application/json",
"Authorization" => "{{accessToken}}"
],
"Body (form-data)" => [
"image" => "@/path/to/your/image.jpg;type=image/jpeg"
]
];
}{
"Header" => [
"accept" => "application/json",
"Authorization" => "{{accessToken}}"
],
"Body (form-data)" => [
"image" => "@/path/to/your/image.jpg;type=image/jpeg"
]
}Responses:{
$response = [
"200 OK" => "Verification successful.",
"401 Unauthorized" => "Invalid or missing access token.",
"Example cURL" => "
bash curl -X 'POST' \
'{{baseUrl}}/v1/verification/biometricsverification' \
-H 'accept: application/json' \
-H 'Authorization: {{accessToken}}' \
-F 'image=@/path/to/your/image.jpg;type=image/jpeg'
"
];
// Convert arrays to JSON strings if needed
$jsonCodeJson = json_encode($jsonCode);
$responseJson = json_encode($response);
}{
$response = [
"200 OK" => "Verification successful.",
"401 Unauthorized" => "Invalid or missing access token.",
"Example cURL" => "
bash curl -X 'POST' \
'{{baseUrl}}/v1/verification/biometricsverification' \
-H 'accept: application/json' \
-H 'Authorization: {{accessToken}}' \
-F 'image=@/path/to/your/image.jpg;type=image/jpeg'
"
];
// Convert arrays to JSON strings if needed
$jsonCodeJson = json_encode($jsonCode);
$responseJson = json_encode($response);
}Endpoint: POST /v1/verification/emailrisk
Request:{
{
"recipient": "user@app.com"
}
}{
"recipient": "user@app.com"
}Responses:{
200 OK: Verification successful.
401 Unauthorized: Invalid or missing access token.
Example cURL:
bash
curl -X 'POST' '{{baseUrl}}/v1/verification/emailrisk' -H 'Accept: application/json' -H 'Content-Type: application/json' -H 'Authorization: {{accessToken}}' -d '{
"recipient": "user@app.com"
}'
}{
$response = '{
"200 OK": "Verification successful.",
"401 Unauthorized": "Invalid or missing access token."
}';
// Sample curl request using PHP
$baseUrl = "https://example.com"; // Replace with actual base URL
$endpoint = "/v1/verification/emailrisk";
$url = $baseUrl . $endpoint;
$headers = [
"Accept: application/json",
"Content-Type: application/json",
"Authorization: Bearer YOUR_ACCESS_TOKEN" // Replace with actual access token
];
$ch = curl_init($url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, $jsonCode);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
?>
}Endpoint: POST /v1/verification/phonerisk
Request:{
{
"recipient": "632468709864"
}
}{
"recipient": "632468709864"
}Responses:{200 OK: Verification successful.
401 Unauthorized: Invalid or missing access token.
Example cURL:
bash
curl -X 'POST' '{{baseUrl}}/v1/verification/phonerisk' -H 'Accept: application/json' -H 'Content-Type: application/json' -H 'Authorization: {{accessToken}}' -d '{
"recipient": "632468709864"
}'
}{
$response = '{
"200 OK": "Verification successful.",
"401 Unauthorized": "Invalid or missing access token."
}';
// Sample curl request using PHP
$baseUrl = "https://example.com"; // Replace with actual base URL
$endpoint = "/v1/verification/phonerisk";
$url = $baseUrl . $endpoint;
$headers = [
"Accept: application/json",
"Content-Type: application/json",
"Authorization: Bearer YOUR_ACCESS_TOKEN" // Replace with actual access token
];
$ch = curl_init($url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, $jsonCode);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
?>
}This document provides a guide on how to use the API endpoints available for various verification services in Australia, such as visa, passport, citizenship, and more. The general setup and request structure are explained below, followed by specific endpoint instructions.
Common Setup:
All API requests should be made to the following base URL:b2b-dev.idmetagroup.com/api/v1/ verification/document_verification Authentication
All requests require an Authorization header with a valid access token:{{ accessToken }}{{ accessToken }}Endpoint
POST b2b-dev.idmetagroup.com/api/v1/verification/document_verification-*returnFullDocumentImage* (boolean): Indicates whether to return the full document image.
-*returnFaceImage* (boolean): Indicates whether to return the face image from the document.
-*returnSignatureImage* (boolean): Indicates whether to return the signature image from the document.
-*allowBlurFilter* (boolean): Allows the use of a blur filter during image processing. Indicates
-*allowUnparsedMrzResults* (boolean): Allows returning results even if MRZ (Machine Readable Zone) parsing fails.
-*allowUnverifiedMrzResults* (boolean): Allows returning MRZ results without verification.
-*validateResultCharacters* (boolean): Validates characters in the parsed results.
-*anonymizationMode* (string): Specifies the mode for anonymization. Set to"FULL_RESULT"for full result anonymization.
-*anonymizeImage* (boolean):Indicates whether to anonymize the image. Specifies the mode for anonymization.
-*ageLimit* (integer):Sets the age limit for document verification.
-*imageSource* (string):The source of the image being processed.
-*scanCroppedDocumentImage* (string):Indicates whether to scan the cropped document image.
Request: {
"returnFullDocumentImage": false,
"returnFaceImage": false,
"returnSignatureImage": false,
"allowBlurFilter": false,
"allowUnparsedMrzResults": false,
"allowUnverifiedMrzResults": true,
"validateResultCharacters": true,
"anonymizationMode": "FULL_RESULT",
"anonymizeImage": true,
"ageLimit": 0,
"imageSource": "string",
"scanCroppedDocumentImage": false
}{
$requestPayload = [
"returnFullDocumentImage" => false,
"returnFaceImage" => false,
"returnSignatureImage" => false,
"allowBlurFilter" => false,
"allowUnparsedMrzResults" => false,
"allowUnverifiedMrzResults" => true,
"validateResultCharacters" => true,
"anonymizationMode" => "FULL_RESULT",
"anonymizeImage" => true,
"ageLimit" => 0,
"imageSource" => "string",
"scanCroppedDocumentImage" => false
];
}Responses:{
- *200 OK*: The request was successful, and the response contains the document verification results.
- *400 Bad Request*: The request was invalid.
- *403 Forbidden*: Access to the resource is forbidden.
- *500 Internal Server Error*: The server encountered an error processing the request.
- *503 Service Unavailable*: The service is temporarily unavailable.
- *504 Gateway Time-out*: The gateway timed out while processing the request.
Using curl:
sh
curl -X POST b2b-dev.idmetagroup.com/api/v1/verification/document_verification -H 'Content-Type: application/json'-H
'Accept: application/json' -d
{
"returnFullDocumentImage": false,
"returnFaceImage": false,
"returnSignatureImage": false,
"allowBlurFilter": false,
"allowUnparsedMrzResults": false,
"allowUnverifiedMrzResults": true,
"validateResultCharacters": true,
"anonymizationMode": "FULL_RESULT",
"anonymizeImage": true,
"ageLimit": 0,
"imageSource": "string",
"scanCroppedDocumentImage": false
}
//Sample Response
{
"executionId": "string",
"finishTime": "string",
"startTime": "string",
"result": {
"dateOfBirth": {
"day": 0,
"month": 0,
"year": 0,
"successfullyParsed": true,
"originalString": "string"
},
"classInfo": {
"country": "COUNTRY_NONE",
"region": "REGION_NONE",
"type": "TYPE_NONE",
"countryName": "string",
"isoAlpha3CountryCode": "string",
"isoAlpha2CountryCode": "string",
"isoNumericCountryCode": "string"
},
"type": "string",
"isBelowAgeLimit": true,
"age": 0,
"recognitionStatus": "EMPTY",
"firstName": "string",
"lastName": "string",
"fullName": "string",
"address": "string",
"dateOfIssue": {
"day": 0,
"month": 0,
"year": 0,
"successfullyParsed": true,
"originalString": "string"
},
"dateOfExpiry": {
"day": 0,
"month": 0,
"year": 0,
"successfullyParsed": true,
"originalString": "string"
},
"documentNumber": "string",
"sex": "string",
"driverLicenseDetailedInfo": {
"restrictions": "string",
"endorsements": "string",
"vehicleClass": "string",
"conditions": "string",
"vehicleClassesInfo": [
{
"vehicleClass": "string",
"licenceType": "string",
"effectiveDate": {
"day": 0,
"month": 0,
"year": 0,
"successfullyParsed": true,
"originalString": "string"
},
"expiryDate": {
"day": 0,
"month": 0,
"year": 0,
"successfullyParsed": true,
"originalString": "string"
}
}
]
},
"fullDocumentImageBase64": "string",
"faceImageBase64": "string",
"additionalNameInformation": "string",
"additionalAddressInformation": "string",
"additionalOptionalAddressInformation": "string",
"placeOfBirth": "string",
"nationality": "string",
"race": "string",
"religion": "string",
"profession": "string",
"maritalStatus": "string",
"residentialStatus": "string",
"employer": "string",
"personalIdNumber": "string",
"documentAdditionalNumber": "string",
"documentOptionalAdditionalNumber": "string",
"issuingAuthority": "string",
"mrzData": {
"rawMrzString": "string",
"documentCode": "string",
"issuer": "string",
"documentNumber": "string",
"opt1": "string",
"opt2": "string",
"gender": "string",
"nationality": "string",
"primaryId": "string",
"secondaryId": "string",
"alienNumber": "string",
"applicationReceiptNumber": "string",
"immigrantCaseNumber": "string",
"mrzVerified": true,
"mrzParsed": true,
"dateOfBirth": {
"day": 0,
"month": 0,
"year": 0,
"successfullyParsed": true,
"originalString": "string"
},
"dateOfExpiry": {
"day": 0,
"month": 0,
"year": 0,
"successfullyParsed": true,
"originalString": "string"
},
"documentType": "UNKNOWN",
"issuerName": "string",
"nationalityName": "string"
},
"conditions": "string",
"localizedName": "string",
"dateOfExpiryPermanent": true,
"additionalPersonalIdNumber": "string",
"viz": {
"firstName": "string",
"lastName": "string",
"fullName": "string",
"additionalNameInformation": "string",
"localizedName": "string",
"address": "string",
"additionalAddressInformation": "string",
"additionalOptionalAddressInformation": "string",
"placeOfBirth": "string",
"nationality": "string",
"race": "string",
"religion": "string",
"profession": "string",
"maritalStatus": "string",
"residentialStatus": "string",
"employer": "string",
"sex": "string",
"dateOfBirth": {
"day": 0,
"month": 0,
"year": 0,
"successfullyParsed": true,
"originalString": "string"
},
"dateOfIssue": {
"day": 0,
"month": 0,
"year": 0,
"successfullyParsed": true,
"originalString": "string"
},
"dateOfExpiry": {
"day": 0,
"month": 0,
"year": 0,
"successfullyParsed": true,
"originalString": "string"
},
"dateOfExpiryPermanent": true,
"documentNumber": "string",
"personalIdNumber": "string",
"documentAdditionalNumber": "string",
"additionalPersonalIdNumber": "string",
"documentOptionalAdditionalNumber": "string",
"issuingAuthority": "string",
"driverLicenseDetailedInfo": {
"restrictions": "string",
"endorsements": "string",
"vehicleClass": "string",
"conditions": "string",
"vehicleClassesInfo": [
{
"vehicleClass": "string",
"licenceType": "string",
"effectiveDate": {
"day": 0,
"month": 0,
"year": 0,
"successfullyParsed": true,
"originalString": "string"
},
"expiryDate": {
"day": 0,
"month": 0,
"year": 0,
"successfullyParsed": true,
"originalString": "string"
}
}
]
},
"conditions": "string",
"fathersName": "string",
"mothersName": "string"
},
"barcode": {
"rawDataBase64": "string",
"stringData": "string",
"firstName": "string",
"lastName": "string",
"middleName": "string",
"fullName": "string",
"additionalNameInformation": "string",
"address": "string",
"placeOfBirth": "string",
"nationality": "string",
"race": "string",
"religion": "string",
"profession": "string",
"maritalStatus": "string",
"residentialStatus": "string",
"employer": "string",
"sex": "string",
"dateOfBirth": {
"day": 0,
"month": 0,
"year": 0,
"successfullyParsed": true,
"originalString": "string"
},
"dateOfIssue": {
"day": 0,
"month": 0,
"year": 0,
"successfullyParsed": true,
"originalString": "string"
},
"dateOfExpiry": {
"day": 0,
"month": 0,
"year": 0,
"successfullyParsed": true,
"originalString": "string"
},
"documentNumber": "string",
"personalIdNumber": "string",
"documentAdditionalNumber": "string",
"issuingAuthority": "string",
"addressDetailedInfo": {
"street": "string",
"postalCode": "string",
"city": "string",
"jurisdiction": "string"
},
"driverLicenseDetailedInfo": {
"restrictions": "string",
"endorsements": "string",
"vehicleClass": "string",
"conditions": "string",
"vehicleClassesInfo": [
{
"vehicleClass": "string",
"licenceType": "string",
"effectiveDate": {
"day": 0,
"month": 0,
"year": 0,
"successfullyParsed": true,
"originalString": "string"
},
"expiryDate": {
"day": 0,
"month": 0,
"year": 0,
"successfullyParsed": true,
"originalString": "string"
}
}
]
},
"extendedElements": [
{
"key": "BARCODE_ELEMENT_KEY_DOCUMENT_TYPE",
"value": "string"
}
]
},
"imageAnalysisResult": {
"blurred": true,
"documentImageColorStatus": "NOT_AVAILABLE",
"documentImageMoireStatus": "NOT_AVAILABLE",
"faceDetectionStatus": "NOT_AVAILABLE",
"mrzDetectionStatus": "NOT_AVAILABLE",
"barcodeDetectionStatus": "NOT_AVAILABLE"
},
"processingStatus": "SUCCESS",
"recognitionMode": "NONE",
"signatureImageBase64": "string",
"fathersName": "string",
"mothersName": "string"
}
}
}{
$response = '{
- *200 OK*: The request was successful, and the response contains the document verification results.
- *400 Bad Request*: The request was invalid.
- *403 Forbidden*: Access to the resource is forbidden.
- *500 Internal Server Error*: The server encountered an error processing the request.
- *503 Service Unavailable*: The service is temporarily unavailable.
- *504 Gateway Time-out*: The gateway timed out while processing the request.
}';
$curl = curl_init();
$data = array(
"returnFullDocumentImage" => false,
"returnFaceImage" => false,
"returnSignatureImage" => false,
"allowBlurFilter" => false,
"allowUnparsedMrzResults" => false,
"allowUnverifiedMrzResults" => true,
"validateResultCharacters" => true,
"anonymizationMode" => "FULL_RESULT",
"anonymizeImage" => true,
"ageLimit" => 0,
"imageSource" => "string",
"scanCroppedDocumentImage" => false
);
$jsonData = json_encode($data);
curl_setopt_array($curl, array(
CURLOPT_URL => "https://b2b-dev.idmetagroup.com/api/v1/verification/document_verification",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => $jsonData,
CURLOPT_HTTPHEADER => array(
"Content-Type: application/json",
"Accept: application/json"
),
));
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
}Endpoint: POST /v1/verification/australia/passport
Request:{
Header:
{
"accept": "application/json",
"Content-Type": "application/json",
"Authorization": "{{accessToken}}"
}
Body (raw JSON):
{
"dob": "01-09-1988",
"family_name": "DVSTest",
"given_name": "Arnold",
"gender": "M",
"travel_document_number": "N1000091"
}
}{
$headers = [
"accept: application/json",
"Content-Type: application/json",
"Authorization: Bearer YOUR_ACCESS_TOKEN" // Replace with actual access token
];
}Responses:{
200 OK: Verification successful.
401 Unauthorized: Invalid or missing access token.
Example cURL:
bash curl -X 'POST' '{{baseUrl}}/v1/verification/australia/passport' -H 'accept: application/json' -H 'Content-Type: application/json' -H 'Authorization: {{accessToken}}' -d '{
"dob": "01-09-1988",
"family_name": "DVSTest",
"given_name": "Arnold",
"gender": "M",
"travel_document_number": "N1000091"
}'
}{
$body = json_encode([
"dob" => "01-09-1988",
"family_name" => "DVSTest",
"given_name" => "Arnold",
"gender" => "M",
"travel_document_number" => "N1000091"
]);
// Define the base URL and endpoint
$baseUrl = "https://example.com"; // Replace with actual base URL
$endpoint = "/v1/verification/australia/passport";
$url = $baseUrl . $endpoint;
// Initialize curl
$ch = curl_init($url);
// Set curl options
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, $body);
// Execute curl request and get the response
$response = curl_exec($ch);
// Check for errors
if (curl_errno($ch)) {
$error_msg = curl_error($ch);
}
// Close curl
curl_close($ch);
// Output the response or error
if (isset($error_msg)) {
echo "Curl error: " . $error_msg;
} else {
echo $response;
}
?>
}Endpoint: POST /v1/verification/australia/ driver_license
Request:{
Header:
{
"accept": "application/json",
"Content-Type": "application/json",
"Authorization": "{{accessToken}}"
}
Body (raw JSON):
{
"state_of_issue": "QLD",
"licence_number": "65493621",
"card_number": "A123456789",
"dob": "1965-11-19",
"family_name": "string",
"middle_name": "string",
"given_name": "string"
}
}{
$url = '{{baseUrl}}/v1/verification/australia/driver_license';
$accessToken = 'your_access_token';
$data = [
'state_of_issue' => 'QLD',
'licence_number' => '65493621',
'card_number' => 'A123456789',
'dob' => '1965-11-19',
'family_name' => 'string',
'middle_name' => 'string',
'given_name' => 'string'
];
$headers = [
'Authorization: ' . $accessToken,
'Content-Type: application/json',
'Accept: application/json'
];
}Responses:{
200 OK: Verification successful.
401 Unauthorized: Invalid or missing access token.
Example cURL:
bash
curl -X 'POST' '{{baseUrl}}/v1/verification/australia/driver_license' -H 'accept: application/json' -H 'Content-Type: application/json' -H 'Authorization: {{accessToken}}' -d '{
"state_of_issue": "QLD",
"licence_number": "65493621",
"card_number": "A123456789",
"dob": "1965-11-19",
"family_name": "string",
"middle_name": "string",
"given_name": "string"
}'
}{
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data));
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
}Endpoint: POST /v1/verification/australia/medicare
Request:{
Header:
{
"accept": "application/json",
"Content-Type": "application/json",
"Authorization": "{{accessToken}}"
}
Body (raw JSON):
{
"individual_reference_number": 1,
"card_expiry": "2024-01",
"card_number": "2953172521",
"card_type": "G",
"name1": "Roderick Samuel",
"name2": "James",
"name3": "Roderick Samuel",
"name4": "James",
"dob": "2012-03-12"
}
}{
$url = '{{baseUrl}}/v1/verification/australia/medicare';
$accessToken = 'your_access_token';
$data = [
'individual_reference_number' => 1,
'card_expiry' => '2024-01',
'card_number' => '2953172521',
'card_type' => 'G',
'name1' => 'Roderick Samuel',
'name2' => 'James',
'name3' => 'Roderick Samuel',
'name4' => 'James',
'dob' => '2012-03-12'
];
$headers = [
'Authorization: ' . $accessToken,
'Content-Type: application/json',
'Accept: application/json'
];
}Responses:{
200 OK: Verification successful.
401 Unauthorized: Invalid or missing access token.
Example cURL:
bash
curl -X 'POST' '{{baseUrl}}/v1/verification/australia/medicare' -H 'accept: application/json' -H 'Content-Type: application/json' -H 'Authorization: {{accessToken}}' -d '{
"individual_reference_number": 1,
"card_expiry": "2024-01",
"card_number": "2953172521",
"card_type": "G",
"name1": "Roderick Samuel",
"name2": "James",
"name3": "Roderick Samuel",
"name4": "James",
"dob": "2012-03-12"
}'
}{
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data));
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
}Endpoint: POST /v1/verification/australia/ certificate/citizenship
Request:
{
"Header": {
"accept": "application/json",
"Authorization": "{{accessToken}}"
},
"Body": {
"form-data": {
"image1": "@/path/to/your/image1.jpg;type=image/jpeg",
"image2": "@/path/to/your/image2.png;type=image/png"
}
}
}{
$headers = [
"accept: application/json",
"Authorization: Bearer YOUR_ACCESS_TOKEN" // Replace with actual access token
];
}Responses:{
{
"200 OK": "Verification successful.",
"401 Unauthorized": "Invalid or missing access token."
}
Example cURL:
bash
curl -X 'POST' '{{baseUrl}}/v1/verification/australia/certificate/citizenship' -H 'accept: application/json' -H 'Content-Type: application/json' -H 'Authorization: {{accessToken}}' -d '{
"dob": "01-02-1987",
"acquisition_date": "2013-06-27",
"family_name": "Walker",
"given_name": "Sarah",
"stock_number": "75213019409"
}{
$formData = [
"image1" => new CURLFile('/path/to/your/image1.jpg', 'image/jpeg'),
"image2" => new CURLFile('/path/to/your/image2.png', 'image/png')
];
// Define the base URL and endpoint
$baseUrl = "https://example.com"; // Replace with actual base URL
$endpoint = "/v1/verification/australia/certificate/citizenship";
$url = $baseUrl . $endpoint;
// Initialize curl
$ch = curl_init($url);
// Set curl options
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, $formData);
// Execute curl request and get the response
$response = curl_exec($ch);
// Check for errors
if (curl_errno($ch)) {
$error_msg = curl_error($ch);
}
// Close curl
curl_close($ch);
// Output the response or error
if (isset($error_msg)) {
echo "Curl error: " . $error_msg;
} else {
echo $response;
}
?>
}Endpoint: POST /v1/verification/australia/ centrelink_card
Request:{
Header:
{
"accept": "application/json",
"Content-Type": "application/json",
"Authorization": "{{accessToken}}"
}
Body (raw JSON):
{
"name": "JANET B LARNER",
"dob": "1947-02-07",
"card_type": "PCC",
"card_expiry": "2023-10-03",
"customer_reference_number": "123123123e"
}
}{
$url = '{{baseUrl}}/v1/verification/australia/centrelink_card';
$accessToken = 'your_access_token';
$data = [
'name' => 'JANET B LARNER',
'dob' => '1947-02-07',
'card_type' => 'PCC',
'card_expiry' => '2023-10-03',
'customer_reference_number' => '123123123e'
];
$headers = [
'Authorization: ' . $accessToken,
'Content-Type: application/json',
'Accept: application/json'
];
}Responses:{
200 OK: Verification successful.
401 Unauthorized: Invalid or missing access token.
Example cURL:
bash
curl -X 'POST' '{{baseUrl}}/v1/verification/australia/centrelink_card' -H 'accept: application/json' -H 'Content-Type: application/json' -H 'Authorization: {{accessToken}}' -d '{
"name": "JANET B LARNER",
"dob": "1947-02-07",
"card_type": "PCC",
"card_expiry": "2023-10-03",
"customer_reference_number": "123123123e"
}'
}{
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data));
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
}Endpoint: POST /v1/verification/australia/immigration
Request:{
Header:
{
"accept": "application/json",
"Content-Type": "application/json",
"Authorization": "{{accessToken}}"
}
Body (raw JSON):
{
"dob": "1989-12-08",
"family_name": "JONES",
"given_name": "Matthew John",
"immigration_card_number": "PRE123456"
}
}{
$headers = [
"accept: application/json",
"Content-Type: application/json",
"Authorization: Bearer YOUR_ACCESS_TOKEN" // Replace with actual access token
];
}Responses:{
200 OK: Verification successful.
401 Unauthorized: Invalid or missing access token.
Example cURL:
bash
curl -X 'POST' '{{baseUrl}}/v1/verification/australia/immigration' -H 'accept: application/json' -H 'Content-Type: application/json' -H 'Authorization: {{accessToken}}' -d '{
"dob": "1989-12-08",
"family_name": "JONES",
"given_name": "Matthew John",
"immigration_card_number": "PRE123456"
}'
}{
$body = json_encode([
"dob" => "1989-12-08",
"family_name" => "JONES",
"given_name" => "Matthew John",
"immigration_card_number" => "PRE123456"
]);
// Define the base URL and endpoint
$baseUrl = "https://example.com"; // Replace with actual base URL
$endpoint = "/v1/verification/australia/immigration";
$url = $baseUrl . $endpoint;
// Initialize curl
$ch = curl_init($url);
// Set curl options
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, $body);
// Execute curl request and get the response
$response = curl_exec($ch);
// Check for errors
if (curl_errno($ch)) {
$error_msg = curl_error($ch);
}
// Close curl
curl_close($ch);
// Output the response or error
if (isset($error_msg)) {
echo "Curl error: " . $error_msg;
} else {
echo $response;
}
?>
}Endpoint: POST /v1/verification/australia/ certificate/birth
Request:{
Header:
{
"accept": "application/json",
"Content-Type": "application/json",
"Authorization": "{{accessToken}}"
}
Body (raw JSON):
{
"dob": "1974-03-01",
"family_name": "RegNumber",
"given_name": "MaximumLength",
"registration_state": "ACT",
"registration_number": "55421210",
"registration_date": "2034-03-23",
"certificate_number": "55421210",
"registration_year": "2012",
"date_printed": "2034-03-23"
}
}{
$headers = [
"accept: application/json",
"Content-Type: application/json",
"Authorization: Bearer YOUR_ACCESS_TOKEN" // Replace with actual access token
];
}Responses:{
200 OK: Verification successful.
401 Unauthorized: Invalid or missing access token.
Example cURL:
bash
curl -X 'POST' '{{baseUrl}}/v1/verification/australia/certificate/birth' -H 'accept: application/json' -H 'Content-Type: application/json' -H 'Authorization: {{accessToken}}' -d '{
"dob": "1974-03-01",
"family_name": "RegNumber",
"given_name": "MaximumLength",
"registration_state": "ACT",
"registration_number": "55421210",
"registration_date": "2034-03-23",
"certificate_number": "55421210",
"registration_year": "2012",
"date_printed": "2034-03-23"
}'
}{
$body = json_encode([
"dob" => "1974-03-01",
"family_name" => "RegNumber",
"given_name" => "MaximumLength",
"registration_state" => "ACT",
"registration_number" => "55421210",
"registration_date" => "2034-03-23",
"certificate_number" => "55421210",
"registration_year" => "2012",
"date_printed" => "2034-03-23"
]);
// Define the base URL and endpoint
$baseUrl = "https://example.com"; // Replace with actual base URL
$endpoint = "/v1/verification/australia/certificate/birth";
$url = $baseUrl . $endpoint;
// Initialize curl
$ch = curl_init($url);
// Set curl options
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, $body);
// Execute curl request and get the response
$response = curl_exec($ch);
// Check for errors
if (curl_errno($ch)) {
$error_msg = curl_error($ch);
}
// Close curl
curl_close($ch);
// Output the response or error
if (isset($error_msg)) {
echo "Curl error: " . $error_msg;
} else {
echo $response;
}
?>
}Endpoint: POST /v1/verification/australia/ certificate/death
Request:{
Header:
{
"accept": "application/json",
"Content-Type": "application/json",
"Authorization": "{{accessToken}}"
}
Body (raw JSON):
{
"doe": "2018-01-14",
"family_name": "Chamberlain",
"given_name": "Robert Wayne",
"registration_state": "VIC",
"registration_number": "22283",
"registration_date": "1990-02-12",
"certificate_number": "20042363633"
}
}{
$headers = [
"accept: application/json",
"Content-Type: application/json",
"Authorization: Bearer YOUR_ACCESS_TOKEN" // Replace with actual access token
];
}Responses:{
200 OK: Verification successful.
401 Unauthorized: Invalid or missing access token.
Example cURL:
bash
curl -X 'POST' '{{baseUrl}}/v1/verification/australia/certificate/death' -H 'accept: application/json' -H 'Content-Type: application/json' -H 'Authorization: {{accessToken}}' -d '{
"doe": "2018-01-14",
"family_name": "Chamberlain",
"given_name": "Robert Wayne",
"registration_state": "VIC",
"registration_number": "22283",
"registration_date": "1990-02-12",
"certificate_number": "20042363633"
}'
}{
$body = json_encode([
"doe" => "2018-01-14",
"family_name" => "Chamberlain",
"given_name" => "Robert Wayne",
"registration_state" => "VIC",
"registration_number" => "22283",
"registration_date" => "1990-02-12",
"certificate_number" => "20042363633"
]);
// Define the base URL and endpoint
$baseUrl = "https://example.com"; // Replace with actual base URL
$endpoint = "/v1/verification/australia/certificate/death";
$url = $baseUrl . $endpoint;
// Initialize curl
$ch = curl_init($url);
// Set curl options
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, $body);
// Execute curl request and get the response
$response = curl_exec($ch);
// Check for errors
if (curl_errno($ch)) {
$error_msg = curl_error($ch);
}
// Close curl
curl_close($ch);
// Output the response or error
if (isset($error_msg)) {
echo "Curl error: " . $error_msg;
} else {
echo $response;
}
?>
}Endpoint: POST /v1/verification/australia/certificate/ marriage
Request:{
Header:
{
"accept": "application/json",
"Content-Type": "application/json",
"Authorization": "{{accessToken}}"
}
Body (raw JSON):
{
"doe": "12-03-1990",
"bride_family_name": "famit",
"bride_given_name": "Pillow",
"groom_family_name": "werwe",
"groom_given_name": "werws",
"registration_state": "QLD",
"registration_number": "55421210",
"registration_date": "1990-02-12",
"certificate_number": "23324",
"registration_year": "2012",
"date_printed": "2034-03-23"
}
}{
$url = '{{baseUrl}}/v1/verification/australia/certificate/marriage';
$accessToken = 'your_access_token';
$data = [
'doe' => '12-03-1990',
'bride_family_name' => 'famit',
'bride_given_name' => 'Pillow',
'groom_family_name' => 'werwe',
'groom_given_name' => 'werws',
'registration_state' => 'QLD',
'registration_number' => '55421210',
'registration_date' => '1990-02-12',
'certificate_number' => '23324',
'registration_year' => '2012',
'date_printed' => '2034-03-23'
];
}Responses:{
200 OK: Verification successful.
401 Unauthorized: Invalid or missing access token.
Example cURL:
bash
curl -X 'POST' '{{baseUrl}}/v1/verification/australia/certificate/marriage' -H 'accept: application/json' -H 'Content-Type: application/json' -H 'Authorization: {{accessToken}}' -d '{
"doe": "12-03-1990",
"bride_family_name": "famit",
"bride_given_name": "Pillow",
"groom_family_name": "werwe",
"groom_given_name": "werws",
"registration_state": "QLD",
"registration_number": "55421210",
"registration_date": "1990-02-12",
"certificate_number": "23324",
"registration_year": "2012",
"date_printed": "2034-03-23"
}'
}{
$headers = [
'Authorization: ' . $accessToken,
'Content-Type: application/json',
'Accept: application/json'
];
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data));
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
}Endpoint: POST /v1/verification/australia/certificate /changeOfName
Request:{
Header:
{
"accept": "application/json",
"Content-Type": "application/json",
"Authorization": "{{accessToken}}"
}
Body (raw JSON):
{
"dob": "12-03-1990",
"new_family_name": "famit",
"new_given_name": "Pillow",
"registration_state": "QLD",
"registration_number": "55421210",
"registration_date": "1990-02-12",
"certificate_number": "23324",
"registration_year": "2012",
"date_printed": "2034-03-23"
}
}{
$headers = [
"accept: application/json",
"Content-Type: application/json",
"Authorization: Bearer YOUR_ACCESS_TOKEN" // Replace with actual access token
];
// Define the JSON body
$body = json_encode([
"dob" => "12-03-1990",
"new_family_name" => "famit",
"new_given_name" => "Pillow",
"registration_state" => "QLD",
"registration_number" => "55421210",
"registration_date" => "1990-02-12",
"certificate_number" => "23324",
"registration_year" => "2012",
"date_printed" => "2034-03-23"
]);
}Responses:{
200 OK: Verification successful.
401 Unauthorized: Invalid or missing access token.
Example cURL:
bash
curl -X 'POST' '{{baseUrl}}/v1/verification/australia/certificate/changeOfName' -H 'accept: application/json' -H 'Content-Type: application/json' -H 'Authorization: {{accessToken}}' -d '{
"dob": "12-03-1990",
"new_family_name": "famit",
"new_given_name": "Pillow",
"registration_state": "QLD",
"registration_number": "55421210",
"registration_date": "1990-02-12",
"certificate_number": "23324",
"registration_year": "2012",
"date_printed": "2034-03-23"
}'
}{
$baseUrl = "https://example.com"; // Replace with actual base URL
$endpoint = "/v1/verification/australia/certificate/changeOfName";
$url = $baseUrl . $endpoint;
// Initialize curl
$ch = curl_init($url);
// Set curl options
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, $body);
// Execute curl request and get the response
$response = curl_exec($ch);
// Check for errors
if (curl_errno($ch)) {
$error_msg = curl_error($ch);
}
// Close curl
curl_close($ch);
// Output the response or error
if (isset($error_msg)) {
echo "Curl error: " . $error_msg;
} else {
echo $response;
}
?>
}Endpoint: POST /v1/verification/australia/asic_msic
Request:{
Header:
{
"accept": "application/json",
"Content-Type": "application/json",
"Authorization": "{{accessToken}}"
}
Body (raw JSON):
{
"dob": "12-12-2000",
"full_name": "Fname LASTCARDID",
"card_number": "OSC0174582",
"card_type": "MSIC",
"card_expiry": "2023-11"
}
}{
$url = '{{baseUrl}}/v1/verification/australia/asic_msic';
$accessToken = 'your_access_token';
$data = [
'dob' => '12-12-2000',
'full_name' => 'Fname LASTCARDID',
'card_number' => 'OSC0174582',
'card_type' => 'MSIC',
'card_expiry' => '2023-11'
];
$headers = [
'Authorization: ' . $accessToken,
'Content-Type: application/json',
'Accept: application/json'
];
}Responses:{
200 OK: Verification successful.
401 Unauthorized: Invalid or missing access token.
Example cURL:
bash
curl -X 'POST' '{{baseUrl}}/v1/verification/australia/asic_msic' -H 'accept: application/json' -H 'Content-Type: application/json' -H 'Authorization: {{accessToken}}' -d '{
"dob": "12-12-2000",
"full_name": "Fname LASTCARDID",
"card_number": "OSC0174582",
"card_type": "MSIC",
"card_expiry": "2023-11"
}'
}{
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data));
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
}Endpoint: POST /v1/verification/australia/aec
This document covers the main verification endpoints available for Australian services. Ensure that the access token is valid and the request headers and body follow the specified formats for successful API interactions.
Request:{
Header:
{
"accept": "application/json",
"Content-Type": "application/json",
"Authorization": "{{accessToken}}"
}
Body (raw JSON):
{
"dob": "1990-02-12",
"state": 1,
"postcode": 1233,
"suburb": "string",
"family_name": "string",
"given_name": "string",
"street_name": "TWEED COAST",
"street_type": "RD",
"street_number": 1,
"unit_number": 202,
"habitation_number": "NORTH STAR HOLIDAY RESORT"
}
}{
$data = [
'dob' => '1990-02-12',
'state' => 1,
'postcode' => 1233,
'suburb' => 'string',
'family_name' => 'string',
'given_name' => 'string',
'street_name' => 'TWEED COAST',
'street_type' => 'RD',
'street_number' => 1,
'unit_number' => 202,
'habitation_number' => 'NORTH STAR HOLIDAY RESORT'
];
$headers = [
'Authorization: ' . $accessToken,
'Content-Type: application/json',
'Accept: application/json'
];
}Responses:{
200 OK: Verification successful.
401 Unauthorized: Invalid or missing access token.
Example cURL:
bash
curl -X 'POST' '{{baseUrl}}/v1/verification/australia/aec' -H 'accept: application/json' -H 'Content-Type: application/json' -H 'Authorization: {{accessToken}}' -d '{
"dob": "1990-02-12",
"state": 1,
"postcode": 1233,
"suburb": "string",
"family_name": "string",
"given_name": "string",
"street_name": "TWEED COAST",
"street_type": "RD",
"street_number": 1,
"unit_number": 202,
"habitation_number": "NORTH STAR HOLIDAY RESORT"
}'
Example cURL for Direct API Call
Endpoint: POST https://b2b.idmetagroup.com/api/v1/verification/australia/visa
Request:
Header:
{
"accept": "application/json",
"Content-Type": "application/json"
}
Body (raw JSON):
{
"dob": "08-12-1989",
"family_name": "JONES",
"given_name": "Matthew John",
"passport_number": "DVS123456",
"country_of_issue": "string"
}
Example cURL:
bash
curl -X 'POST' 'https://b2b.idmetagroup.com/api/v1/verification/australia/visa' -H 'accept: application/json' -H 'Content-Type: application/json' -d '{
"dob": "08-12-1989",
"family_name": "JONES",
"given_name": "Matthew John",
"passport_number": "DVS123456",
"country_of_issue": "string"
}'
}{
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data));
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
}Endpoint: POST /v1/verification/philippines/dukcapil
Request:{
"date_of_birth": "1961-07-06",
"name": "Ana Sutrisna",
"nik": "0950060607610439"
}{
$url = '{{baseUrl}}/v1/verification/dukcapil';
$accessToken = 'your_access_token';
$data = [
'date_of_birth' => '1961-07-06',
'name' => 'Ana Sutrisna',
'nik' => '0950060607610439'
];
$headers = [
'Authorization: ' . $accessToken,
'Content-Type: application/json',
'Accept: application/json'
];
}Responses:{
No response example is provided in the collection.
Example cURL:
bash
curl -X 'POST' '{{baseUrl}}/v1/verification/dukcapil' -H 'accept: application/json' -H 'Content-Type: application/json' -H 'Authorization: {{accessToken}}' -d '{
"date_of_birth": "1961-07-06",
"name": "Ana Sutrisna",
"nik": "0950060607610439"
}'
}{
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data));
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
}Endpoint: POST /v1/verification/philippines/ dukcapilfacematch
Request:{
This request uses form-data to send the following parameters:
date_of_birth: 1999-12-31
name: String
nik: 317
selfie_image: A file with content type image/jpeg.
Example Form-data:
vbnet
date_of_birth: 1999-12-31
name: String
nik: 317
selfie_image: (file upload)
}{
$url = '{{baseUrl}}/v1/verification/dukcapilfacematch';
$accessToken = 'your_access_token';
$filePath = '/path/to/your/file.jpg';
$data = [
'date_of_birth' => '1999-12-31',
'name' => 'String',
'nik' => '317',
'selfie_image' => new CURLFile($filePath, 'image/jpeg', 'selfie_image')
];
$headers = [
'Authorization: ' . $accessToken,
'Accept: application/json'
];
}Responses:{
No response example is provided in the collection.
Example cURL:
bash
curl -X 'POST' '{{baseUrl}}/v1/verification/dukcapilfacematch' -H 'accept: application/json' -H 'Authorization: {{accessToken}}' -F 'date_of_birth=1999-12-31' -F 'name=String' -F 'nik=317' -F 'selfie_image=@/path/to/your/file.jpg;type=image/jpeg'
}{
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, $data);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
}This API allows for the verification of QR codes issued by the PSA (Philippine Statistics Authority). Below are the details of the available endpoints.
Endpoint: POST /v1/verification/philippines/ drivinglicense
Request: {
"licenseNumber": "N01-23-456789",
"expirationDate": "1999-12-31",
"serialNumber": "123456789"
}{
$url = '{{baseUrl}}/v1/verification/philippines/drivinglicense';
$accessToken = 'your_access_token';
$data = [
'licenseNumber' => 'N01-23-456789',
'expirationDate' => '1999-12-31',
'serialNumber' => '123456789'
];
$headers = [
'Authorization: ' . $accessToken,
'Content-Type: application/json',
'Accept: application/json'
];
}Responses:{
200 OK: Verification successful.
401 Unauthorized: Invalid or missing access token.
Example cURL:
bash
curl -X 'POST' '{{baseUrl}}/v1/verification/philippines/drivinglicense' -H 'accept: application/json' -H 'Content-Type: application/json' -H 'Authorization: {{accessToken}}' -d {
"licenseNumber": "N01-23-456789",
"expirationDate": "1999-12-31",
"serialNumber": "123456789"
}
}{
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data));
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
}Endpoint: POST /v1/verification/philippines/umidssn
Request: {
"documentNumber": "0111-2345678-9"
}Responses:{
200 OK: Verification successful.
401 Unauthorized: Invalid or missing access token.
Example cURL:
bash
curl -X 'POST' '{{baseUrl}}/v1/verification/philippines/umidssn' -H 'accept: application/json' -H 'Content-Type: application/json' -H 'Authorization: {{accessToken}}' -d '{
"documentNumber": "0111-2345678-9"
}'
}Endpoint:
POST /v1/verification/philippines/prc
Request:{
"documentNumber": "0123456",
"profession": "CRIMINOLOGIST",
"dateOfBirth": "1999-12-31"
}{
$url = '{{baseUrl}}/v1/verification/philippines/prc';
$accessToken = 'your_access_token';
$data = [
'documentNumber' => '0123456',
'profession' => 'CRIMINOLOGIST',
'dateOfBirth' => '1999-12-31'
];
$headers = [
'Authorization: ' . $accessToken,
'Content-Type: application/json',
'Accept: application/json'
];
}Responses:{
200 OK: Verification successful.
401 Unauthorized: Invalid or missing access token.
Example cURL:
bash
curl -X 'POST' '{{baseUrl}}/v1/verification/philippines/prc' -H 'accept: application/json' -H 'Content-Type: application/json' -H 'Authorization: {{accessToken}}' -d '{
"documentNumber": "0123456",
"profession": "CRIMINOLOGIST",
"dateOfBirth": "1999-12-31"
}'
}{
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data));
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
}Endpoint: POST /v1/verification/philippines/ nationalpolice
Request:{
"documentNumber": "23456789",
"profession": "user"
}{
$url = '{{baseUrl}}/v1/verification/philippines/nationalpolice';
$accessToken = 'your_access_token';
$data = [
'documentNumber' => '23456789',
'profession' => 'user'
];
$headers = [
'Authorization: ' . $accessToken,
'Content-Type: application/json',
'Accept: application/json'
];
}Responses:{
200 OK: Verification successful.
401 Unauthorized: Invalid or missing access token.
Example cURL:
bash
curl -X 'POST' '{{baseUrl}}/v1/verification/philippines/nationalpolice' -H 'accept: application/json' -H 'Content-Type: application/json' -H 'Authorization: {{accessToken}}' -d '{
"documentNumber": "23456789",
"profession": "user"
}'
}{
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data));
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
}Endpoint: POST /v1/verification/philippines/nbiclearance
Request:{
"documentNumber": "U000ABCD12-EF3456789",
"firstName": "user",
"lastName": "user",
"dateOfBirth": "1999-12-31"
}{
$url = '{{baseUrl}}/v1/verification/philippines/nbiclearance';
$accessToken = 'your_access_token';
$data = [
'documentNumber' => 'U000ABCD12-EF3456789',
'firstName' => 'user',
'lastName' => 'user',
'dateOfBirth' => '1999-12-31'
];
$headers = [
'Authorization: ' . $accessToken,
'Content-Type: application/json',
'Accept: application/json'
];
}Responses:{
200 OK: Verification successful.
401 Unauthorized: Invalid or missing access token.
Example cURL:
bash
curl -X 'POST' '{{baseUrl}}/v1/verification/philippines/nbiclearance' -H 'accept: application/json' -H 'Content-Type: application/json' -H 'Authorization: {{accessToken}}' -d '{
"documentNumber": "U000ABCD12-EF3456789",
"firstName": "user",
"lastName": "user",
"dateOfBirth": "1999-12-31"
}'
}{
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data));
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
}