Trulioo

Trulioo Developer Portal

Welcome to the Trulioo's developer hub. You'll find comprehensive guides and documentation to help you start working with Trulioo as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started
Suggest Edits

Introduction

 

Trulioo provides a collection of API methods to help you build business processes powered by the GlobalGateway Normalized API. The Normalized API is a loosely coupled API; fields may be added to our services and responses as the API evolves, and a client must be able to safely ignore fields and data that are not expected. The GlobalGateway Normalized API can help automate your business processes by performing the following tasks:

Identity Verification

Electronic identity verification (eIDV) was created specifically to help your business comply with Anti-Money Laundering (AML) and Know Your Customer (KYC) rules and has since evolved to support a diverse range of international electronic identity verification requirements.

Document Verification

ID Document Verification analyzes, verifies, and authenticates 3,500 different types of identity documents from nearly every country in the world. The combination of eIDV and ID Document Verification during the Customer Due Diligence check can assist your business in meeting your AML, KYC and Counter Terrorist Financing (CTF) compliance requirements.

Business Verification

Business Verification analyzes, verifies and provides data intelligence for business entities in 83 countries. During Customer Due Diligence, Business Verification assists clients to automate compliance workflows, reduce manual front-to- back office operations, take advantage of digital processes, decrease the risk of fraud, and allow staff to focus on key compliance considerations.

AML Watchlist

Global AML Watchlist helps your business comply with domestic and international AML, CTF and sanctions enforcement regulations. The watchlist covers sanction lists, law enforcements lists and governing regulatory bodies from around the world.

Suggest Edits

Technical Overview

 

The GlobalGateway Normalized API is a stateless web service based on RESTful architecture. The production endpoint is supported solely on HTTPS. All requests to the production endpoint need to be SSL/TLS compliant. The base URL for the API is https://api.globaldatacompany.com

Request and response body data are required to be in the standard JSON format. The output JSON should not be treated as fixed or as a schema. New fields may be added as the API evolves. Clients must not rely on the order in which data appears in JSON service responses and should be resilient to the reordering of fields within a JSON object. In the request, the Content-Type header value must be set to "application/json; charset=utf-8".

The API uses built-in HTTP features, such as HTTP authentication, errors and verbs which are understood by standard HTTP clients.

For faster response times, include an Accept-Encoding header with a value of "gzip, deflate" and responses will be gzipped.

Suggest Edits

Getting Started

 

Before you get started, make sure you have the following:

  1. A GlobalGateway account: This is your organization's account with Trulioo, containing your top-level organization configuration such as available datasources, verification rules, and more. To set up a GlobalGateway account, contact us using the form available here.
  2. A NAPI user account: This is your individual user account to access Trulioo's normalized API (NAPI). You will need a username and password for authenticating your API calls. If you have a GlobalGateway account set up already, but no NAPI user account, email support@trulioo.com with the following information:
    • Your first and last name
    • Your organization's GlobalGateway account name

We require approval from the primary or technical contact from your organization to create a NAPI user on your behalf.

Suggest Edits

API Libraries

 

Trulioo is working to offer API libraries in popular web and mobile languages to accelerate the integration process.

C#

To install the C# API Library, run the following command in the Package Manager Console.

Install-Package Trulioo.V1.Client.NET

Check out the source code on GitHub.

Java

The Java API Library is available on Maven Central.

Maven
To install using Maven, add the following dependency to your POM:

<dependency>
    <groupId>com.trulioo</groupId>
    <artifactId>normalizedapi</artifactId>
    <version>[1.0.0,)</version>
</dependency>

Gradle
To install using Gradle, declare the following under dependencies in your build.gradle script:

compile "com.trulioo:normalizedapi:1.+"

Check out the source code on GitHub.

 

The API methods are organized in 4 main sections:

All Products methods are used for set up, configuration and reviewing transactions. These methods are for all of Trulioo's products.

Identity Verification methods enable you to perform eIDV - eIDV - Electronic identity verification - created specifically to help your business comply with Anti-Money Laundering (AML) and Know Your Customer (KYC) rules and has since evolved to support a diverse range of international electronic identity verification requirements. transactions and retrieve verification results.

Document Verification methods enable you to perform Document - Document - ID Document Verification analyzes, verifies, and authenticates 3,500 different types of identity documents from nearly every country in the world. The combination of eIDV and ID Document Verification during the Customer Due Diligence check can assist your business in meeting your AML, KYC and Counter Terrorist Financing (CTF) compliance requirements. transactions and retrieve verification results.

Business Verification methods enable you to perform KYB - KYB - Know Your Business - Business Verification analyzes, verifies and provides data intelligence for business entities in 83 countries. During Customer Due Diligence, Business Verification assists clients to automate compliance workflows, reduce manual front-to- back office operations, take advantage of digital processes, decrease the risk of fraud, and allow staff to focus on key compliance considerations. transactions and retrieve verification results.

Suggest Edits

Authentication

 

The Trulioo API uses Basic Authentication for access control. Basic Authentication uses standard fields in the HTTPS request header to avoid the need for handshakes. This Authorization header is constructed by the following process:

  • Username and password are combined into a string username:password
  • The resulting string is encoded using the RFC2045-MIME variant of Base64, except without the 76 char per line limitation. This encoded string will be referred to simply as ACCESS_TOKEN in examples.
  • The authorization method and a space, in this case "Basic ", is then put before the encoded string, so the resulting header is "Authorization: Basic ACCESS_TOKEN"

Many tools and technologies, such as SOAPUI, Postman, HTTP client libraries in most programming languages, or our own SDKs, will do the encoding work for you, requiring you to simply provide the username and password.

See the Test Authentication documentation for full examples.

See Errors for a full description of each of the errors listed below.

Http Errors

The API uses HTTP response codes to indicate the status of a request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate that a failure occurred due to the content or structure of the request (e.g., a required parameter was omitted, the authentication header is missing, etc.), and codes in the 5xx range indicate a server error on Trulioo's part. 5xx errors are rare, and should be handled by emailing Trulioo support. Here are some troubleshooting tips for the more common 4xx errors:

400 BadRequest

Details should be included in the body of the response. Some example causes of a 400 BadRequest are:

Message
Troubleshooting

Account not configured for this product

Ensure you are configured properly with the Get Country Codes request to see the countries you are configured for.

Configuration name not valid

For now, you should always send "Identity Verification" for the configuration name parameter.

Unable to find account

Email Trulioo support to ensure there are no issues with your account.

Transaction not available

Make sure that you are sending the correct TransactionRecordID and that the verify was sent from this same request.

Account not configured for this country.

Try the Get Country Codes request to see the countries you are configured for.

401 Unauthorized

The user name and password you provided is not valid or you are using an account that does not have API permissions. Make a call to Test Authentication with your username/password in the Authentication header. If you do not see your username echoed back at you, you are using the incorrect password or account.

Missing authorization header

If you are using one of our generated code samples and are receiving the response "Missing authorization header" see Authorization Headers to get examples of how to add them to each language.

415 UnsupportedMediaType

You asked for a media type that we do not support. Make sure your request includes a Content-Type: application/json header.

Service Errors

Service errors are caused by invalid customer data, datasource errors, and address correction/address validation issues. Each error includes a code, indicating the category of service error, and a detailed error message.

Code
Message

1000

Provider Error - There was an error connecting to the source

1001

Missing Required Field

1002

Datasource Unavailable - the source did not respond

1003

Datasource Error - The source returned an error

1004

State not supported (AU Driver license)

1005

Missing consent - consent not sent for the source

1006

Unrecognized Field Name

1008

Invalid Field Format

1009

Unrecognized Field group

1010

Request Timed Out

1011

Duplicate Field received

2000

Unrecognized Error

3000

Address Corrected

3001

State Province Changed

3002

City Changed

3003

Street Info Changed

3004

Postal Code Changed

3005

Missing Address Info

3008

Cannot validate address

3009

Address validation is not available

See the Verify documentation for JSON examples of how errors are returned.

Suggest Edits

Connection

 
Suggest Edits

Say Hello

This method enables you to check if your system can connect to our system. You can even use a web browser to verify a connection to our system.

 
gethttps://api.globaldatacompany.com/connection/v1/sayhello/name
curl --request GET \
  --url https://api.globaldatacompany.com/connection/v1/sayhello/name
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.globaldatacompany.com/connection/v1/sayhello/name' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.globaldatacompany.com/connection/v1/sayhello/name");

xhr.send(data);
require 'uri'
require 'net/http'

url = URI("https://api.globaldatacompany.com/connection/v1/sayhello/name")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
import requests

url = "https://api.globaldatacompany.com/connection/v1/sayhello/name"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Hello Joe Napoli

Path Params

name
string
required

Name to be returned in the response

Response

The name that was in the request.

Your request could not be processed, there should be more details in the response.

The user name and password you provided is not valid or you are using an account not configured to be an API user.

The request took longer to process than we waited.

You asked for a media type that we do not support. You should request application/json in the Content-Type header.

An error happened on the server without a specific message.

SDKs

//Example Username: JoeNapoli_API_Demo, Example Password: 05uZuPRCyPi!6
var truliooClient = new TruliooApiClient("JoeNapoli_API_Demo", "05uZuPRCyPi!6");
var responseString = await truliooClient.Connection.SayHelloAsync("Joe Napoli");
ApiClient apiClient = new ApiClient();
ConnectionApi connectionClient = new ConnectionApi(apiClient);
//sayHello
String hello = connectionClient.sayHello("Joe Napoli");
//sayHelloAsync
connectionClient.sayHelloAsync("sayHello async", new ApiCallback<String>() {
    @Override
    public void onFailure(ApiException e, int statusCode, Map<String, List<String>> responseHeaders) {
        Logger.getLogger(SdkJavaV1Sample.class.getName()).log(Level.SEVERE, null, e);
    }
    @Override
    public void onSuccess(String result, int statusCode, Map<String, List<String>> responseHeaders) {
        System.out.println(result);
    }
    @Override
    public void onUploadProgress(long bytesWritten, long contentLength, boolean done) {
        //To change body of generated methods, choose Tools | Templates.
    }
    @Override
    public void onDownloadProgress(long bytesRead, long contentLength, boolean done) {
        //To change body of generated methods, choose Tools | Templates.
    }
});
Suggest Edits

Test Authentication

This method enables you to check if your credentials are valid. You will need to use basic authentication to ensure a successful response.

 

Basic Auth

 Authentication is required for this endpoint.
gethttps://api.globaldatacompany.com/connection/v1/testauthentication
curl --request GET \
  --url https://api.globaldatacompany.com/connection/v1/testauthentication
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.globaldatacompany.com/connection/v1/testauthentication' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.globaldatacompany.com/connection/v1/testauthentication");

xhr.send(data);
require 'uri'
require 'net/http'

url = URI("https://api.globaldatacompany.com/connection/v1/testauthentication")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
import requests

url = "https://api.globaldatacompany.com/connection/v1/testauthentication"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Hello JoeNapoli_API_Demo

Response

Your username.

Your request could not be processed, there should be more details in the response.

The user name and password you provided is not valid or you are using an account not configured to be an API user.

The request took longer to process than we waited.

You asked for a media type that we do not support. You should request application/json in the Content-Type header.

An error happened on the server without a specific message.

SDKs

//Example Username: JoeNapoli_API_Demo, Example Password: 05uZuPRCyPi!6
var truliooClient = new TruliooApiClient("JoeNapoli_API_Demo", "05uZuPRCyPi!6");
var responseString = await truliooClient.Connection
    .TestAuthenticationAsync();
//Example Username: JoeNapoli_API_Demo, Example Password: 05uZuPRCyPi!6
ApiClient apiClient = new ApiClient();
apiClient.setUsername("JoeNapoli_API_Demo");
apiClient.setPassword("05uZuPRCyPi!6");
ConnectionApi connectionClient = new ConnectionApi(apiClient);
//testAuthentication
String testResult = connectionClient.testAuthentication();
//testAuthenticationAsync
connectionClient.testAuthenticationAsync(new ApiCallback<String>() {
    @Override
    public void onFailure(ApiException e, int statusCode, Map<String, List<String>> responseHeaders) {
        Logger.getLogger(SdkJavaV1Sample.class.getName()).log(Level.SEVERE, null, e);
    }
    @Override
    public void onSuccess(String result, int statusCode, , Map<String, List<String>> responseHeaders) {
        System.out.println(result);
    }
    @Override
    public void onUploadProgress(long bytesWritten, long contentLength, boolean done) {
        //To change body of generated methods, choose Tools | Templates.
    }
    @Override
    public void onDownloadProgress(long bytesRead, long contentLength, boolean done) {
        //To change body of generated methods, choose Tools | Templates.
    }
});
Suggest Edits

Configuration

 
Suggest Edits

Get Country Codes

This method retrieves all the countries that are available to perform a verification. It returns an array of Alpha2 Country Codes

 

Basic Auth

 Authentication is required for this endpoint.
gethttps://api.globaldatacompany.com/configuration/v1/countrycodes/configurationName
curl --request GET \
  --url https://api.globaldatacompany.com/configuration/v1/countrycodes/Identity%20Verification
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.globaldatacompany.com/configuration/v1/countrycodes/Identity%20Verification' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.globaldatacompany.com/configuration/v1/countrycodes/Identity%20Verification");

xhr.send(data);
require 'uri'
require 'net/http'

url = URI("https://api.globaldatacompany.com/configuration/v1/countrycodes/Identity%20Verification")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
import requests

url = "https://api.globaldatacompany.com/configuration/v1/countrycodes/Identity%20Verification"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

[
  "AU",
  "CA",
  "CN",
  "IN",
  "US",
  "GB",
  "IT",
  "MY",
  "NZ",
  "BE"
]

Path Params

configurationName
string
required

The product configuration. Currently "Identity Verification" for all products.

Response

A collection of strings of all the countries that are available to perform a verification.

Your request could not be processed, there should be more details in the response.

The user name and password you provided is not valid or you are using an account not configured to be an API user.

The request took longer to process than we waited.

You asked for a media type that we do not support. You should request application/json in the Content-Type header.

An error happened on the server without a specific message.

SDKs

//Example Username: JoeNapoli_API_Demo, Example Password: 05uZuPRCyPi!6
var truliooClient = new TruliooApiClient("JoeNapoli_API_Demo", "05uZuPRCyPi!6");
IEnumerable<string> e = await truliooClient.Configuration
    .GetCountryCodesAsync("Identity Verification");
//Example Username: JoeNapoli_API_Demo, Example Password: 05uZuPRCyPi!6
ApiClient apiClient = new ApiClient();
apiClient.setUsername("JoeNapoli_API_Demo");
apiClient.setPassword("05uZuPRCyPi!6");
ConfigurationApi configurationClient = new ConfigurationApi(apiClient);
//getCountryCodes
List<String> countryCodes = configurationClient.getCountryCodes("Identity Verification");
//getCountryCodesAsync
configurationClient.getCountryCodesAsync("Identity Verification", new ApiCallback<List<String>>() {
    @Override
    public void onFailure(ApiException e, int statusCode, Map<String, List<String>> responseHeaders) {
        Logger.getLogger(SdkJavaV1Sample.class.getName()).log(Level.SEVERE, null, e);
    }
    @Override
    public void onSuccess(List<String> result, int statusCode, Map<String, List<String>> responseHeaders) {
        System.out.println(result); //To change body of generated methods, choose Tools | Templates.
    }
    @Override
    public void onUploadProgress(long bytesWritten, long contentLength, boolean done) {
        //To change body of generated methods, choose Tools | Templates.
    }
    @Override
    public void onDownloadProgress(long bytesRead, long contentLength, boolean done) {
        //To change body of generated methods, choose Tools | Templates.
    }
});
        
Suggest Edits

Get Consents

This method retrieves the consents required for data sources currently configured in your account configuration.
The response for this method contains a collection of strings that Verify method's ConsentForDataSources field expects to perform a verification using those data sources.
A failure to provide an element from the string collection will lead to a 1005 service error.

 

Basic Auth

 Authentication is required for this endpoint.
gethttps://api.globaldatacompany.com/configuration/v1/consents/configurationName/countryCode
curl --request GET \
  --url https://api.globaldatacompany.com/configuration/v1/consents/Identity%20Verification/countryCode
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.globaldatacompany.com/configuration/v1/consents/Identity%20Verification/countryCode' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.globaldatacompany.com/configuration/v1/consents/Identity%20Verification/countryCode");

xhr.send(data);
require 'uri'
require 'net/http'

url = URI("https://api.globaldatacompany.com/configuration/v1/consents/Identity%20Verification/countryCode")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
import requests

url = "https://api.globaldatacompany.com/configuration/v1/consents/Identity%20Verification/countryCode"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

[
  "Australia Driver Licence",
  "Australia Passport",
  "Birth Registry",
  "Visa Verification",
  "DVS Driver License Search",
  "DVS Medicare Search",
  "DVS Passport Search",
  "DVS Visa Search",
  "DVS ImmiCard Search",
  "DVS Citizenship Certificate Search",
  "DVS Certificate of Registration by Descent Search",
  "Credit Agency"
]

Path Params

countryCode
string
required

Country alpha2 code. Call Get Country Codes to get the countries available to you.

configurationName
string
required

The product configuration. Currently "Identity Verification" for all products.

Response

A collection of strings that Verify method's ConsentForDataSources field expects to perform a verification using those data sources.

Your request could not be processed, there should be more details in the response.

The user name and password you provided is not valid or you are using an account not configured to be an API user.

The request took longer to process than we waited.

You asked for a media type that we do not support. You should request application/json in the Content-Type header.

An error happened on the server without a specific message.

SDKs

//Example Username: JoeNapoli_API_Demo, Example Password: 05uZuPRCyPi!6
var truliooClient = new TruliooApiClient("JoeNapoli_API_Demo", "05uZuPRCyPi!6");
IEnumerable<string> e = await truliooClient.Configuration
    .GetConsentsAsync("AU", "Identity Verification");
//Example Username: JoeNapoli_API_Demo, Example Password: 05uZuPRCyPi!6
ApiClient apiClient = new ApiClient();
apiClient.setUsername("JoeNapoli_API_Demo");
apiClient.setPassword("05uZuPRCyPi!6");
ConfigurationApi configurationClient = new ConfigurationApi(apiClient);
//getConsents
List<String> result = configurationClient.getConsents("AU", "Identity Verification");
//getConsentsAsync
configurationClient.getConsentsAsync("AU", "Identity Verification", new ApiCallback<List<String>>() {
    @Override
    public void onFailure(ApiException e, int statusCode, Map<String, List<String>> responseHeaders) {
        Logger.getLogger(SdkJavaV1Sample.class.getName()).log(Level.SEVERE, null, e);
    }
    @Override
    public void onSuccess(List<String> result, int statusCode, Map<String, List<String>> responseHeaders) {
        System.out.println(result);
    }
    @Override
    public void onUploadProgress(long bytesWritten, long contentLength, boolean done) {
        //To change body of generated methods, choose Tools | Templates.
    }
    @Override
    public void onDownloadProgress(long bytesRead, long contentLength, boolean done) {
        //To change body of generated methods, choose Tools | Templates.
    }
});
Suggest Edits

Get Country Subdivisions

Gets the provinces states or other subdivisions for a country, mostly matches ISO 3166-2

 

Basic Auth

 Authentication is required for this endpoint.
gethttps://api.globaldatacompany.com/configuration/v1/countrysubdivisions/countryCode
curl --request GET \
  --url https://api.globaldatacompany.com/configuration/v1/countrysubdivisions/countryCode
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.globaldatacompany.com/configuration/v1/countrysubdivisions/countryCode' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.globaldatacompany.com/configuration/v1/countrysubdivisions/countryCode");

xhr.send(data);
require 'uri'
require 'net/http'

url = URI("https://api.globaldatacompany.com/configuration/v1/countrysubdivisions/countryCode")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
import requests

url = "https://api.globaldatacompany.com/configuration/v1/countrysubdivisions/countryCode"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

[
  {
    "Name": "Northern Territory",
    "Code": "NT",
    "ParentCode": ""
  },
  {
    "Name": "Western Australia",
    "Code": "WA",
    "ParentCode": ""
  },
  {
    "Name": "New South Wales",
    "Code": "NSW",
    "ParentCode": ""
  },
  {
    "Name": "Queensland",
    "Code": "QLD",
    "ParentCode": ""
  },
  {
    "Name": "South Australia",
    "Code": "SA",
    "ParentCode": ""
  },
  {
    "Name": "Tasmania",
    "Code": "TAS",
    "ParentCode": ""
  },
  {
    "Name": "Victoria",
    "Code": "VIC",
    "ParentCode": ""
  },
  {
    "Name": "Australian Capital Territory",
    "Code": "ACT",
    "ParentCode": ""
  }
]

Path Params

countryCode
string
required

Country alpha2 code. Call Get Country Codes to get the countries available to you.

Response

An array of the following object, where each object is the value of a province, state or other subdivision for the given country.

Namestring

Name of the area, in english or one of the languages of the country

Codestring

Code for the area

ParentCodestring

Code of the parent entity

Your request could not be processed, there should be more details in the response.

The user name and password you provided is not valid or you are using an account not configured to be an API user.

The request took longer to process than we waited.

You asked for a media type that we do not support. You should request application/json in the Content-Type header.

An error happened on the server without a specific message.

SDKs

//Example Username: JoeNapoli_API_Demo, Example Password: 05uZuPRCyPi!6
var truliooClient = new TruliooApiClient("JoeNapoli_API_Demo", "05uZuPRCyPi!6");
IEnumerable<CountrySubdivision> e = await truliooClient.Configuration
    .GetCountrySubdivisionsAsync("AU");
//Example Username: JoeNapoli_API_Demo, Example Password: 05uZuPRCyPi!6
ApiClient apiClient = new ApiClient();
apiClient.setUsername("JoeNapoli_API_Demo");
apiClient.setPassword("05uZuPRCyPi!6");
ConfigurationApi configurationClient = new ConfigurationApi(apiClient);
//getCountrySubdivisions
List<CountrySubdivision> countrySubdivisions = configurationClient.getCountrySubdivisions("AU");
//getCountrySubdivisionsAsync        
configurationClient.getCountrySubdivisionsAsync("AU", new ApiCallback<List<CountrySubdivision>>() {
    @Override
    public void onFailure(ApiException e, int statusCode, Map<String, List<String>> responseHeaders) {
        Logger.getLogger(SdkJavaV1Sample.class.getName()).log(Level.SEVERE, null, e);
    }
    @Override
    public void onSuccess(List<CountrySubdivision> result, int statusCode, Map<String, List<String>> responseHeaders) {
        System.out.println(result);
    }
    @Override
    public void onUploadProgress(long bytesWritten, long contentLength, boolean done) {
        //To change body of generated methods, choose Tools | Templates.
    }
    @Override
    public void onDownloadProgress(long bytesRead, long contentLength, boolean done) {
        //To change body of generated methods, choose Tools | Templates.
    }
});
Suggest Edits

Get Fields

Generates json schema for the API, the schema is dynamic based on the country and configuration you are using json-schema.org

 

Basic Auth

 Authentication is required for this endpoint.
gethttps://api.globaldatacompany.com/configuration/v1/fields/configurationName/countryCode
curl --request GET \
  --url https://api.globaldatacompany.com/configuration/v1/fields/Identity%20Verification/countryCode
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.globaldatacompany.com/configuration/v1/fields/Identity%20Verification/countryCode' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.globaldatacompany.com/configuration/v1/fields/Identity%20Verification/countryCode");

xhr.send(data);
require 'uri'
require 'net/http'

url = URI("https://api.globaldatacompany.com/configuration/v1/fields/Identity%20Verification/countryCode")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
import requests

url = "https://api.globaldatacompany.com/configuration/v1/fields/Identity%20Verification/countryCode"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  "title": "DataFields",
  "type": "object",
  "properties": {
    "PersonInfo": {
      "title": "PersonInfo",
      "type": "object",
      "properties": {
        "FirstGivenName": {
          "type": "string",
          "description": "First name of the individual to be verified",
          "label": "First Name (名)"
        },
        "MiddleName": {
          "type": "string",
          "description": "Second given name of the individual to be verified",
          "label": "Middle Name"
        },
        "FirstSurName": {
          "type": "string",
          "description": "Last name of the individual to be verified",
          "label": "Last Name (姓)"
        },
        "ISOLatin1Name": {
          "type": "string",
          "description": "ISO Latin 1 Full name as it appears on passport",
          "label": "Passport Full Name"
        },
        "DayOfBirth": {
          "type": "int",
          "description": "Day of birth date (ie 23 for a date of birth of 23/11/1975)",
          "label": "Day Of Birth (日)"
        },
        "MonthOfBirth": {
          "type": "int",
          "description": "Month of birth date (ie 11 for a date of birth of 23/11/1975)",
          "label": "Month Of Birth (月)"
        },
        "YearOfBirth": {
          "type": "int",
          "description": "Year of birth date (ie 1975 for a date of birth of 23/11/1975)",
          "label": "Year Of Birth (年)"
        },
        "Gender": {
          "type": "string",
          "description": "Gender, may be 'M' for male or 'F' for female",
          "label": "Gender"
        },
        "AdditionalFields": {
          "type": "object",
          "description": "Family name and given names, together as found on identification documents",
          "label": "Full Name (姓名)",
          "properties": {
            "title": "AdditionalFields",
            "type": "object",
            "properties": {
              "FullName": {
                "type": "string",
                "description": "Family name and given names, together as found on identification documents",
                "label": "Full Name (姓名)"
              }
            },
            "required": [
              "FullName"
            ]
          }
        }
      },
      "required": [
        "FirstGivenName",
        "FirstGivenName",
        "FirstSurName",
        "FirstSurName",
        "AdditionalFields",
        "ISOLatin1Name"
      ]
    },
    "Location": {
      "title": "Location",
      "type": "object",
      "properties": {
        "BuildingNumber": {
          "type": "string",
          "description": "Building number of home address",
          "label": "Building Number (楼房号码)"
        },
        "BuildingName": {
          "type": "string",
          "description": "Building name of home address",
          "label": "Building Name (楼房名称)"
        },
        "UnitNumber": {
          "type": "string",
          "description": "Flat/Unit/Apartment number of primary residence",
          "label": "Unit Number"
        },
        "StreetName": {
          "type": "string",
          "description": "Street name of primary residence",
          "label": "Street Name (街道名称)"
        },
        "StreetType": {
          "type": "string",
          "description": "Street type of primary residence (Typically St, Rd etc)",
          "label": "Street Type (街道种类)"
        },
        "City": {
          "type": "string",
          "description": "City of home address",
          "label": "City (城市)"
        },
        "Suburb": {
          "type": "string",
          "description": "City or Suburb of primary residence",
          "label": "Suburb"
        },
        "County": {
          "type": "string",
          "description": "County of home address",
          "label": "County (县)"
        },
        "StateProvinceCode": {
          "type": "string",
          "description": "State or Province",
          "label": "State Province"
        },
        "PostalCode": {
          "type": "string",
          "description": "ZIP Code or Postal Code of primary residence",
          "label": "Postal Code"
        },
        "POBox": {
          "type": "string",
          "description": "Post Office Box",
          "label": "PO Box"
        },
        "AdditionalFields": {
          "type": "object",
          "description": "Street address of primary residence",
          "label": "Address 1",
          "properties": {
            "title": "AdditionalFields",
            "type": "object",
            "properties": {
              "Address1": {
                "type": "string",
                "description": "Street address of primary residence",
                "label": "Address 1"
              }
            },
            "required": []
          }
        }
      },
      "required": []
    },
    "Communication": {
      "title": "Communication",
      "type": "object",
      "properties": {
        "Telephone": {
          "type": "string",
          "description": "Telephone number of the individual to be verified",
          "label": "Telephone (固定电话号码)"
        },
        "EmailAddress": {
          "type": "string",
          "description": "Email Address",
          "label": "Email Address"
        }
      },
      "required": [
        "EmailAddress"
      ]
    },
    "NationalIds": {
      "title": "NationalIds",
      "type": "object",
      "properties": {
        "Number": {
          "type": "string",
          "description": "(National ID Number)"
        },
        "Type": {
          "type": "string",
          "value": "nationalid"
        },
        "DistrictOfIssue": {
          "type": "string",
          "description": "District where document was issued",
          "label": "District Of Issue (发证区)"
        },
        "CityOfIssue": {
          "type": "string",
          "description": "City where document was issued",
          "label": "City Of Issue (发证城市)"
        },
        "ProvinceOfIssue": {
          "type": "string",
          "description": "Province where document was issued",
          "label": "Province Of Issue (发证省)"
        },
        "CountyOfIssue": {
          "type": "string",
          "description": "County where document was issued",
          "label": "County Of Issue (发证县)"
        }
      },
      "required": [
        "ProvinceOfIssue",
        "nationalid"
      ]
    },
    "Passport": {
      "title": "Passport",
      "type": "object",
      "properties": {
        "Mrz1": {
          "type": "string",
          "description": "First line of the Machine Readable Zone (MRZ) of passport, 44 letters and digits, i.e. 'P<CZESPECIMEN<<VZOR<<<<<<<<<<<<<<<<<<<<<<<<<'",
          "label": "Passport MRZ Line 1 (护照第一行MRZ)"
        },
        "Mrz2": {
          "type": "string",
          "description": "Second line of the Machine Readable Zone (MRZ) of passport, 44 letters and digits, i.e. '99003853<1CZE1101018M1207046110101111<<<<<94'",
          "label": "Passport MRZ Line 2 (护照第二行MRZ)"
        },
        "Number": {
          "type": "string",
          "description": "Passport number of the individual to be verified",
          "label": "Passport Number (护照号)"
        },
        "DayOfExpiry": {
          "type": "int",
          "description": "Day of month of expiration of passport, 2 digits, i.e. '14'",
          "label": "Passport Day Of Expiry"
        },
        "MonthOfExpiry": {
          "type": "int",
          "description": "Month of year of expiration of passport, 2 digits, i.e. '08'",
          "label": "Passport Month Of Expiry"
        },
        "YearOfExpiry": {
          "type": "int",
          "description": "Year of expiration of passport, 4 digits, i.e. '1980'",
          "label": "Passport Year Of Expiry"
        }
      },
      "required": [
        "Mrz1",
        "Mrz2"
      ]
    },
    "Business": {
      "title": "Business",
      "type": "object",
      "properties": {
        "BusinessName": {
          "type": "string",
          "description": "The Primary or Registered name of the business",
          "label": "Business Name"
        },
        "BusinessRegistrationNumber": {
          "type": "string",
          "description": "Registration number of a business to be verified",
          "label": "Business Registration Number"
        },
        "DayOfIncorporation": {
          "type": "int",
          "description": "Day of Incorporation date",
          "label": "Day Of Incorporation"
        },
        "MonthOfIncorporation": {
          "type": "int",
          "description": "Month of Incorporation date",
          "label": "Month Of Incorporation"
        },
        "YearOfIncorporation": {
          "type": "int",
          "description": "Year of Incorporation date",
          "label": "Year Of Incorporation"
        },
        "JurisdictionOfIncorporation": {
          "type": "string",
          "description": "Jurisdiction Of Incorporation",
          "label": "Jurisdiction Of Incorporation"
        },
        "ShareholderListDocument": {
          "type": "boolean",
          "description": "Retrieve the shareholder list document of a company from the Government Registry",
          "label": "Shareholder List Document"
        }
      },
      "required": [
        "BusinessName",
        "BusinessRegistrationNumber"
      ]
    },
    "CountrySpecific": {
      "title": "CountrySpecific",
      "type": "object",
      "properties": {
        "CN": {
          "title": "CN",
          "type": "object",
          "properties": {
            "PassportMRZLine1": {
              "type": "string",
              "description": "First line of the Machine Readable Zone (MRZ) of passport, 44 letters and digits, i.e. 'P<CZESPECIMEN<<VZOR<<<<<<<<<<<<<<<<<<<<<<<<<'",
              "label": "Passport MRZ Line 1 (护照第一行MRZ)"
            },
            "PassportMRZLine2": {
              "type": "string",
              "description": "Second line of the Machine Readable Zone (MRZ) of passport, 44 letters and digits, i.e. '99003853<1CZE1101018M1207046110101111<<<<<94'",
              "label": "Passport MRZ Line 2 (护照第二行MRZ)"
            },
            "PassportDayOfExpiry": {
              "type": "string",
              "description": "Day of month of expiration of passport, 2 digits, i.e. '14'",
              "label": "Passport Day Of Expiry"
            },
            "PassportMonthOfExpiry": {
              "type": "string",
              "description": "Month of year of expiration of passport, 2 digits, i.e. '08'",
              "label": "Passport Month Of Expiry"
            },
            "PassportNumber": {
              "type": "string",
              "description": "Passport number of the individual to be verified",
              "label": "Passport Number (护照号)"
            },
            "PassportYearOfExpiry": {
              "type": "string",
              "description": "Year of expiration of passport, 4 digits, i.e. '1980'",
              "label": "Passport Year Of Expiry"
            }
          },
          "required": [
            "PassportMRZLine1",
            "PassportMRZLine2"
          ]
        }
      }
    }
  }
}

Path Params

countryCode
string
required

Country alpha2 code. Call Get Country Codes to get the countries available to you.

configurationName
string
required

The product configuration. Currently "Identity Verification" for all products.

Response

OK

Your request could not be processed, there should be more details in the response.

The user name and password you provided is not valid or you are using an account not configured to be an API user.

The request took longer to process than we waited.

You asked for a media type that we do not support. You should request application/json in the Content-Type header.

An error happened on the server without a specific message.

SDKs

//Example Username: JoeNapoli_API_Demo, Example Password: 05uZuPRCyPi!6
var truliooClient = new TruliooApiClient("JoeNapoli_API_Demo", "05uZuPRCyPi!6");
Dictionary<string, dynamic> e = await truliooClient
    .Configuration.GetFieldsAsync("AU", "Identity Verification");
//Example Username: JoeNapoli_API_Demo, Example Password: 05uZuPRCyPi!6
ApiClient apiClient = new ApiClient();
apiClient.setUsername("JoeNapoli_API_Demo");
apiClient.setPassword("05uZuPRCyPi!6");
ConfigurationApi configurationClient = new ConfigurationApi(apiClient);
//getFields
Object o = configurationClient.getFields("AU", "Identity Verification");
//getFieldsAsync
configurationClient.getFieldsAsync("AU", "Identity Verification", new ApiCallback<Object>() {
    @Override
    public void onFailure(ApiException e, int statusCode, Map<String, List<String>> responseHeaders) {
        Logger.getLogger(SdkJavaV1Sample.class.getName()).log(Level.SEVERE, null, e);
    }
    @Override
    public void onSuccess(Object result, int statusCode, Map<String, List<String>> responseHeaders) {
        System.out.println(result); //To change body of generated methods, choose Tools | Templates.
    }
    @Override
    public void onUploadProgress(long bytesWritten, long contentLength, boolean done) {
        //To change body of generated methods, choose Tools | Templates.
    }
    @Override
    public void onDownloadProgress(long bytesRead, long contentLength, boolean done) {
        //To change body of generated methods, choose Tools | Templates.
    }
});
        
Suggest Edits

Get Test Entities

Gets the test entities configured for your product and country.

 

Basic Auth

 Authentication is required for this endpoint.
gethttps://api.globaldatacompany.com/configuration/v1/testentities/configurationName/countryCode
curl --request GET \
  --url https://api.globaldatacompany.com/configuration/v1/testentities/Identity%20Verification/countryCode
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.globaldatacompany.com/configuration/v1/testentities/Identity%20Verification/countryCode' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.globaldatacompany.com/configuration/v1/testentities/Identity%20Verification/countryCode");

xhr.send(data);
require 'uri'
require 'net/http'

url = URI("https://api.globaldatacompany.com/configuration/v1/testentities/Identity%20Verification/countryCode")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
import requests

url = "https://api.globaldatacompany.com/configuration/v1/testentities/Identity%20Verification/countryCode"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

[
  {
    "PersonInfo": {
      "FirstGivenName": "John",
      "MiddleName": "Henry",
      "FirstSurName": "Smith",
      "DayOfBirth": "5",
      "MonthOfBirth": "3",
      "YearOfBirth": "1983",
      "Gender": "M"
    },
    "Location": {
      "BuildingNumber": "10",
      "UnitNumber": "3",
      "StreetName": "Lawford",
      "StreetType": "st",
      "Suburb": "Doncaster",
      "StateProvinceCode": "VIC",
      "PostalCode": "3108"
    },
    "Communication": {
      "Telephone": "03 9896 8785",
      "EmailAddress": "testpersonAU@gdctest.com"
    },
    "DriverLicence": {
      "Number": "076310691",
      "State": "VIC",
      "DayOfExpiry": "3",
      "MonthOfExpiry": "4",
      "YearOfExpiry": "2021"
    },
    "NationalIds": [
      {
        "Number": "5643513953",
        "Type": "Health"
      }
    ],
    "Passport": {
      "Mrz1": "P<SAGSMITH<<JOHN<HENRY<<<<<<<<<<<<<<<<<<<<<<",
      "Mrz2": "N1236548<1AUS8303052359438740809<<<<<<<<<<54",
      "Number": "N1236548",
      "DayOfExpiry": "5",
      "MonthOfExpiry": "12",
      "YearOfExpiry": "2018"
    },
    "CountrySpecific": {
      "AU": {
        "AuImmiCardNumber": "EIS123456",
        "CitizenshipAcquisitionDay": "15",
        "CitizenshipAcquisitionMonth": "4",
        "CitizenshipAcquisitionYear": "1987",
        "CountryOfBirth": "Australia",
        "FamilyNameAtBirth": "Smith",
        "MedicareColor": "Blue",
        "MedicareMonthOfExpiry": "12",
        "MedicareReference": "2",
        "MedicareYearOfExpiry": "2017",
        "PassportCountry": "Australia",
        "PlaceOfBirth": "Melbourne",
        "RegistrationNumber": "565659",
        "RegistrationState": "NSW",
        "StockNumber": "ACD1234567"
      }
    }
  }
]

Path Params

configurationName
string
required

The product configuration. Currently "Identity Verification" for all products.

countryCode
string
required

Country alpha2 code. Call Get Country Codes to get the countries available to you.

Response

A Test Entity comprises of the same fields you will see in a Verify request body.

PersonInfoobject

Personal Information

PersonInfo.FirstGivenNamestring

First name of the individual to be verified. Dual purpose First Name or Initial.

PersonInfo.MiddleNamestring

Second given name of the individual to be verified. Dual purpose Middle Name or Initial.

PersonInfo.FirstSurNamestring

First (paternal) family name of the individual to be verified

PersonInfo.SecondSurnamestring

second family name of the individual to be verified

PersonInfo.ISOLatin1Namestring

Enter full name in ISO Latin-1 character set. Used for data sources that require the person’s name in ISO Latin-1 format (i.e. as Passport MRZ).

PersonInfo.DayOfBirthinteger

Day of birth date (i.e. 23 for a date of birth of 23/11/1975)

PersonInfo.MonthOfBirthinteger

Month of birth date (i.e. 11 for a date of birth of 23/11/1975)

PersonInfo.YearOfBirthinteger

Year of birth date (i.e. 1975 for a date of birth of 23/11/1975)

PersonInfo.MinimumAgeinteger

Minimum permitted age of the individual. GlobalGateway calculates age of individual and compares it to this number.

PersonInfo.Genderstring

Single character M / F (M = Male, F = Female)

PersonInfo.AdditionalFieldsobject
PersonInfo.AdditionalFields.FullNamestring

Full name of the individual to be verified.

Locationobject

Location Information

Location.BuildingNumberstring

House / Civic / Building number of home address

Location.BuildingNamestring

Name of building of home address

Location.UnitNumberstring

Flat/Unit/Apartment number of home address

Location.StreetNamestring

Street name of primary residence

Location.StreetTypestring

Street type of primary residence (Typically St, Rd etc)

Location.Citystring

City of home address

Location.Suburbstring

Suburb / Subdivision / Municipality of home address

Location.Countystring

County / District of home address

Location.StateProvinceCodestring

State of primary residence. US sources expect 2 characters. Australian sources expect 2 or 3 characters. Can be gotten using the Get Country Subdivisions call.

Location.Countrystring

Country of physical address (ISO 3166-1 alpha-2 code)

Location.PostalCodestring

ZIP Code or Postal Code of home address

Location.POBoxstring

Post Office Box

Location.AdditionalFieldsobject

Fields not normally used

Location.AdditionalFields.Address1string

Address1 is available in certain countries. It can be used to pass a compiled address field instead of sending individual address attributes (such as UnitNumber, BuidlingNumber, BuildingName, StreetName and StreetType).
GlobalGateway will provide a pass through of Address1 directly to connected datasources for the selected country.
Please note: each datasource requires the address fields to be configured in a certain manner, implementing and sending Address1 instead of individual address fields may affect your ability to verify this address.

Communicationobject

Communication Information

Communication.MobileNumberstring

Mobile phone number of the individual to be verified.

Communication.Telephonestring

Telephone number of the individual to be verified

Communication.Telephone2string

Additional Phone/Mobile Number of the individual to be verified

Communication.EmailAddressstring

Email address of the individual to be verified

DriverLicenceobject

Driver Licence Information

DriverLicence.Numberstring

Driver's Licence Number of the individual to be verified

DriverLicence.Statestring

State of issue for driver's Licence

DriverLicence.DayOfExpiryinteger

Driver's Licence day of expiry of the individual to be verified

DriverLicence.MonthOfExpiryinteger

Driver's Licence month of expiry of the individual to be verified

DriverLicence.YearOfExpiryinteger

Driver's Licence year of expiry of the individual to be verified

NationalIdsarray

National Identification Information

Passportobject

Passport information

Passport.Mrz1string

Line 1 of the passport MRZ.

Passport.Mrz2string

Line 2 of the passport MRZ.

Passport.Numberstring

Passport Number.

Passport.DayOfExpiryinteger

Passport's Licence day of expiry of the individual to be verified.

Passport.MonthOfExpiryinteger

Passport's Licence month of expiry of the individual to be verified.

Passport.YearOfExpiryinteger

Passport's Licence year of expiry of the individual to be verified.

Documentobject

Document information

Document.DocumentFrontImagestring

Front of the document encoded as a Base64 encoded string.

Document.DocumentBackImagestring

Back of the document encoded as a Base64 encoded string.

Document.LivePhotostring

Selfie image encoded as a Base64 encoded string.

Document.DocumentTypestring

Document type.
Supported Types: DrivingLicence, IdentityCard, Passport, ResidencePermit.

Document.AcceptIncompleteDocumentboolean

Accept Incomplete Document.
To allow verification with an incomplete document set this to true. For example, to allow verification by using only the front image of a document. By default: true.

Document.ValidateDocumentImageQualityboolean

Validate Document Image Quality.

Businessobject

Business information

Business.BusinessNamestring

Name of the business to be verified

Business.BusinessRegistrationNumberstring

Registration number of business to be verified

Business.DayOfIncorporationinteger

Day of incorporation of the business to be verified

Business.MonthOfIncorporationinteger

Month of incorporation of the business to be verified

Business.YearOfIncorporationinteger

Year of incorporation of the business to be verified

Business.JurisdictionOfIncorporationstring

Jurisdiction Of Incorporation of the business to be verified

Business.ShareholderListDocumentboolean

Whether or not to retrieve shareholderList document

Business.FinancialInformationDocumentboolean

Whether or not to retrieve financial information document

CountrySpecificobject

CountrySpecific fields
{"CountryCode" : {"Field1" : "Value",
"Field2" : "Value"
}}

Your request could not be processed, there should be more details in the response.

The user name and password you provided is not valid or you are using an account not configured to be an API user.

The request took longer to process than we waited.

You asked for a media type that we do not support. You should request application/json in the Content-Type header.

An error happened on the server without a specific message.

SDKs

Coming Soon...
//Example Username: JoeNapoli_API_Demo, Example Password: 05uZuPRCyPi!6
ApiClient apiClient = new ApiClient();
apiClient.setUsername("JoeNapoli_API_Demo");
apiClient.setPassword("05uZuPRCyPi!6");
ConfigurationApi configurationClient = new ConfigurationApi(apiClient);
//getTestEntities
List<DataFields> result = configurationClient.getTestEntities("Identity Verification", "AU");
//getTestEntitiesAsync
configurationClient.getTestEntitiesAsync("Identity Verification", "AU", new ApiCallback<List<DataFields>>() {
    @Override
    public void onFailure(ApiException e, int statusCode, Map<String, List<String>> responseHeaders) {
        Logger.getLogger(SdkJavaV1Sample.class.getName()).log(Level.SEVERE, null, e);
    }
    @Override
    public void onSuccess(List<DataFields> result, int statusCode, Map<String, List<String>> responseHeaders) {
        System.out.println(result);
    }
    @Override
    public void onUploadProgress(long bytesWritten, long contentLength, boolean done) {
        //To change body of generated methods, choose Tools | Templates.
    }
    @Override
    public void onDownloadProgress(long bytesRead, long contentLength, boolean done) {
        //To change body of generated methods, choose Tools | Templates.
    }
});
Suggest Edits

Get Datasources

Gets datasource groups configured for your product and country.

 

Basic Auth

 Authentication is required for this endpoint.
gethttps://api.globaldatacompany.com/configuration/v1/datasources/configurationName/countryCode
curl --request GET \
  --url https://api.globaldatacompany.com/configuration/v1/datasources/Identity%20Verification/countryCode
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.globaldatacompany.com/configuration/v1/datasources/Identity%20Verification/countryCode' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.globaldatacompany.com/configuration/v1/datasources/Identity%20Verification/countryCode");

xhr.send(data);
require 'uri'
require 'net/http'

url = URI("https://api.globaldatacompany.com/configuration/v1/datasources/Identity%20Verification/countryCode")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
import requests

url = "https://api.globaldatacompany.com/configuration/v1/datasources/Identity%20Verification/countryCode"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

[
  {
    "Name": "Credit Agency",
    "Description": "Consumer Credit Source. Per Australia legislation, specific match details are not provided. Only overall match results are shown. The data is based on the credit header data of a permanent or temporary citizen of Australia, as well as being aggregated and managed by one of the major credit - reporting bureaus in the country.",
    "RequiredFields": [
      {
        "FieldName": "FirstGivenName",
        "Type": "string"
      },
      {
        "FieldName": "LastName",
        "Type": "string"
      }
    ],
    "OptionalFields": [
      {
        "FieldName": "MiddleName",
        "Type": "string"
      }
    ],
    "AppendedFields": [
      {
        "FieldName": "IsDeceased",
        "Type": "boolean"
      }
    ],
    "OutputFields": [
      {
        "FieldName": "FirstGivenName",
        "Type": "string"
      },
      {
        "FieldName": "LastName",
        "Type": "string"
      }
    ],
    "SourceType": "Credit",
    "UpdateFrequency": null,
    "Coverage": "25%"
  },
  {
    "Name": "Credit Agency 2",
    "Description": "Consumer Credit Source. Per Australia legislation, specific match details are not provided. Only overall match results are shown. The data is based on the credit header data of a permanent or temporary citizen of Australia, as well as being aggregated and managed by one of the major credit - reporting bureaus in the country.",
    "RequiredFields": [
      {
        "FieldName": "FirstGivenName",
        "Type": "string"
      },
      {
        "FieldName": "LastName",
        "Type": "string"
      }
    ],
    "OptionalFields": [],
    "AppendedFields": [],
    "OutputFields": [
      {
        "FieldName": "FirstGivenName",
        "Type": "string"
      },
      {
        "FieldName": "LastName",
        "Type": "string"
      }
    ],
    "SourceType": "Credit",
    "UpdateFrequency": null,
    "Coverage": "1M"
  }
]

Path Params

configurationName
string
required

The product configuration. Currently "Identity Verification" for all products.

countryCode
string
required

Country alpha2 code. Call Get Country Codes to get the countries available to you.

Response

You will receive an array where each object represents one of the Data source groups that you're configured for in the given country. Each object will have the following structure.

Namestring

Name

Descriptionstring

Description

RequiredFieldsarray

Required Fields

OptionalFieldsarray

Optional Fields

AppendedFieldsarray

Appended Fields

OutputFieldsarray

Output Fields

SourceTypestring

Source Type

UpdateFrequencystring

Update Frequency

Coveragestring

Coverage

Your request could not be processed, there should be more details in the response.

The user name and password you provided is not valid or you are using an account not configured to be an API user.

The request took longer to process than we waited.

You asked for a media type that we do not support. You should request application/json in the Content-Type header.

An error happened on the server without a specific message.

SDKs

Coming Soon...
Coming Soon...
Suggest Edits

Verifications

 
Suggest Edits

Get Transaction Record

This method is used to retrieve the request and results of a verification performed using the verify method.
The response for this method includes the same information as verify method's response, along with data present in the input fields of the verify request.

 

Basic Auth

 Authentication is required for this endpoint.
gethttps://api.globaldatacompany.com/verifications/v1/transactionrecord/id
curl --request GET \
  --url https://api.globaldatacompany.com/verifications/v1/transactionrecord/id
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.globaldatacompany.com/verifications/v1/transactionrecord/id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.globaldatacompany.com/verifications/v1/transactionrecord/id");

xhr.send(data);
require 'uri'
require 'net/http'

url = URI("https://api.globaldatacompany.com/verifications/v1/transactionrecord/id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
import requests

url = "https://api.globaldatacompany.com/verifications/v1/transactionrecord/id"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  "InputFields": [
    {
      "FieldName": "PostalCode",
      "Value": "3108"
    },
    {
      "FieldName": "Suburb",
      "Value": "Doncaster"
    },
    {
      "FieldName": "State",
      "Value": "Victoria"
    },
    {
      "FieldName": "YearOfBirth",
      "Value": "1983"
    },
    {
      "FieldName": "YearOfBirth",
      "Value": "1983"
    },
    {
      "FieldName": "FirstName",
      "Value": "John"
    },
    {
      "FieldName": "MiddleName",
      "Value": "Henry"
    },
    {
      "FieldName": "LastName",
      "Value": "Smith"
    },
    {
      "FieldName": "DayOfBirth",
      "Value": "5"
    },
    {
      "FieldName": "MonthOfBirth",
      "Value": "3"
    },
    {
      "FieldName": "Gender",
      "Value": "M"
    },
    {
      "FieldName": "StreetNumber",
      "Value": "10"
    },
    {
      "FieldName": "UnitNumber",
      "Value": "3"
    },
    {
      "FieldName": "StreetName",
      "Value": "Lawford"
    },
    {
      "FieldName": "StreetType",
      "Value": "st"
    },
    {
      "FieldName": "Telephone",
      "Value": "03 9896 8785"
    },
    {
      "FieldName": "EmailAddress",
      "Value": "testpersonAU@gdctest.com"
    },
    {
      "FieldName": "DriverLicenceNumber",
      "Value": "076310691"
    },
    {
      "FieldName": "DriverLicenceState",
      "Value": "VIC"
    },
    {
      "FieldName": "DayOfExpiry",
      "Value": "3"
    },
    {
      "FieldName": "MonthOfExpiry",
      "Value": "4"
    },
    {
      "FieldName": "YearOfExpiry",
      "Value": "2021"
    },
    {
      "FieldName": "PassportNumber",
      "Value": "N1236548"
    },
    {
      "FieldName": "MedicareNumber",
      "Value": "5643513953"
    },
    {
      "FieldName": "AuImmiCardNumber",
      "Value": "EIS123456"
    },
    {
      "FieldName": "CitizenshipAcquisitionDay",
      "Value": "15"
    },
    {
      "FieldName": "CitizenshipAcquisitionMonth",
      "Value": "4"
    },
    {
      "FieldName": "CitizenshipAcquisitionYear",
      "Value": "1987"
    },
    {
      "FieldName": "CountryOfBirth",
      "Value": "Australia"
    },
    {
      "FieldName": "FamilyNameAtBirth",
      "Value": "Smith"
    },
    {
      "FieldName": "MedicareColor",
      "Value": "Blue"
    },
    {
      "FieldName": "MedicareMonthOfExpiry",
      "Value": "12"
    },
    {
      "FieldName": "MedicareReference",
      "Value": "2"
    },
    {
      "FieldName": "MedicareYearOfExpiry",
      "Value": "2017"
    },
    {
      "FieldName": "PassportCountry",
      "Value": "Australia"
    },
    {
      "FieldName": "PlaceOfBirth",
      "Value": "Melbourne"
    },
    {
      "FieldName": "RegistrationNumber",
      "Value": "565659"
    },
    {
      "FieldName": "RegistrationState",
      "Value": "NSW"
    },
    {
      "FieldName": "StockNumber",
      "Value": "ACD1234567"
    },
    {
      "FieldName": "FirstInitial",
      "Value": "J"
    },
    {
      "FieldName": "MiddleInitial",
      "Value": "J"
    }
  ],
  "UploadedDt": "2017-07-11T21:47:50",
  "Record": {
    "TransactionRecordID": "0ac8ccee-ab7a-495e-8b88-a6da1bdcb6ae",
    "RecordStatus": "match",
    "DatasourceResults": [
      {
        "DatasourceName": "Australia Citizen File",
        "DatasourceFields": [
          {
            "FieldName": "BuildingNumber",
            "Status": "match"
          },
          {
            "FieldName": "MiddleName",
            "Status": "match"
          },
          {
            "FieldName": "StreetName",
            "Status": "match"
          },
          {
            "FieldName": "UnitNumber",
            "Status": "match"
          },
          {
            "FieldName": "Suburb",
            "Status": "match"
          },
          {
            "FieldName": "StreetType",
            "Status": "match"
          },
          {
            "FieldName": "Telephone",
            "Status": "match"
          },
          {
            "FieldName": "DayOfBirth",
            "Status": "match"
          },
          {
            "FieldName": "FirstSurName",
            "Status": "match"
          },
          {
            "FieldName": "StateProvinceCode",
            "Status": "match"
          },
          {
            "FieldName": "MonthOfBirth",
            "Status": "match"
          },
          {
            "FieldName": "PostalCode",
            "Status": "match"
          },
          {
            "FieldName": "FirstInitial",
            "Status": "match"
          },
          {
            "FieldName": "YearOfBirth",
            "Status": "match"
          },
          {
            "FieldName": "FirstGivenName",
            "Status": "match"
          },
          {
            "FieldName": "MiddleInitial",
            "Status": "match"
          }
        ],
        "AppendedFields": [],
        "Errors": [],
        "FieldGroups": []
      },
      {
        "DatasourceName": "Australia Driver Licence",
        "DatasourceFields": [
          {
            "FieldName": "DriverLicenceDayOfExpiry",
            "Status": "match"
          },
          {
            "FieldName": "FirstInitial",
            "Status": "match"
          },
          {
            "FieldName": "StreetType",
            "Status": "match"
          },
          {
            "FieldName": "DriverLicenceMonthOfExpiry",
            "Status": "match"
          },
          {
            "FieldName": "FirstGivenName",
            "Status": "match"
          },
          {
            "FieldName": "UnitNumber",
            "Status": "match"
          },
          {
            "FieldName": "DriverLicenceYearOfExpiry",
            "Status": "match"
          },
          {
            "FieldName": "FirstSurName",
            "Status": "match"
          },
          {
            "FieldName": "PostalCode",
            "Status": "match"
          },
          {
            "FieldName": "DriverLicenceNumber",
            "Status": "match"
          },
          {
            "FieldName": "DayOfBirth",
            "Status": "match"
          },
          {
            "FieldName": "StateProvinceCode",
            "Status": "match"
          },
          {
            "FieldName": "DriverLicenceState",
            "Status": "match"
          },
          {
            "FieldName": "MonthOfBirth",
            "Status": "match"
          },
          {
            "FieldName": "Suburb",
            "Status": "match"
          },
          {
            "FieldName": "StreetName",
            "Status": "match"
          },
          {
            "FieldName": "YearOfBirth",
            "Status": "match"
          },
          {
            "FieldName": "RTACardNumber",
            "Status": "match"
          },
          {
            "FieldName": "BuildingNumber",
            "Status": "match"
          }
        ],
        "AppendedFields": [],
        "Errors": [],
        "FieldGroups": []
      },
      {
        "DatasourceName": "Australia Historical File",
        "DatasourceFields": [
          {
            "FieldName": "StreetName",
            "Status": "match"
          },
          {
            "FieldName": "FirstInitial",
            "Status": "match"
          },
          {
            "FieldName": "BuildingNumber",
            "Status": "match"
          },
          {
            "FieldName": "FirstGivenName",
            "Status": "match"
          },
          {
            "FieldName": "StreetType",
            "Status": "match"
          },
          {
            "FieldName": "FirstSurName",
            "Status": "match"
          },
          {
            "FieldName": "Suburb",
            "Status": "match"
          },
          {
            "FieldName": "MiddleInitial",
            "Status": "match"
          },
          {
            "FieldName": "Telephone",
            "Status": "match"
          },
          {
            "FieldName": "MiddleName",
            "Status": "match"
          },
          {
            "FieldName": "UnitNumber",
            "Status": "match"
          },
          {
            "FieldName": "PostalCode",
            "Status": "match"
          },
          {
            "FieldName": "StateProvinceCode",
            "Status": "match"
          }
        ],
        "AppendedFields": [],
        "Errors": [],
        "FieldGroups": []
      },
      {
        "DatasourceName": "Visa Verification",
        "DatasourceFields": [
          {
            "FieldName": "YearOfBirth",
            "Status": "match"
          },
          {
            "FieldName": "PassportNumber",
            "Status": "match"
          },
          {
            "FieldName": "PassportCountry",
            "Status": "match"
          },
          {
            "FieldName": "FirstGivenName",
            "Status": "match"
          },
          {
            "FieldName": "FirstSurName",
            "Status": "match"
          },
          {
            "FieldName": "MiddleName",
            "Status": "match"
          },
          {
            "FieldName": "DayOfBirth",
            "Status": "match"
          },
          {
            "FieldName": "FirstInitial",
            "Status": "match"
          },
          {
            "FieldName": "MonthOfBirth",
            "Status": "match"
          },
          {
            "FieldName": "MiddleInitial",
            "Status": "match"
          }
        ],
        "AppendedFields": [],
        "Errors": [],
        "FieldGroups": []
      }
    ],
    "Errors": []
  },
  "Errors": []
}

Path Params

id
string
required

The TransactionRecordID from the Verify response, this will be a GUID

Response

The response structure contains the request and response for an historical Verify call. See the Verify section to understand the structure.

Your request could not be processed, there should be more details in the response.

The user name and password you provided is not valid or you are using an account not configured to be an API user.

The request took longer to process than we waited.

You asked for a media type that we do not support. You should request application/json in the Content-Type header.

An error happened on the server without a specific message.

SDKs

//Example Username: JoeNapoli_API_Demo, Example Password: 05uZuPRCyPi!6
var truliooClient = new TruliooApiClient("JoeNapoli_API_Demo", "05uZuPRCyPi!6");
TransactionRecordResult record = await truliooClient.Verification
    .GetTransactionRecordAsync("0ac8ccee-ab7a-495e-8b88-a6da1bdcb6ae");
//Example Username: JoeNapoli_API_Demo, Example Password: 05uZuPRCyPi!6
ApiClient apiClient = new ApiClient();
apiClient.setUsername("JoeNapoli_API_Demo");
apiClient.setPassword("05uZuPRCyPi!6");
VerificationsApi verificationClient = new VerificationsApi(apiClient);
//getTransactionRecord
TransactionRecordResult recordResult = verificationClient.getTransactionRecord("0ac8ccee-ab7a-495e-8b88-a6da1bdcb6ae");
//getTransactionRecordAsync
verificationClient.getTransactionRecordAsync("0ac8ccee-ab7a-495e-8b88-a6da1bdcb6ae", new ApiCallback<TransactionRecordResult>() {
    @Override
    public void onFailure(ApiException e, int statusCode, Map<String, List<String>> responseHeaders) {
        Logger.getLogger(SdkJavaV1Sample.class.getName()).log(Level.SEVERE, null, e);
    }
    @Override
    public void onSuccess(TransactionRecordResult result, int statusCode, Map<String, List<String>> responseHeaders) {
        System.out.println(result);
    }
    @Override
    public void onUploadProgress(long bytesWritten, long contentLength, boolean done) {
        //To change body of generated methods, choose Tools | Templates.
    }
    @Override
    public void onDownloadProgress(long bytesRead, long contentLength, boolean done) {
        //To change body of generated methods, choose Tools | Templates.
    }
});
Suggest Edits

Get Transaction Record (w/ Address)

Fetch the results of a verification with the TransactionRecordId for the transaction this will include additional information if your account includes address cleansing.

 

Basic Auth

 Authentication is required for this endpoint.
gethttps://api.globaldatacompany.com/verifications/v1/transactionrecord/id/withaddress
curl --request GET \
  --url https://api.globaldatacompany.com/verifications/v1/transactionrecord/id/withaddress
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.globaldatacompany.com/verifications/v1/transactionrecord/id/withaddress' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.globaldatacompany.com/verifications/v1/transactionrecord/id/withaddress");

xhr.send(data);
require 'uri'
require 'net/http'

url = URI("https://api.globaldatacompany.com/verifications/v1/transactionrecord/id/withaddress")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
import requests

url = "https://api.globaldatacompany.com/verifications/v1/transactionrecord/id/withaddress"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  "InputFields": [
    {
      "FieldName": "PostalCode",
      "Value": "3108"
    },
    {
      "FieldName": "Suburb",
      "Value": "Doncaster"
    },
    {
      "FieldName": "State",
      "Value": "Victoria"
    },
    {
      "FieldName": "YearOfBirth",
      "Value": "1983"
    },
    {
      "FieldName": "YearOfBirth",
      "Value": "1983"
    },
    {
      "FieldName": "FirstName",
      "Value": "John"
    },
    {
      "FieldName": "MiddleName",
      "Value": "Henry"
    },
    {
      "FieldName": "LastName",
      "Value": "Smith"
    },
    {
      "FieldName": "DayOfBirth",
      "Value": "5"
    },
    {
      "FieldName": "MonthOfBirth",
      "Value": "3"
    },
    {
      "FieldName": "Gender",
      "Value": "M"
    },
    {
      "FieldName": "StreetNumber",
      "Value": "10"
    },
    {
      "FieldName": "UnitNumber",
      "Value": "3"
    },
    {
      "FieldName": "StreetName",
      "Value": "Lawford"
    },
    {
      "FieldName": "StreetType",
      "Value": "st"
    },
    {
      "FieldName": "Telephone",
      "Value": "03 9896 8785"
    },
    {
      "FieldName": "EmailAddress",
      "Value": "testpersonAU@gdctest.com"
    },
    {
      "FieldName": "DriverLicenceNumber",
      "Value": "076310691"
    },
    {
      "FieldName": "DriverLicenceState",
      "Value": "VIC"
    },
    {
      "FieldName": "DayOfExpiry",
      "Value": "3"
    },
    {
      "FieldName": "MonthOfExpiry",
      "Value": "4"
    },
    {
      "FieldName": "YearOfExpiry",
      "Value": "2021"
    },
    {
      "FieldName": "PassportNumber",
      "Value": "N1236548"
    },
    {
      "FieldName": "MedicareNumber",
      "Value": "5643513953"
    },
    {
      "FieldName": "AuImmiCardNumber",
      "Value": "EIS123456"
    },
    {
      "FieldName": "CitizenshipAcquisitionDay",
      "Value": "15"
    },
    {
      "FieldName": "CitizenshipAcquisitionMonth",
      "Value": "4"
    },
    {
      "FieldName": "CitizenshipAcquisitionYear",
      "Value": "1987"
    },
    {
      "FieldName": "CountryOfBirth",
      "Value": "Australia"
    },
    {
      "FieldName": "FamilyNameAtBirth",
      "Value": "Smith"
    },
    {
      "FieldName": "MedicareColor",
      "Value": "Blue"
    },
    {
      "FieldName": "MedicareMonthOfExpiry",
      "Value": "12"
    },
    {
      "FieldName": "MedicareReference",
      "Value": "2"
    },
    {
      "FieldName": "MedicareYearOfExpiry",
      "Value": "2017"
    },
    {
      "FieldName": "PassportCountry",
      "Value": "Australia"
    },
    {
      "FieldName": "PlaceOfBirth",
      "Value": "Melbourne"
    },
    {
      "FieldName": "RegistrationNumber",
      "Value": "565659"
    },
    {
      "FieldName": "RegistrationState",
      "Value": "NSW"
    },
    {
      "FieldName": "StockNumber",
      "Value": "ACD1234567"
    },
    {
      "FieldName": "FirstInitial",
      "Value": "J"
    },
    {
      "FieldName": "MiddleInitial",
      "Value": "J"
    }
  ],
  "UploadedDt": "2017-07-11T21:47:50",
  "Record": {
    "TransactionRecordID": "0ac8ccee-ab7a-495e-8b88-a6da1bdcb6ae",
    "RecordStatus": "match",
    "DatasourceResults": [
      {
        "DatasourceName": "Australia Citizen File",
        "DatasourceFields": [
          {
            "FieldName": "BuildingNumber",
            "Status": "match"
          },
          {
            "FieldName": "MiddleName",
            "Status": "match"
          },
          {
            "FieldName": "StreetName",
            "Status": "match"
          },
          {
            "FieldName": "UnitNumber",
            "Status": "match"
          },
          {
            "FieldName": "Suburb",
            "Status": "match"
          },
          {
            "FieldName": "StreetType",
            "Status": "match"
          },
          {
            "FieldName": "Telephone",
            "Status": "match"
          },
          {
            "FieldName": "DayOfBirth",
            "Status": "match"
          },
          {
            "FieldName": "FirstSurName",
            "Status": "match"
          },
          {
            "FieldName": "StateProvinceCode",
            "Status": "match"
          },
          {
            "FieldName": "MonthOfBirth",
            "Status": "match"
          },
          {
            "FieldName": "PostalCode",
            "Status": "match"
          },
          {
            "FieldName": "FirstInitial",
            "Status": "match"
          },
          {
            "FieldName": "YearOfBirth",
            "Status": "match"
          },
          {
            "FieldName": "FirstGivenName",
            "Status": "match"
          },
          {
            "FieldName": "MiddleInitial",
            "Status": "match"
          }
        ],
        "AppendedFields": [],
        "Errors": [],
        "FieldGroups": []
      },
      {
        "DatasourceName": "Australia Driver Licence",
        "DatasourceFields": [
          {
            "FieldName": "DriverLicenceDayOfExpiry",
            "Status": "match"
          },
          {
            "FieldName": "FirstInitial",
            "Status": "match"
          },
          {
            "FieldName": "StreetType",
            "Status": "match"
          },
          {
            "FieldName": "DriverLicenceMonthOfExpiry",
            "Status": "match"
          },
          {
            "FieldName": "FirstGivenName",
            "Status": "match"
          },
          {
            "FieldName": "UnitNumber",
            "Status": "match"
          },
          {
            "FieldName": "DriverLicenceYearOfExpiry",
            "Status": "match"
          },
          {
            "FieldName": "FirstSurName",
            "Status": "match"
          },
          {
            "FieldName": "PostalCode",
            "Status": "match"
          },
          {
            "FieldName": "DriverLicenceNumber",
            "Status": "match"
          },
          {
            "FieldName": "DayOfBirth",
            "Status": "match"
          },
          {
            "FieldName": "StateProvinceCode",
            "Status": "match"
          },
          {
            "FieldName": "DriverLicenceState",
            "Status": "match"
          },
          {
            "FieldName": "MonthOfBirth",
            "Status": "match"
          },
          {
            "FieldName": "Suburb",
            "Status": "match"
          },
          {
            "FieldName": "StreetName",
            "Status": "match"
          },
          {
            "FieldName": "YearOfBirth",
            "Status": "match"
          },
          {
            "FieldName": "RTACardNumber",
            "Status": "match"
          },
          {
            "FieldName": "BuildingNumber",
            "Status": "match"
          }
        ],
        "AppendedFields": [],
        "Errors": [],
        "FieldGroups": []
      },
      {
        "DatasourceName": "Australia Historical File",
        "DatasourceFields": [
          {
            "FieldName": "StreetName",
            "Status": "match"
          },
          {
            "FieldName": "FirstInitial",
            "Status": "match"
          },
          {
            "FieldName": "BuildingNumber",
            "Status": "match"
          },
          {
            "FieldName": "FirstGivenName",
            "Status": "match"
          },
          {
            "FieldName": "StreetType",
            "Status": "match"
          },
          {
            "FieldName": "FirstSurName",
            "Status": "match"
          },
          {
            "FieldName": "Suburb",
            "Status": "match"
          },
          {
            "FieldName": "MiddleInitial",
            "Status": "match"
          },
          {
            "FieldName": "Telephone",
            "Status": "match"
          },
          {
            "FieldName": "MiddleName",
            "Status": "match"
          },
          {
            "FieldName": "UnitNumber",
            "Status": "match"
          },
          {
            "FieldName": "PostalCode",
            "Status": "match"
          },
          {
            "FieldName": "StateProvinceCode",
            "Status": "match"
          }
        ],
        "AppendedFields": [],
        "Errors": [],
        "FieldGroups": []
      },
      {
        "DatasourceName": "Visa Verification",
        "DatasourceFields": [
          {
            "FieldName": "YearOfBirth",
            "Status": "match"
          },
          {
            "FieldName": "PassportNumber",
            "Status": "match"
          },
          {
            "FieldName": "PassportCountry",
            "Status": "match"
          },
          {
            "FieldName": "FirstGivenName",
            "Status": "match"
          },
          {
            "FieldName": "FirstSurName",
            "Status": "match"
          },
          {
            "FieldName": "MiddleName",
            "Status": "match"
          },
          {
            "FieldName": "DayOfBirth",
            "Status": "match"
          },
          {
            "FieldName": "FirstInitial",
            "Status": "match"
          },
          {
            "FieldName": "MonthOfBirth",
            "Status": "match"
          },
          {
            "FieldName": "MiddleInitial",
            "Status": "match"
          }
        ],
        "AppendedFields": [],
        "Errors": [],
        "FieldGroups": []
      }
    ],
    "Errors": []
  },
  "Errors": []
}

Path Params

id
string
required

The TransactionRecordID from the Verify response, this will be a GUID

Response

The response structure contains the request and response for an historical Verify call. See the Verify section to understand the structure.

Your request could not be processed, there should be more details in the response.

The user name and password you provided is not valid or you are using an account not configured to be an API user.

The request took longer to process than we waited.

You asked for a media type that we do not support. You should request application/json in the Content-Type header.

An error happened on the server without a specific message.

SDKs

//Example Username: JoeNapoli_API_Demo, Example Password: 05uZuPRCyPi!6
var truliooClient = new TruliooApiClient("JoeNapoli_API_Demo", "05uZuPRCyPi!6");
TransactionRecordResult record = await truliooClient.Verification
    .GetTransactionRecordAddressAsync( "0ac8ccee-ab7a-495e-8b88-a6da1bdcb6ae" );
//Example Username: JoeNapoli_API_Demo, Example Password: 05uZuPRCyPi!6
ApiClient apiClient = new ApiClient();
apiClient.setUsername("JoeNapoli_API_Demo");
apiClient.setPassword("05uZuPRCyPi!6");
VerificationsApi verificationClient = new VerificationsApi(apiClient);
//getTransactionRecordAddress
TransactionRecordResult recordResult = verificationClient.getTransactionRecordAddress("0ac8ccee-ab7a-495e-8b88-a6da1bdcb6ae");
//getTransactionRecordAddressAsync
verificationClient.getTransactionRecordAddressAsync("0ac8ccee-ab7a-495e-8b88-a6da1bdcb6ae", new ApiCallback<TransactionRecordResult>() {
    @Override
    public void onFailure(ApiException e, int statusCode, Map<String, List<String>> responseHeaders) {
        Logger.getLogger(SdkJavaV1Sample.class.getName()).log(Level.SEVERE, null, e);
    }
    @Override
    public void onSuccess(TransactionRecordResult result, int statusCode, Map<String, List<String>> responseHeaders) {
        System.out.println(result);
    }
    @Override
    public void onUploadProgress(long bytesWritten, long contentLength, boolean done) {
        //To change body of generated methods, choose Tools | Templates.
    }
    @Override
    public void onDownloadProgress(long bytesRead, long contentLength, boolean done) {
        //To change body of generated methods, choose Tools | Templates.
    }
});
Suggest Edits

Get Transaction Record Verbose

Fetch the results of a verification with the TransactionRecordId for the transaction this will include additional information if your account includes address cleansing and watchlist details.

 

Basic Auth

 Authentication is required for this endpoint.
gethttps://api.globaldatacompany.com/verifications/v1/transactionrecord/id/verbose
curl --request GET \
  --url https://api.globaldatacompany.com/verifications/v1/transactionrecord/id/verbose
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.globaldatacompany.com/verifications/v1/transactionrecord/id/verbose' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.globaldatacompany.com/verifications/v1/transactionrecord/id/verbose");

xhr.send(data);
require 'uri'
require 'net/http'

url = URI("https://api.globaldatacompany.com/verifications/v1/transactionrecord/id/verbose")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
import requests

url = "https://api.globaldatacompany.com/verifications/v1/transactionrecord/id/verbose"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  "InputFields": [
    {
      "FieldName": "PostalCode",
      "Value": "3108"
    },
    {
      "FieldName": "Suburb",
      "Value": "Doncaster"
    },
    {
      "FieldName": "State",
      "Value": "Victoria"
    },
    {
      "FieldName": "YearOfBirth",
      "Value": "1983"
    },
    {
      "FieldName": "YearOfBirth",
      "Value": "1983"
    },
    {
      "FieldName": "FirstName",
      "Value": "John"
    },
    {
      "FieldName": "MiddleName",
      "Value": "Henry"
    },
    {
      "FieldName": "LastName",
      "Value": "Smith"
    },
    {
      "FieldName": "DayOfBirth",
      "Value": "5"
    },
    {
      "FieldName": "MonthOfBirth",
      "Value": "3"
    },
    {
      "FieldName": "Gender",
      "Value": "M"
    },
    {
      "FieldName": "StreetNumber",
      "Value": "10"
    },
    {
      "FieldName": "UnitNumber",
      "Value": "3"
    },
    {
      "FieldName": "StreetName",
      "Value": "Lawford"
    },
    {
      "FieldName": "StreetType",
      "Value": "st"
    },
    {
      "FieldName": "Telephone",
      "Value": "03 9896 8785"
    },
    {
      "FieldName": "EmailAddress",
      "Value": "testpersonAU@gdctest.com"
    },
    {
      "FieldName": "DriverLicenceNumber",
      "Value": "076310691"
    },
    {
      "FieldName": "DriverLicenceState",
      "Value": "VIC"
    },
    {
      "FieldName": "DayOfExpiry",
      "Value": "3"
    },
    {
      "FieldName": "MonthOfExpiry",
      "Value": "4"
    },
    {
      "FieldName": "YearOfExpiry",
      "Value": "2021"
    },
    {
      "FieldName": "PassportNumber",
      "Value": "N1236548"
    },
    {
      "FieldName": "MedicareNumber",
      "Value": "5643513953"
    },
    {
      "FieldName": "AuImmiCardNumber",
      "Value": "EIS123456"
    },
    {
      "FieldName": "CitizenshipAcquisitionDay",
      "Value": "15"
    },
    {
      "FieldName": "CitizenshipAcquisitionMonth",
      "Value": "4"
    },
    {
      "FieldName": "CitizenshipAcquisitionYear",
      "Value": "1987"
    },
    {
      "FieldName": "CountryOfBirth",
      "Value": "Australia"
    },
    {
      "FieldName": "FamilyNameAtBirth",
      "Value": "Smith"
    },
    {
      "FieldName": "MedicareColor",
      "Value": "Blue"
    },
    {
      "FieldName": "MedicareMonthOfExpiry",
      "Value": "12"
    },
    {
      "FieldName": "MedicareReference",
      "Value": "2"
    },
    {
      "FieldName": "MedicareYearOfExpiry",
      "Value": "2017"
    },
    {
      "FieldName": "PassportCountry",
      "Value": "Australia"
    },
    {
      "FieldName": "PlaceOfBirth",
      "Value": "Melbourne"
    },
    {
      "FieldName": "RegistrationNumber",
      "Value": "565659"
    },
    {
      "FieldName": "RegistrationState",
      "Value": "NSW"
    },
    {
      "FieldName": "StockNumber",
      "Value": "ACD1234567"
    },
    {
      "FieldName": "FirstInitial",
      "Value": "J"
    },
    {
      "FieldName": "MiddleInitial",
      "Value": "J"
    }
  ],
  "UploadedDt": "2017-07-11T21:47:50",
  "Record": {
    "TransactionRecordID": "0ac8ccee-ab7a-495e-8b88-a6da1bdcb6ae",
    "RecordStatus": "match",
    "DatasourceResults": [
      {
        "DatasourceName": "Australia Citizen File",
        "DatasourceFields": [
          {
            "FieldName": "BuildingNumber",
            "Status": "match"
          },
          {
            "FieldName": "MiddleName",
            "Status": "match"
          },
          {
            "FieldName": "StreetName",
            "Status": "match"
          },
          {
            "FieldName": "UnitNumber",
            "Status": "match"
          },
          {
            "FieldName": "Suburb",
            "Status": "match"
          },
          {
            "FieldName": "StreetType",
            "Status": "match"
          },
          {
            "FieldName": "Telephone",
            "Status": "match"
          },
          {
            "FieldName": "DayOfBirth",
            "Status": "match"
          },
          {
            "FieldName": "FirstSurName",
            "Status": "match"
          },
          {
            "FieldName": "StateProvinceCode",
            "Status": "match"
          },
          {
            "FieldName": "MonthOfBirth",
            "Status": "match"
          },
          {
            "FieldName": "PostalCode",
            "Status": "match"
          },
          {
            "FieldName": "FirstInitial",
            "Status": "match"
          },
          {
            "FieldName": "YearOfBirth",
            "Status": "match"
          },
          {
            "FieldName": "FirstGivenName",
            "Status": "match"
          },
          {
            "FieldName": "MiddleInitial",
            "Status": "match"
          }
        ],
        "AppendedFields": [],
        "Errors": [],
        "FieldGroups": []
      },
      {
        "DatasourceName": "Australia Driver Licence",
        "DatasourceFields": [
          {
            "FieldName": "DriverLicenceDayOfExpiry",
            "Status": "match"
          },
          {
            "FieldName": "FirstInitial",
            "Status": "match"
          },
          {
            "FieldName": "StreetType",
            "Status": "match"
          },
          {
            "FieldName": "DriverLicenceMonthOfExpiry",
            "Status": "match"
          },
          {
            "FieldName": "FirstGivenName",
            "Status": "match"
          },
          {
            "FieldName": "UnitNumber",
            "Status": "match"
          },
          {
            "FieldName": "DriverLicenceYearOfExpiry",
            "Status": "match"
          },
          {
            "FieldName": "FirstSurName",
            "Status": "match"
          },
          {
            "FieldName": "PostalCode",
            "Status": "match"
          },
          {
            "FieldName": "DriverLicenceNumber",
            "Status": "match"
          },
          {
            "FieldName": "DayOfBirth",
            "Status": "match"
          },
          {
            "FieldName": "StateProvinceCode",
            "Status": "match"
          },
          {
            "FieldName": "DriverLicenceState",
            "Status": "match"
          },
          {
            "FieldName": "MonthOfBirth",
            "Status": "match"
          },
          {
            "FieldName": "Suburb",
            "Status": "match"
          },
          {
            "FieldName": "StreetName",
            "Status": "match"
          },
          {
            "FieldName": "YearOfBirth",
            "Status": "match"
          },
          {
            "FieldName": "RTACardNumber",
            "Status": "match"
          },
          {
            "FieldName": "BuildingNumber",
            "Status": "match"
          }
        ],
        "AppendedFields": [],
        "Errors": [],
        "FieldGroups": []
      },
      {
        "DatasourceName": "Australia Historical File",
        "DatasourceFields": [
          {
            "FieldName": "StreetName",
            "Status": "match"
          },
          {
            "FieldName": "FirstInitial",
            "Status": "match"
          },
          {
            "FieldName": "BuildingNumber",
            "Status": "match"
          },
          {
            "FieldName": "FirstGivenName",
            "Status": "match"
          },
          {
            "FieldName": "StreetType",
            "Status": "match"
          },
          {
            "FieldName": "FirstSurName",
            "Status": "match"
          },
          {
            "FieldName": "Suburb",
            "Status": "match"
          },
          {
            "FieldName": "MiddleInitial",
            "Status": "match"
          },
          {
            "FieldName": "Telephone",
            "Status": "match"
          },
          {
            "FieldName": "MiddleName",
            "Status": "match"
          },
          {
            "FieldName": "UnitNumber",
            "Status": "match"
          },
          {
            "FieldName": "PostalCode",
            "Status": "match"
          },
          {
            "FieldName": "StateProvinceCode",
            "Status": "match"
          }
        ],
        "AppendedFields": [],
        "Errors": [],
        "FieldGroups": []
      },
      {
        "DatasourceName": "Visa Verification",
        "DatasourceFields": [
          {
            "FieldName": "YearOfBirth",
            "Status": "match"
          },
          {
            "FieldName": "PassportNumber",
            "Status": "match"
          },
          {
            "FieldName": "PassportCountry",
            "Status": "match"
          },
          {
            "FieldName": "FirstGivenName",
            "Status": "match"
          },
          {
            "FieldName": "FirstSurName",
            "Status": "match"
          },
          {
            "FieldName": "MiddleName",
            "Status": "match"
          },
          {
            "FieldName": "DayOfBirth",
            "Status": "match"
          },
          {
            "FieldName": "FirstInitial",
            "Status": "match"
          },
          {
            "FieldName": "MonthOfBirth",
            "Status": "match"
          },
          {
            "FieldName": "MiddleInitial",
            "Status": "match"
          }
        ],
        "AppendedFields": [],
        "Errors": [],
        "FieldGroups": []
      }
    ],
    "Errors": []
  },
  "Errors": []
}

Path Params

id
string
required

The TransactionRecordID from the Verify response, this will be a GUID

Response

The response structure contains the request and response for an historical Verify call. See the Verify section to understand the structure.

Your request could not be processed, there should be more details in the response.

The user name and password you provided is not valid or you are using an account not configured to be an API user.

The request took longer to process than we waited.

You asked for a media type that we do not support. You should request application/json in the Content-Type header.

An error happened on the server without a specific message.

SDKs

Coming Soon...
//Example Username: JoeNapoli_API_Demo, Example Password: 05uZuPRCyPi!6
ApiClient apiClient = new ApiClient();
apiClient.setUsername("JoeNapoli_API_Demo");
apiClient.setPassword("05uZuPRCyPi!6");
VerificationsApi verificationClient = new VerificationsApi(apiClient);
//getTransactionRecordVerbose
TransactionRecordResult recordResult = verificationClient.getTransactionRecordVerbose("0ac8ccee-ab7a-495e-8b88-a6da1bdcb6ae");
//getTransactionRecordVerboseAsync
verificationClient.getTransactionRecordVerboseAsync("0ac8ccee-ab7a-495e-8b88-a6da1bdcb6ae", new ApiCallback<TransactionRecordResult>() {
    @Override
    public void onFailure(ApiException e, int statusCode, Map<String, List<String>> responseHeaders) {
        Logger.getLogger(SdkJavaV1Sample.class.getName()).log(Level.SEVERE, null, e);
    }
    @Override
    public void onSuccess(TransactionRecordResult result, int statusCode, Map<String, List<String>> responseHeaders) {
        System.out.println(result);
    }
    @Override
    public void onUploadProgress(long bytesWritten, long contentLength, boolean done) {
        //To change body of generated methods, choose Tools | Templates.
    }
    @Override
    public void onDownloadProgress(long bytesRead, long contentLength, boolean done) {
        //To change body of generated methods, choose Tools | Templates.
    }
});
Suggest Edits

Get Transaction Status

This method is used to retrieve the processing status of an asynchronous transaction. The response for this method includes the processing status of the verification, the TransactionID, the TransactionRecordID as well as whether the verification request has timed out.
This should only be used by customers who cannot listen to transaction status updates on the call back URL provided.
It is also recommended that this endpoint should be used for Document Verification and Business Verification as Identity Verification transactions should be synchronous requests.

 

Basic Auth

 Authentication is required for this endpoint.
gethttps://api.globaldatacompany.com/verifications/v1/transaction/id/status
curl --request GET \
  --url https://api.globaldatacompany.com/verifications/v1/transaction/id/status
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.globaldatacompany.com/verifications/v1/transaction/id/status' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.globaldatacompany.com/verifications/v1/transaction/id/status");

xhr.send(data);
require 'uri'
require 'net/http'

url = URI("https://api.globaldatacompany.com/verifications/v1/transaction/id/status")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
import requests

url = "https://api.globaldatacompany.com/verifications/v1/transaction/id/status"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  "TransactionId": "111-2222-333-4444-5555",
  "TransactionRecordId": "6666-7777-8888-99999",
  "Status": "InProgress",
  "UploadedDt": "2017-07-11T21:47:50",
  "IsTimedOut": false
}

Path Params

id
string
required

id of the asynchronous transaction, this will be a GUID.

Response

OK

TransactionIdstring

Transaction ID of the transaction

TransactionRecordIdstring

Transaction Record ID of the transaction available once the transaction has finished processing

Statusstring

Status of the transaction. Possible Values: Uploading, Processing, Completed, InProgress, Failed, WaitAsync, ToBeResumed, Canceled, TimeoutCanceled. Call GetTransactionRecord when status changes to Completed, Failed, Canceled or TimeoutCanceled to get the verification results.

UploadedDtstring

Uploaded date for transaction

IsTimedOutboolean

Set to true when transaction has timed out

Your request could not be processed, there should be more details in the response.

The user name and password you provided is not valid or you are using an account not configured to be an API user.

The request took longer to process than we waited.

You asked for a media type that we do not support. You should request application/json in the Content-Type header.

An error happened on the server without a specific message.

Suggest Edits

Verifications

 
Suggest Edits

Verify

Calling this method will perform a verification. If your account includes address cleansing set the CleansedAddress flag to get
additional address information in the result. You can query configuration to get what fields are available to you in each each country.
It is also possible to get sample requests from the customer portal.

Sandbox Accounts

If you are configured for a sandbox account make sure to call Get Test Entities to get test data for a country you want to try. Sandbox accounts only use these test entities and so trying to verify with any other data will result in no matches being found.

 

Basic Auth

 Authentication is required for this endpoint.
posthttps://api.globaldatacompany.com/verifications/v1/verify
curl --request POST \
  --url https://api.globaldatacompany.com/verifications/v1/verify
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.globaldatacompany.com/verifications/v1/verify' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.globaldatacompany.com/verifications/v1/verify");

xhr.send(data);
require 'uri'
require 'net/http'

url = URI("https://api.globaldatacompany.com/verifications/v1/verify")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
import requests

url = "https://api.globaldatacompany.com/verifications/v1/verify"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  "TransactionID": "d3e5d20c-3ad7-448d-9034-b28c68d6db07",
  "UploadedDt": "2017-07-11T21:47:50",
  "CustomerReferenceID": "abc-1234",
  "Record": {
    "TransactionRecordID": "0ac8ccee-ab7a-495e-8b88-a6da1bdcb6ae",
    "RecordStatus": "match",
    "DatasourceResults": [
      {
        "DatasourceName": "Australia Citizen File",
        "DatasourceFields": [
          {
            "FieldName": "BuildingNumber",
            "Status": "match"
          },
          {
            "FieldName": "MiddleName",
            "Status": "match"
          },
          {
            "FieldName": "StreetName",
            "Status": "match"
          },
          {
            "FieldName": "UnitNumber",
            "Status": "match"
          },
          {
            "FieldName": "Suburb",
            "Status": "match"
          },
          {
            "FieldName": "StreetType",
            "Status": "match"
          },
          {
            "FieldName": "Telephone",
            "Status": "match"
          },
          {
            "FieldName": "DayOfBirth",
            "Status": "match"
          },
          {
            "FieldName": "FirstSurName",
            "Status": "match"
          },
          {
            "FieldName": "StateProvinceCode",
            "Status": "match"
          },
          {
            "FieldName": "MonthOfBirth",
            "Status": "match"
          },
          {
            "FieldName": "PostalCode",
            "Status": "match"
          },
          {
            "FieldName": "FirstInitial",
            "Status": "match"
          },
          {
            "FieldName": "YearOfBirth",
            "Status": "match"
          },
          {
            "FieldName": "FirstGivenName",
            "Status": "match"
          },
          {
            "FieldName": "MiddleInitial",
            "Status": "match"
          }
        ],
        "AppendedFields": [],
        "Errors": [],
        "FieldGroups": []
      },
      {
        "DatasourceName": "Australia Driver Licence",
        "DatasourceFields": [
          {
            "FieldName": "DriverLicenceDayOfExpiry",
            "Status": "match"
          },
          {
            "FieldName": "FirstInitial",
            "Status": "match"
          },
          {
            "FieldName": "StreetType",
            "Status": "match"
          },
          {
            "FieldName": "DriverLicenceMonthOfExpiry",
            "Status": "match"
          },
          {
            "FieldName": "FirstGivenName",
            "Status": "match"
          },
          {
            "FieldName": "UnitNumber",
            "Status": "match"
          },
          {
            "FieldName": "DriverLicenceYearOfExpiry",
            "Status": "match"
          },
          {
            "FieldName": "FirstSurName",
            "Status": "match"
          },
          {
            "FieldName": "PostalCode",
            "Status": "match"
          },
          {
            "FieldName": "DriverLicenceNumber",
            "Status": "match"
          },
          {
            "FieldName": "DayOfBirth",
            "Status": "match"
          },
          {
            "FieldName": "StateProvinceCode",
            "Status": "match"
          },
          {
            "FieldName": "DriverLicenceState",
            "Status": "match"
          },
          {
            "FieldName": "MonthOfBirth",
            "Status": "match"
          },
          {
            "FieldName": "Suburb",
            "Status": "match"
          },
          {
            "FieldName": "StreetName",
            "Status": "match"
          },
          {
            "FieldName": "YearOfBirth",
            "Status": "match"
          },
          {
            "FieldName": "RTACardNumber",
            "Status": "match"
          },
          {
            "FieldName": "BuildingNumber",
            "Status": "match"
          }
        ],
        "AppendedFields": [],
        "Errors": [],
        "FieldGroups": []
      },
      {
        "DatasourceName": "Australia Historical File",
        "DatasourceFields": [
          {
            "FieldName": "StreetName",
            "Status": "match"
          },
          {
            "FieldName": "FirstInitial",
            "Status": "match"
          },
          {
            "FieldName": "BuildingNumber",
            "Status": "match"
          },
          {
            "FieldName": "FirstGivenName",
            "Status": "match"
          },
          {
            "FieldName": "StreetType",
            "Status": "match"
          },
          {
            "FieldName": "FirstSurName",
            "Status": "match"
          },
          {
            "FieldName": "Suburb",
            "Status": "match"
          },
          {
            "FieldName": "MiddleInitial",
            "Status": "match"
          },
          {
            "FieldName": "Telephone",
            "Status": "match"
          },
          {
            "FieldName": "MiddleName",
            "Status": "match"
          },
          {
            "FieldName": "UnitNumber",
            "Status": "match"
          },
          {
            "FieldName": "PostalCode",
            "Status": "match"
          },
          {
            "FieldName": "StateProvinceCode",
            "Status": "match"
          }
        ],
        "AppendedFields": [],
        "Errors": [],
        "FieldGroups": []
      },
      {
        "DatasourceName": "Visa Verification",
        "DatasourceFields": [
          {
            "FieldName": "YearOfBirth",
            "Status": "match"
          },
          {
            "FieldName": "PassportNumber",
            "Status": "match"
          },
          {
            "FieldName": "PassportCountry",
            "Status": "match"
          },
          {
            "FieldName": "FirstGivenName",
            "Status": "match"
          },
          {
            "FieldName": "FirstSurName",
            "Status": "match"
          },
          {
            "FieldName": "MiddleName",
            "Status": "match"
          },
          {
            "FieldName": "DayOfBirth",
            "Status": "match"
          },
          {
            "FieldName": "FirstInitial",
            "Status": "match"
          },
          {
            "FieldName": "MonthOfBirth",
            "Status": "match"
          },
          {
            "FieldName": "MiddleInitial",
            "Status": "match"
          }
        ],
        "AppendedFields": [],
        "Errors": [],
        "FieldGroups": []
      }
    ],
    "Errors": [],
    "Rule": {
      "RuleName": "Category 3 KYC v3",
      "Note": "Match(FamilyAndGivenInitial, DOB) or Match(FamilyAndGivenInitial, FullAddress) or Match(FamilyAndGivenInitial, ID) MiddleName Ignored"
    }
  },
  "Errors": []
}

Body Params

AcceptTruliooTermsAndConditions
boolean

Indicate that Trulioo terms and conditions are accepted.
The Verification request will be executed only if the value of this header is passed as 'true'.

CallBackUrl
string

If set, the transaction will run asyncronously and trulioo will try to update the client with transaction state updates until completed.

Timeout
int32

If set, trulioo will try to update the client syncronously within the timeout in seconds. If failed to accomplish, the transaction will be canceled.

CleansedAddress
boolean

Set to true if you want to receive address cleanse information. This will only change the response if you have address cleansing enabled for the country you are querying for.

ConfigurationName
string

Indicate the configuration used for the verification. Currently only 'Identity Verification' is supported.
Default value will be "Identity Verification"

ConsentForDataSources
array of strings

Some datasources require your customer provide consent to access them. For each datasource that requires consent, send the requred string if your customer has provided it. A list of these required strings for a country can be gotten by the Get Consents call. If consent is not provided the datasource will not be queried.

CountryCode
string
required

Country alpha2 code. Call Get Country Codes to get the countries available to you.

CustomerReferenceID
string

Use this field to send any internal reference ID to Global Gateway. It will be contained in the response so it is simple to link Trulioo's API to your system.

DataFields
object
required

The data field name-value pairs for the data elements on which the verification is to be performed

 
DataFields.PersonInfo
object

Personal Information.

 
DataFields.PersonInfo.FirstGivenName
string

First name of the individual to be verified. Dual purpose First Name or Initial.

DataFields.PersonInfo.MiddleName
string

Second given name of the individual to be verified. Dual purpose Middle Name or Initial.

DataFields.PersonInfo.FirstSurName
string

First (paternal) family name of the individual to be verified.

DataFields.PersonInfo.SecondSurname
string

Second family name of the individual to be verified.

DataFields.PersonInfo.ISOLatin1Name
string

Enter full name in ISO Latin-1 character set. Used for data sources that require the person’s name in ISO Latin-1 format (i.e. as Passport MRZ).

DataFields.PersonInfo.DayOfBirth
int32

Day of birth date (i.e. 23 for a date of birth of 23/11/1975).

DataFields.PersonInfo.MonthOfBirth
int32

Month of birth date (i.e. 11 for a date of birth of 23/11/1975).

DataFields.PersonInfo.YearOfBirth
int32

Year of birth date (i.e. 1975 for a date of birth of 23/11/1975).

DataFields.PersonInfo.MinimumAge
int32

Minimum permitted age of the individual. GlobalGateway calculates age of individual and compares it to this number.

DataFields.PersonInfo.Gender
string

Single character M / F (M = Male, F = Female).

DataFields.PersonInfo.AdditionalFields
object
 
DataFields.PersonInfo.AdditionalFields.FullName
string

Full name of of the individual to be verified.

DataFields.Location
object

Location Information.

 
DataFields.Location.BuildingNumber
string

House / Civic / Building number of home address.

DataFields.Location.BuildingName
string

Name of building of home address.

DataFields.Location.UnitNumber
string

Flat/Unit/Apartment number of home address.

DataFields.Location.StreetName
string

Street name of home address.

DataFields.Location.StreetType
string

Street type of home address (Typically St, Rd etc).

DataFields.Location.City
string

City of home address.

DataFields.Location.Suburb
string

Suburb / Subdivision / Municipality of home address.

DataFields.Location.County
string

County / District of home address.

DataFields.Location.StateProvinceCode
string

State of home address. US sources expect 2 characters. Australian sources expect 2 or 3 characters. Can be gotten using the Get Country Subdivisions call.

DataFields.Location.Country
string

Country of home address (ISO 3166-1 alpha-2 code).

DataFields.Location.PostalCode
string

ZIP Code or Postal Code of home address.

DataFields.Location.POBox
string

Post Office Box.

DataFields.Location.AdditionalFields
object

Fields not normally used.

 
DataFields.Location.AdditionalFields.Address1
string

Address1 is available in certain countries. It can be used to pass a compiled address field instead of sending individual address attributes (such as UnitNumber, BuidlingNumber, BuildingName, StreetName and StreetType).
GlobalGateway will provide a pass through of Address1 directly to connected datasources for the selected country.
Please note: each datasource requires the address fields to be configured in a certain manner, implementing and sending Address1 instead of individual address fields may affect your ability to verify this address.

DataFields.Communication
object

Communication Information.

 
DataFields.Communication.MobileNumber
string

Mobile phone number of the individual to be verified.

DataFields.Communication.Telephone
string

Telephone number of the individual to be verified.

DataFields.Communication.Telephone2
string

Additional Phone/Mobile Number of the individual to be verified.

DataFields.Communication.EmailAddress
string

Email address of the individual to be verified.

DataFields.DriverLicence
object

Driver Licence Information.

 
DataFields.DriverLicence.Number
string

Driver's Licence Number of the individual to be verified.

DataFields.DriverLicence.State
string

State of issue for driver's Licence.

DataFields.DriverLicence.DayOfExpiry
int32

Driver's Licence day of expiry of the individual to be verified.

DataFields.DriverLicence.MonthOfExpiry
int32

Driver's Licence month of expiry of the individual to be verified.

DataFields.DriverLicence.YearOfExpiry
int32

Driver's Licence year of expiry of the individual to be verified.

DataFields.NationalIds
array of objects

National Identification Information.
Supported Types: NationalID, Health, SocialService, TaxIDNumber.

Number
Type
DistrictOfIssue
CityOfIssue
ProvinceOfIssue
CountyOfIssue
DataFields.Passport
object

Passport information.

 
DataFields.Passport.Mrz1
string

Line 1 of the passport MRZ.

DataFields.Passport.Mrz2
string

Line 2 of the passport MRZ.

DataFields.Passport.Number
string

Passport Number.

DataFields.Passport.DayOfExpiry
int32

Passport's Licence day of expiry of the individual to be verified.

DataFields.Passport.MonthOfExpiry
int32

Passport's Licence month of expiry of the individual to be verified.

DataFields.Passport.YearOfExpiry
int32

Passport's Licence year of expiry of the individual to be verified.

DataFields.CountrySpecific
object

CountrySpecific fields
{"CountryCode" : {"Field1" : "Value", "Field2" : "Value"}}
Call Get Fields to get the list of fields that are valid for your configuration.

 
VerboseMode
boolean

Verbose Mode Output Flag.

Response

OK

TransactionIDstring

The id for the transaction it will be a GUID.

UploadedDtstring

Time in UTC.

CountryCodestring

Country Code.

ProductNamestring

Product Name.

Recordobject
Record.TransactionRecordIDstring

The TransactionRecordID, this is the ID you will use to fetch the transaction again.

Record.RecordStatusstring

'match' or 'nomatch' if the verification passed the rules configured on your account this will be 'match'.

Record.DatasourceResultsarray

Results for each datasource that was queried.

Record.Errorsarray
Record.Ruleobject

Rule used for record.

Record.Rule.RuleNamestring

Name of RecordRule.

Record.Rule.Notestring

Rule Description.

CustomerReferenceIDstring

Customer Reference Id

Errorsarray

See Errors for explanation of any error encountered.

Your request could not be processed, there should be more details in the response.

The user name and password you provided is not valid or you are using an account not configured to be an API user.

The request took longer to process than we waited.

You asked for a media type that we do not support. You should request application/json in the Content-Type header.

An error happened on the server without a specific message.

SDKs

//Example Username: JoeNapoli_API_Demo, Example Password: 05uZuPRCyPi!6
var truliooClient = new TruliooApiClient("JoeNapoli_API_Demo", "05uZuPRCyPi!6");
VerifyRequest request = new VerifyRequest()
{
    AcceptTruliooTermsAndConditions = true,
    Demo = true,
    CleansedAddress = false,
    ConfigurationName = "Identity Verification",
    ConsentForDataSources = new string[]
        {
            "Australia Driver License",
            "Australia Passport",
            "Birth Registry",
            "Visa Verification",
            "DVS Driver License Search",
            "DVS Medicare Search",
            "DVS Passport Search",
            "DVS Visa Search",
            "DVS ImmiCard Search",
            "DVS Citizenship Certificate Search",
            "DVS Certificate of Registration by Descent Search",
            "Credit Agency"
        },
    CountryCode = "AU",
    DataFields = new DataFields()
    {
        PersonInfo = new PersonInfo()
        {
            FirstGivenName = "John",
            MiddleName = "Henry",
            FirstSurName = "Smith",
            DayOfBirth = 5,
            MonthOfBirth = 3,
            YearOfBirth = 1983,
            Gender = "M"
        },
        Location = new Location()
        {
            BuildingNumber = "10",
            UnitNumber = "3",
            StreetName = "Lawford",
            StreetType = "st",
            Suburb = "Doncaster",
            StateProvinceCode = "VIC",
            PostalCode = "3108"
        },
        Communication = new Communication()
        {
            Telephone = "03 9896 8785",
            EmailAddress = "testpersonAU@gdctest.com"
        },
        DriverLicence = new DriverLicence()
        {
            Number = "076310691",
            State = "VIC",
            DayOfExpiry = 3,
            MonthOfExpiry = 4,
            YearOfExpiry = 2021
        },
        NationalIds = new NationalId[]
        {
            new NationalId()
            {
                Number = "5643513953",
                Type = "Health"
            }
        },
        Passport = new Passport()
        {
            Mrz1 = "P<SAGSMITH<<JOHN<HENRY<<<<<<<<<<<<<<<<<<<<<<",
            Mrz2 = "N1236548<1AUS8303052359438740809<<<<<<<<<<54",
            Number = "N1236548",
            DayOfExpiry = 5,
            MonthOfExpiry = 12,
            YearOfExpiry = 2018
        },
        CountrySpecific = new CountrySpecific()
        {
            { "AU",
                new Dictionary<string, string>()
                {
                    { "AuImmiCardNumber", "EIS123456" },
                    { "CitizenshipAcquisitionDay", "15" },
                    { "CitizenshipAcquisitionMonth", "4" },
                    { "CitizenshipAcquisitionYear", "1987" },
                    { "CountryOfBirth", "Australia" },
                    { "FamilyNameAtBirth", "Smith" },
                    { "MedicareColor", "Blue" },
                    { "MedicareMonthOfExpiry", "12" },
                    { "MedicareReference", "2" },
                    { "MedicareYearOfExpiry", "2017" },
                    { "PassportCountry", "Australia" },
                    { "PlaceOfBirth", "Melbourne" },
                    { "RegistrationNumber", "565659" },
                    { "RegistrationState", "NSW" },
                    { "StockNumber", "ACD1234567" }
                }
            }
        }
    }
};
            
VerifyResult result = await truliooClient.Verification
    .VerifyAsync(request);
//Example Username: JoeNapoli_API_Demo, Example Password: 05uZuPRCyPi!6
ApiClient apiClient = new ApiClient();
apiClient.setUsername("JoeNapoli_API_Demo");
apiClient.setPassword("05uZuPRCyPi!6");
VerificationsApi verificationClient = new VerificationsApi(apiClient);
VerifyRequest request = new VerifyRequest()
    .acceptTruliooTermsAndConditions(Boolean.TRUE)
    .demo(true)
    .cleansedAddress(false)
    .configurationName("Identity Verification")
    .countryCode("AU")
    .consentForDataSources(new ArrayList<>(Arrays.asList(
        "Australia Driver License",
        "Australia Passport",
        "Birth Registry",
        "Visa Verification",
        "DVS Driver License Search",
        "DVS Medicare Search",
        "DVS Passport Search",
        "DVS Visa Search",
        "DVS ImmiCard Search",
        "DVS Citizenship Certificate Search",
        "DVS Certificate of Registration by Descent Search",
        "Credit Agency")))
    .dataFields(new DataFields()
        .personInfo(new PersonInfo()
            .firstGivenName("John")
            .middleName("Henry")
            .firstSurName("Smith")
            .yearOfBirth(1983)
            .monthOfBirth(3)
            .dayOfBirth(5)
            .gender("M"))
        .location(new Location()
            .postalCode("3108")
            .buildingNumber("10")
            .unitNumber("3")
            .streetName("Lawford")
            .streetType("st")
            .suburb("Doncaster")
            .stateProvinceCode("VIC")
            .city("Vancouver"))
        .communication(new Communication()
            .telephone("03 9896 8785")
            .emailAddress("testpersonAU@gdctest.com"))
            .driverLicence(new DriverLicence()
            .number("076310691")
            .state("VIC")
            .dayOfExpiry(3)
            .monthOfExpiry(4)
            .yearOfExpiry(2021))
        .nationalIds(Arrays.asList(new NationalId()
            .number("5643513953")
            .type("Health")))
        .passport(new Passport()
            .mrz1("P<SAGSMITH<<JOHN<HENRY<<<<<<<<<<<<<<<<<<<<<<")
            .mrz2("N1236548<1AUS8303052359438740809<<<<<<<<<<54")
            .number("N1236548")
            .dayOfExpiry(5)
            .monthOfExpiry(12)
            .yearOfExpiry(2018))
        .countrySpecific(new HashMap<String, Map<String, String>>(){{
            put("AU", new HashMap<String, String>(){{
                put("AuImmiCardNumber", "EIS123456");
                put("CitizenshipAcquisitionDay", "15");
                put("CitizenshipAcquisitionMonth", "4");
                put("CitizenshipAcquisitionYear", "1987");
                put("CountryOfBirth", "Australia");
                put("FamilyNameAtBirth", "Smith");
                put("MedicareColor", "Blue");
                put("MedicareMonthOfExpiry", "12");
                put("MedicareReference", "2");
                put("MedicareYearOfExpiry", "2017");
                put("PassportCountry", "Australia");
                put("PlaceOfBirth", "Melbourne");
                put("RegistrationNumber", "565659");
                put("RegistrationState", "NSW");
                put("StockNumber", "ACD1234567");}});
}}));
//verify
VerifyResult result = verificationClient.verify(request);
//verifyAsync
verificationClient.verifyAsync(request, new ApiCallback<VerifyResult>() {
    @Override
    public void onFailure(ApiException e, int statusCode, Map<String, List<String>> responseHeaders) {
        Logger.getLogger(SdkJavaV1Sample.class.getName()).log(Level.SEVERE, null, e);
    }
    @Override
    public void onSuccess(VerifyResult result, int statusCode, Map<String, List<String>> responseHeaders) {
        System.out.println(result); //To change body of generated methods, choose Tools | Templates.
    }
    @Override
    public void onUploadProgress(long bytesWritten, long contentLength, boolean done) {
        //To change body of generated methods, choose Tools | Templates.
    }
    @Override
    public void onDownloadProgress(long bytesRead, long contentLength, boolean done) {
        //To change body of generated methods, choose Tools | Templates.
    }
});
Suggest Edits

Configuration

 
Suggest Edits

Get Document Types

Gets the types of documents available for a country.

 

Basic Auth

 Authentication is required for this endpoint.
gethttps://api.globaldatacompany.com/configuration/v1/documentTypes/countryCode
curl --request GET \
  --url https://api.globaldatacompany.com/configuration/v1/documentTypes/countryCode
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.globaldatacompany.com/configuration/v1/documentTypes/countryCode' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.globaldatacompany.com/configuration/v1/documentTypes/countryCode");

xhr.send(data);
require 'uri'
require 'net/http'

url = URI("https://api.globaldatacompany.com/configuration/v1/documentTypes/countryCode")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
import requests

url = "https://api.globaldatacompany.com/configuration/v1/documentTypes/countryCode"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  "AU": [
    "DrivingLicence",
    "Passport"
  ]
}

Path Params

countryCode
string
required

Country alpha2 code. Call Get Country Codes to get the countries available to you.

Response

Returns an object of the given country code. This object contains an array of strings which are the possible values for DocumentType in the Verify call.

Your request could not be processed, there should be more details in the response.

The user name and password you provided is not valid or you are using an account not configured to be an API user.

The request took longer to process than we waited.

You asked for a media type that we do not support. You should request application/json in the Content-Type header.

An error happened on the server without a specific message.

SDKs

Coming Soon...
//Example Username: JoeNapoli_API_Demo, Example Password: 05uZuPRCyPi!6
ApiClient apiClient = new ApiClient();
apiClient.setUsername("JoeNapoli_API_Demo");
apiClient.setPassword("05uZuPRCyPi!6");
ConfigurationApi configurationClient = new ConfigurationApi(apiClient);
//getDocumentTypes
Map<String, List<String>> documentTypes = configurationClient.getDocumentTypes("AU");
//getDocumentTypesAsync
configurationClient.getDocumentTypesAsync("AU", new ApiCallback<Map<String, List<String>>>() {
    @Override
    public void onFailure(ApiException e, int statusCode, Map<String, List<String>> responseHeaders) {
        Logger.getLogger(SdkJavaV1Sample.class.getName()).log(Level.SEVERE, null, e);
    }
    @Override
    public void onSuccess(Map<String, List<String>> result, int statusCode, Map<String, List<String>> responseHeaders) {
        System.out.println(result);
    }
    @Override
    public void onUploadProgress(long bytesWritten, long contentLength, boolean done) {
        //To change body of generated methods, choose Tools | Templates.
    }
    @Override
    public void onDownloadProgress(long bytesRead, long contentLength, boolean done) {
        //To change body of generated methods, choose Tools | Templates.
    }
});
Suggest Edits

Verifications

 
Suggest Edits

Verify

Calling this method will perform a verification. If your account includes address cleansing set the CleansedAddress flag to get
additional address information in the result. You can query configuration to get what fields are available to you in each each country.
It is also possible to get sample requests from the customer portal.

Sandbox Accounts

If you are configured for a sandbox account make sure to call Get Test Entities to get test data for a country you want to try. Sandbox accounts only use these test entities and so trying to verify with any other data will result in no matches being found.

 

Basic Auth

 Authentication is required for this endpoint.
posthttps://api.globaldatacompany.com/verifications/v1/verify
curl --request POST \
  --url https://api.globaldatacompany.com/verifications/v1/verify
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.globaldatacompany.com/verifications/v1/verify' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.globaldatacompany.com/verifications/v1/verify");

xhr.send(data);
require 'uri'
require 'net/http'

url = URI("https://api.globaldatacompany.com/verifications/v1/verify")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
import requests

url = "https://api.globaldatacompany.com/verifications/v1/verify"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  "TransactionID": "c9d89fbe-5248-4b87-b770-9ef3dc73ad6b",
  "UploadedDt": "2018-04-24T19:15:10",
  "CountryCode": "US",
  "ProductName": "Identity Verification",
  "CustomerReferenceID": "abc-1234",
  "Record": {
    "TransactionRecordID": "8c1ce0a8-0ae6-4831-b776-335d8e2623fe",
    "RecordStatus": "nomatch",
    "DatasourceResults": [
      {
        "DatasourceName": "Acuant AssureID Document Verification Test",
        "DatasourceFields": [],
        "AppendedFields": [
          {
            "FieldName": "YearOfBirth",
            "Data": "1972"
          },
          {
            "FieldName": "City",
            "Data": "GLENBURNIE"
          },
          {
            "FieldName": "PostalCode",
            "Data": "21062"
          },
          {
            "FieldName": "DocumentVerified",
            "Data": "False"
          },
          {
            "FieldName": "AuthenticityReasons",
            "Data": "ExpiredDocument"
          },
          {
            "FieldName": "AuthenticityDetails",
            "Data": "[{\"Name\":\"Document Expired\",\"IsValid\":false,\"Value\":\"2008-12-25T00:00:00\",\"DocumentId\":\"3254f9a7-06b6-42a5-b740-1c592738d609\",\"Description\":\"The document has expired. Verified that the document expiration date does not occur before the current date.\",\"Source\":\"VisualInspectionZone\",\"Properties\":\"VIZ Expiration Date\"},{\"Name\":\"Birth Date Valid\",\"IsValid\":true,\"Value\":\"1972-12-25T00:00:00\",\"DocumentId\":\"1cc1d211-8f33-43be-88ef-b71866c61e1a\",\"Description\":\"The birth date is valid. Verified that the birth date is valid, in the expected format, and occurs on or before the current date and not outside a reasonable range.\",\"Source\":\"VisualInspectionZone\",\"Properties\":\"VIZ Birth Date\"},{\"Name\":\"Document Classification\",\"IsValid\":true,\"Value\":\"\",\"DocumentId\":\"c0629316-ed21-409e-8c1e-5215fd12ba58\",\"Description\":\"The document type is supported. Verified that the document is recognized as a supported document type and that the type of document can be fully authenticated.\",\"Source\":\"\",\"Properties\":\"\"},{\"Name\":\"Expiration Date Valid\",\"IsValid\":true,\"Value\":\"2008-12-25T00:00:00\",\"DocumentId\":\"c3ef25cf-a950-4d3e-969f-ac9ba6b7bb72\",\"Description\":\"The expiration date is valid. Verified that the document expiration date is valid, in the expected format, and occurs after the issue and birth dates.\",\"Source\":\"VisualInspectionZone\",\"Properties\":\"VIZ Expiration Date\"},{\"Name\":\"Layout Valid\",\"IsValid\":true,\"Value\":\"\",\"DocumentId\":\"ffc9a646-0785-4876-b4eb-d30b7c6dd3f2\",\"Description\":\"The layout is correct for the document series. This authentication will fail if the relative positions of features on the document are outside the normal area. Possible reasons this test may fail for a valid document may be that the document was moving or slipped during the capture, or the document may be excessively worn or damaged.\",\"Source\":\"\",\"Properties\":\"\"},{\"Name\":\"Visible Pattern\",\"IsValid\":true,\"Value\":\"\",\"DocumentId\":\"da870548-6a61-4960-a932-f959c6403bc8\",\"Description\":\"A visible pattern was found. Verified that a security feature in the visible spectrum is present and in an expected location on the document.\",\"Source\":\"\",\"Properties\":\"\"},{\"Name\":\"Visible Pattern\",\"IsValid\":true,\"Value\":\"\",\"DocumentId\":\"d28928e3-f863-4c14-bb59-3e2cc015569e\",\"Description\":\"A visible pattern was found. Verified that a security feature in the visible spectrum is present and in an expected location on the document.\",\"Source\":\"\",\"Properties\":\"\"},{\"Name\":\"Visible Pattern\",\"IsValid\":true,\"Value\":\"\",\"DocumentId\":\"8c6f9249-e155-4fdd-9e64-033853741d21\",\"Description\":\"A visible pattern was found. Verified that a security feature in the visible spectrum is present and in an expected location on the document.\",\"Source\":\"\",\"Properties\":\"\"},{\"Name\":\"Visible Pattern\",\"IsValid\":true,\"Value\":\"\",\"DocumentId\":\"60d0411d-6003-4584-8c6e-05f61f591c91\",\"Description\":\"A visible pattern was found. Verified that a security feature in the visible spectrum is present and in an expected location on the document.\",\"Source\":\"\",\"Properties\":\"\"},{\"Name\":\"Visible Pattern\",\"IsValid\":true,\"Value\":\"\",\"DocumentId\":\"18d3eb71-4768-4171-8919-8a8f01027f91\",\"Description\":\"A visible pattern was found. Verified that a security feature in the visible spectrum is present and in an expected location on the document.\",\"Source\":\"\",\"Properties\":\"\"},{\"Name\":\"Visible Pattern\",\"IsValid\":true,\"Value\":\"\",\"DocumentId\":\"52907d27-954b-4b43-9534-cd8095d7333b\",\"Description\":\"A visible pattern was found. Verified that a security feature in the visible spectrum is present and in an expected location on the document.\",\"Source\":\"\",\"Properties\":\"\"},{\"Name\":\"Visible Pattern\",\"IsValid\":true,\"Value\":\"\",\"DocumentId\":\"f16631ca-df78-4543-b7bc-fbf49d0aa750\",\"Description\":\"Avisible pattern was found. Verified that a security feature in the visible spectrum is present and in an expected location on the document.\",\"Source\":\"\",\"Properties\":\"\"}]"
          },
          {
            "FieldName": "Address1",
            "Data": "123 MAIN ST"
          },
          {
            "FieldName": "DocumentNumber",
            "Data": "S-543-123-456-789"
          },
          {
            "FieldName": "FullName",
            "Data": "MARY ANNE SAMPLE"
          },
          {
            "FieldName": "FirstName",
            "Data": "MARY ANNE"
          },
          {
            "FieldName": "LastName",
            "Data": "SAMPLE"
          },
          {
            "FieldName": "Issuer",
            "Data": "Maryland"
          },
          {
            "FieldName": "Gender",
            "Data": "F"
          },
          {
            "FieldName": "DayOfBirth",
            "Data": "25"
          },
          {
            "FieldName": "MonthOfBirth",
            "Data": "12"
          },
          {
            "FieldName": "DayOfExpiry",
            "Data": "25"
          },
          {
            "FieldName": "MonthOfExpiry",
            "Data": "12"
          },
          {
            "FieldName": "YearOfExpiry",
            "Data": "2008"
          }
        ],
        "Errors": [],
        "FieldGroups": []
      }
    ],
    "Errors": [],
    "Rule": {
      "RuleName": "Document Verification",
      "Note": "Document Verified = True"
    }
  },
  "Errors": []
}

Body Params

AcceptTruliooTermsAndConditions
boolean

Indicate that Trulioo terms and conditions are accepted.
The Verification request will be executed only if the value of this header is passed as 'true'.

CallBackUrl
string

If set, the transaction will run asyncronously and trulioo will try to update the client with transaction state updates until completed.

Timeout
int32

If set, trulioo will try to update the client syncronously within the timeout in seconds. If failed to accomplish, the transaction will be canceled.

CleansedAddress
boolean

Set to true if you want to receive address cleanse information. This will only change the response if you have address cleansing enabled for the country you are querying for.

ConfigurationName
string

Indicate the configuration used for the verification. Currently only 'Identity Verification' is supported.
Default value will be "Identity Verification"

ConsentForDataSources
array of strings

Some datasources require your customer provide consent to access them. For each datasource that requires consent, send the requred string if your customer has provided it. A list of these required strings for a country can be gotten by the Get Consents call. If consent is not provided the datasource will not be queried.

CountryCode
string
required

Country alpha2 code. Call Get Country Codes to get the countries available to you.

CustomerReferenceID
string

Use this field to send any internal reference ID to Global Gateway. It will be contained in the response so it is simple to link Trulioo's API to your system.

DataFields
object
required

The data field name-value pairs for the data elements on which the verification is to be performed.

 
DataFields.Document
object

Document information

 
DataFields.Document.DocumentFrontImage
string

Front of the document encoded as a Base64 encoded string.

DataFields.Document.DocumentBackImage
string

Back of the document encoded as a Base64 encoded string.

DataFields.Document.LivePhoto
string

Selfie image encoded as a Base64 encoded string.

DataFields.Document.DocumentType
string

Document type.
Supported Types: DrivingLicence, IdentityCard, Passport, ResidencePermit.

DataFields.Document.AcceptIncompleteDocument
boolean

Accept Incomplete Document.
To allow verification with an incomplete document set this to true. For example, to allow verification by using only the front image of a document. By default: true.

DataFields.Document.ValidateDocumentImageQuality
boolean

Validate Document Image Quality.

DataFields.CountrySpecific
object

CountrySpecific fields
{"CountryCode" : {"Field1" : "Value",
"Field2" : "Value"
}}

 
VerboseMode
boolean

Verbose Mode Output Flag.

Response

OK

TransactionIDstring

The id for the transaction it will be a GUID

UploadedDtstring

Time in UTC

CountryCodestring

Country Code

ProductNamestring

Product Name

Recordobject
Record.TransactionRecordIDstring

The TransactionRecordID, this is the ID you will use to fetch the transaction again.

Record.RecordStatusstring

'match' or 'nomatch' if the verification passed the rules configured on your account this will be 'match'.

Record.DatasourceResultsarray

Results for each datasource that was queried

Record.Errorsarray
Record.Ruleobject

Rule used for record

Record.Rule.RuleNamestring

Name of RecordRule.

Record.Rule.Notestring

Rule Description.

CustomerReferenceIDstring

Customer Reference Id

Errorsarray

See Errors for explanation of any error encountered.

Your request could not be processed, there should be more details in the response.

The user name and password you provided is not valid or you are using an account not configured to be an API user.

The request took longer to process than we waited.

You asked for a media type that we do not support. You should request application/json in the Content-Type header.

An error happened on the server without a specific message.

SDKs

//Example Username: JoeNapoli_API_Demo, Example Password: 05uZuPRCyPi!6
var truliooClient = new TruliooApiClient("JoeNapoli_API_Demo", "05uZuPRCyPi!6");
VerifyRequest request = new VerifyRequest()
{
    AcceptTruliooTermsAndConditions = true,
    ConfigurationName = "Identity Verification",
    CountryCode = "US",
    DataFields = new DataFields()
    {
        PersonInfo = new PersonInfo()
        {
            FirstGivenName = "Kyle Antwon",
            MiddleName = "",
            FirstSurName = "Hertz",
        },
        Document = new Document()
        {
            DocumentFrontImage = "/9j/4QAYRXhpZgAASUkqAAgAAAAA .....IQCEIQCEIQCEIQP/9k=",
            DocumentBackImage = "/9j/4QAYRXhpZgAASUkqAAgAAAAA......LKICIiAiIgIiICIiAiIg//Z",
            DocumentType = "DrivingLicence"
        },
    }
};
            
VerifyResult result = await truliooClient.Verification
    .VerifyAsync(request);
//Example Username: JoeNapoli_API_Demo, Example Password: 05uZuPRCyPi!6
ApiClient apiClient = new ApiClient();
apiClient.setUsername("JoeNapoli_API_Demo");
apiClient.setPassword("05uZuPRCyPi!6");
VerificationsApi verificationClient = new VerificationsApi(apiClient);
VerifyRequest request = new VerifyRequest()
    .acceptTruliooTermsAndConditions(Boolean.TRUE)
    .configurationName("Identity Verification")
    .countryCode("US")
    .dataFields(new DataFields()
        .personInfo(new PersonInfo()
            .firstGivenName("Kyle Antwon")
            .middleName("")
            .firstSurName("Hertz"))
        .document(new Document()
            .documentFrontImage("/9j/4QAYRXhpZgAASUkqAAgAAAAA .....IQCEIQCEIQCEIQP/9k=")
            .documentBackImage("/9j/4QAYRXhpZgAASUkqAAgAAAAA......LKICIiAiIgIiICIiAiIg//Z")     
            .documentType("DrivingLicence"));
}}));
//verify
VerifyResult result = verificationClient.verify(request);



//verifyAsync
verificationClient.verifyAsync(request, new ApiCallback<VerifyResult>() {
    @Override
    public void onFailure(ApiException e, int statusCode, Map<String, List<String>> responseHeaders) {
        Logger.getLogger(SdkJavaV1Sample.class.getName()).log(Level.SEVERE, null, e);
    }
    @Override
    public void onSuccess(VerifyResult result, int statusCode, Map<String, List<String>> responseHeaders) {
        System.out.println(result); //To change body of generated methods, choose Tools | Templates.
    }
    @Override
    public void onUploadProgress(long bytesWritten, long contentLength, boolean done) {
        //To change body of generated methods, choose Tools | Templates.
    }
    @Override
    public void onDownloadProgress(long bytesRead, long contentLength, boolean done) {
        //To change body of generated methods, choose Tools | Templates.
    }
});
Suggest Edits

Get Business Search Result

Returns the a business search result.

 

Basic Auth

 Authentication is required for this endpoint.
gethttps://api.globaldatacompany.com/business/v1/search/transactionrecord/id
curl --request GET \
  --url https://api.globaldatacompany.com/business/v1/search/transactionrecord/id
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.globaldatacompany.com/business/v1/search/transactionrecord/id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.globaldatacompany.com/business/v1/search/transactionrecord/id");

xhr.send(data);
require 'uri'
require 'net/http'

url = URI("https://api.globaldatacompany.com/business/v1/search/transactionrecord/id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
import requests

url = "https://api.globaldatacompany.com/business/v1/search/transactionrecord/id"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  "TransactionID": "c03ad3c9-da6b-452c-8a2e-fd1923973b99",
  "UploadedDt": "2015-02-19T13:25:50",
  "CountryCode": "CA",
  "ProductName": "Identity Verification",
  "Record": {
    "TransactionRecordID": "c47d485d-005a-4e0c-8ef0-06f16ddbaeb6",
    "RecordStatus": "match",
    "DatasourceResults": [
      {
        "Results": [
          {
            "Index": "1",
            "BusinessName": "Acme Inc",
            "MatchingScore": "1",
            "BusinessRegistrationNumber": "BRN123ABC",
            "JurisdictionOfIncorporation": "CA-BC",
            "FullAddress": "123 Main St, Vancouver, V6M 1A3",
            "Address": {
              "BuildingNumber": "123",
              "StreetName": "Main",
              "StreetType": "St",
              "City": "Vancouver",
              "PostalCode": "V6M 1A3"
            }
          }
        ],
        "DatasourceName": "Business Search Datasource",
        "Errors": []
      }
    ],
    "Errors": []
  },
  "Errors": []
}

Path Params

id
string
required

The TransactionRecordID from the Verify response, this will be a GUID

Response

OK

TransactionIDstring

The id for the transaction it will be a GUID.

UploadedDtstring

Time in UTC.

CountryCodestring

The country code for which the verification was performed.

ProductNamestring

Product Name.

Recordobject
Record.TransactionRecordIDstring

The TransactionRecordID, this is the ID you will use to fetch the transaction again.

Record.RecordStatusstring

'match' or 'nomatch' if the verification passed the rules configured on your account this will be 'match'.

Record.DatasourceResultsarray

Results for each datasource that was queried.

Record.Errorsarray
Errorsarray

Collection of record errors.

Your request could not be processed, there should be more details in the response.

The user name and password you provided is not valid or you are using an account not configured to be an API user.

The request took longer to process than we waited.

You asked for a media type that we do not support. You should request application/json in the Content-Type header.

An error happened on the server without a specific message.

SDKs

Coming Soon...
Coming Soon...
Suggest Edits

Verifications

 
Suggest Edits

Verify

Calling this method will perform a verification. If your account includes address cleansing set the CleansedAddress flag to get
additional address information in the result. You can query configuration to get what fields are available to you in each each country.
It is also possible to get sample requests from the customer portal.

Sandbox Accounts

If you are configured for a sandbox account make sure to call Get Test Entities to get test data for a country you want to try. Sandbox accounts only use these test entities and so trying to verify with any other data will result in no matches being found.

 

Basic Auth

 Authentication is required for this endpoint.
posthttps://api.globaldatacompany.com/verifications/v1/verify
curl --request POST \
  --url https://api.globaldatacompany.com/verifications/v1/verify
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.globaldatacompany.com/verifications/v1/verify' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.globaldatacompany.com/verifications/v1/verify");

xhr.send(data);
require 'uri'
require 'net/http'

url = URI("https://api.globaldatacompany.com/verifications/v1/verify")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
import requests

url = "https://api.globaldatacompany.com/verifications/v1/verify"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  "TransactionID": "23a29398-631b-4921-a537-a594fae4fd37",
  "UploadedDt": "2018-05-29T23:12:58",
  "CountryCode": "CA",
  "ProductName": "Identity Verification",
  "CustomerReferenceID": "abc-1234",
  "Record": {
    "TransactionRecordID": "fd244b13-8cfe-4235-a61a-eadcdd629859",
    "RecordStatus": "match",
    "DatasourceResults": [
      {
        "DatasourceName": "Government Registry",
        "DatasourceFields": [
          {
            "FieldName": "MonthOfIncorporation",
            "Status": "match"
          },
          {
            "FieldName": "PostalCode",
            "Status": "missing"
          },
          {
            "FieldName": "StreetType",
            "Status": "missing"
          },
          {
            "FieldName": "YearOfIncorporation",
            "Status": "match"
          },
          {
            "FieldName": "BusinessName",
            "Status": "match"
          },
          {
            "FieldName": "taxidnumber",
            "Status": "missing"
          },
          {
            "FieldName": "City",
            "Status": "missing"
          },
          {
            "FieldName": "BuildingNumber",
            "Status": "missing"
          },
          {
            "FieldName": "BusinessRegistrationNumber",
            "Status": "match"
          },
          {
            "FieldName": "Suburb",
            "Status": "missing"
          },
          {
            "FieldName": "BuildingName",
            "Status": "missing"
          },
          {
            "FieldName": "JurisdictionOfIncorporation",
            "Status": "match"
          },
          {
            "FieldName": "StateProvinceCode",
            "Status": "missing"
          },
          {
            "FieldName": "UnitNumber",
            "Status": "missing"
          },
          {
            "FieldName": "DayOfIncorporation",
            "Status": "match"
          },
          {
            "FieldName": "County",
            "Status": "missing"
          },
          {
            "FieldName": "StreetName",
            "Status": "missing"
          }
        ],
        "AppendedFields": [
          {
            "FieldName": "JurisdictionOfIncorporation",
            "Data": "BC"
          },
          {
            "FieldName": "BusinessName",
            "Data": "Acme Inc."
          },
          {
            "FieldName": "BusinessStatus",
            "Data": "Active"
          },
          {
            "FieldName": "BusinessType",
            "Data": "Corporation"
          },
          {
            "FieldName": "BusinessDetails",
            "Data": "{\"resultId\":\"104506\",\"entityName\":\"Acme Inc.\",\"entityNumber\":\"BRN123ABC\",\"normalizedEntityStatus\":\"Active\",\"jurisdiction\":\"BC\",\"formationDate\":\"1990-05-13T00:00:00\",\"normalizedEntityType\":\"Corporation\"}"
          },
          {
            "FieldName": "BusinessRegistrationNumber",
            "Data": "BRN123ABC"
          },
          {
            "FieldName": "DayOfIncorporation",
            "Data": "13"
          },
          {
            "FieldName": "MonthOfIncorporation",
            "Data": "05"
          },
          {
            "FieldName": "YearOfIncorporation",
            "Data": "1990"
          }
        ],
        "Errors": [],
        "FieldGroups": []
      },
      {
        "DatasourceName": "International Watchlist",
        "DatasourceFields": [
          {
            "FieldName": "BusinessName",
            "Status": "missing"
          }
        ],
        "AppendedFields": [
          {
            "FieldName": "WatchlistState",
            "Data": "Clear"
          }
        ],
        "Errors": [],
        "FieldGroups": []
      },
      {
        "DatasourceName": "Public Records",
        "DatasourceFields": [
          {
            "FieldName": "BuildingNumber",
            "Status": "match"
          },
          {
            "FieldName": "POBox",
            "Status": "missing"
          },
          {
            "FieldName": "City",
            "Status": "match"
          },
          {
            "FieldName": "BusinessRegistrationNumber",
            "Status": "match"
          },
          {
            "FieldName": "BuildingName",
            "Status": "missing"
          },
          {
            "FieldName": "Telephone",
            "Status": "missing"
          },
          {
            "FieldName": "Suburb",
            "Status": "missing"
          },
          {
            "FieldName": "JurisdictionOfIncorporation",
            "Status": "match"
          },
          {
            "FieldName": "UnitNumber",
            "Status": "match"
          },
          {
            "FieldName": "DayOfIncorporation",
            "Status": "match"
          },
          {
            "FieldName": "StateProvinceCode",
            "Status": "match"
          },
          {
            "FieldName": "StreetName",
            "Status": "match"
          },
          {
            "FieldName": "MonthOfIncorporation",
            "Status": "match"
          },
          {
            "FieldName": "County",
            "Status": "missing"
          },
          {
            "FieldName": "StreetType",
            "Status": "match"
          },
          {
            "FieldName": "YearOfIncorporation",
            "Status": "match"
          },
          {
            "FieldName": "PostalCode",
            "Status": "match"
          },
          {
            "FieldName": "BusinessName",
            "Status": "match"
          },
          {
            "FieldName": "Source",
            "Status": "missing"
          }
        ],
        "AppendedFields": [
          {
            "FieldName": "City",
            "Data": "Vancouver"
          },
          {
            "FieldName": "BusinessName",
            "Data": "Acme Inc."
          },
          {
            "FieldName": "PostalCode",
            "Data": "V6M 1A3"
          },
          {
            "FieldName": "BusinessStatus",
            "Data": "Active"
          },
          {
            "FieldName": "BusinessDetails",
            "Data": "{\"CompanyName\":\"Acme Inc.\",\"RegistrationNumber\":\"BRN123ABC\",\"CompanyStatus\":\"Active\",\"RegisteredFullAddress\":\"123 Main St, Vancouver, V6M 1A3\",\"RegisteredAddress\":{\"street_address\":\"123 Main St\",\"locality\":\"Vancouver\",\"region\":\"BC\",\"postal_code\":\"V6M 1A3\",\"country\":\"CA\"},\"CountryCode\":\"ca\",\"DayOfIncorporation\":\"13\",\"MonthOfIncorporation\":\"05\",\"YearOfIncorporation\":\"1990\",\"Source\":\"https://www.realsource.com/data.html?corpId=BRN123ABC\",\"AdditionalData\":{\"dissolution_date\":null,\"company_type\":\"Corporation\",\"branch\":null,\"branch_status\":null,\"inactive\":false,\"created_at\":\"2015-12-15T23:28:19+11:00\",\"updated_at\":\"2018-05-02T16:43:43+10:00\",\"retrieved_at\":\"2017-02-25T21:41:28+11:00\",\"source\":{\"publisher\":\"Corporations Canada\",\"url\":\"https://www.realsource.com/data.html?corpId=F154630\",\"retrieved_at\":\"2017-02-25T21:41:28+11:00\"},\"agent_name\":null,\"alternative_names\":[],\"previous_names\":[],\"number_of_employees\":null,\"native_company_number\":null,\"industry_codes\":[],\"identifiers\":[{\"identifier\":{\"uid\":\"859486577RC0001\",\"identifier_system_code\":\"ca_bn\",\"identifier_system_name\":\"Canadian Business Number\"}}],\"trademark_registrations\":[{\"trademark_registration\":{\"mark_details\":{\"mark_text\":\"secretstuff\",\"mark_image_url\":\"https://www.realsource.com/data.html\"},\"register_name\":\"United States Patent and Trademark Office\",\"registration_date\":\"2015-08-25\",\"expiry_date\":null}},{\"trademark_registration\":{\"mark_details\":{\"mark_text\":\"copyrights\",\"mark_image_url\":\"https://www.realsource.com/data.html\"},\"register_name\":\"United States Patent and Trademark Office\",\"registration_date\":\"2015-08-25\",\"expiry_date\":null}},{\"trademark_registration\":{\"mark_details\":{\"mark_text\":\"Brand Name\",\"mark_image_url\":\"https://www.realsource.com/data.html\"},\"register_name\":\"United States Patent and Trademark Office\",\"registration_date\":\"2015-02-24\",\"expiry_date\":null}}],\"corporate_groupings\":[],\"data\":null,\"financial_summary\":null,\"home_company\":null,\"controlling_entity\":null,\"ultimate_beneficial_owners\":[],\"filings\":[],\"officers\":[{\"officer\":{\"id\":19371865,\"name\":\"John Bob\",\"position\":\"director\",\"uid\":null,\"start_date\":null,\"end_date\":null,\"occupation\":null,\"inactive\":false,\"current_status\":null,\"address\":\"123 West 9st\\nVancouver BC  V8W 1P0\\nCanada\",\"nationality\":null,\"date_of_birth\":null}},{\"officer\":{\"id\":177852560,\"name\":\"Mary Berry\",\"position\":\"director\",\"uid\":null,\"start_date\":null,\"end_date\":null,\"occupation\":null,\"inactive\":false,\"current_status\":null,\"address\":\"123 - a different avenue\\nLangley BC  V8U 3K7\\nCanada\",\"nationality\":null,\"date_of_birth\":null}},{\"officer\":{\"id\":19397462,\"name\":\"David O'Leary\",\"position\":\"director\",\"uid\":null,\"start_date\":null,\"end_date\":null,\"occupation\":null,\"inactive\":false,\"current_status\":null,\"address\":\"#6- The Place\\nSan Francisco CA  68716\\nUnited States\",\"nationality\":null,\"date_of_birth\":null}},{\"officer\":{\"id\":193546563,\"name\":\"Samantha Stafford\",\"position\":\"director\",\"uid\":null,\"start_date\":null,\"end_date\":null,\"occupation\":null,\"inactive\":false,\"current_status\":null,\"address\":\"35 West East Street\\nVancouver BC  V0G 8P0\\nCanada\",\"nationality\":null,\"date_of_birth\":null}},{\"officer\":{\"id\":1574146,\"name\":\"Amanda Anaconda\",\"position\":\"director\",\"uid\":null,\"start_date\":null,\"end_date\":null,\"occupation\":null,\"inactive\":false,\"current_status\":null,\"address\":\"41 Up Down Place\\2nd Floor\\nNew York NY  12359\\nUnited States\",\"nationality\":null,\"date_of_birth\":null}}]}}"
          },
          {
            "FieldName": "Source",
            "Data": "https://www.realsource.com/data.html"
          },
          {
            "FieldName": "StateProvince",
            "Data": "BC"
          },
          {
            "FieldName": "DayOfIncorporation",
            "Data": "13"
          },
          {
            "FieldName": "MonthOfIncorporation",
            "Data": "05"
          },
          {
            "FieldName": "YearOfIncorporation",
            "Data": "1990"
          },
          {
            "FieldName": "BuildingNumber",
            "Data": "123"
          },
          {
            "FieldName": "UnitNumber",
            "Data": "1"
          },
          {
            "FieldName": "StreetName",
            "Data": "Main"
          },
          {
            "FieldName": "StreetType",
            "Data": "St"
          },
          {
            "FieldName": "BusinessRegistrationNumber",
            "Data": "BRN123ABC"
          }
        ],
        "Errors": [],
        "FieldGroups": []
      }
    ],
    "Errors": [],
    "Rule": {
      "RuleName": "RuleScript BusinessVerify",
      "Note": "Script manually created"
    }
  },
  "Errors": []
}

Body Params

AcceptTruliooTermsAndConditions
boolean

Indicate that Trulioo terms and conditions are accepted.
The Verification request will be executed only if the value of this header is passed as 'true'.

CallBackUrl
string

If set, the transaction will run asyncronously and trulioo will try to update the client with transaction state updates until completed.

Timeout
int32

If set, trulioo will try to update the client syncronously within the timeout in seconds. If failed to accomplish, the transaction will be canceled.

CleansedAddress
boolean

Set to true if you want to receive address cleanse information. This will only change the response if you have address cleansing enabled for the country you are querying for.

ConfigurationName
string

Indicate the configuration used for the verification. Currently only 'Identity Verification' is supported.
Default value will be "Identity Verification"

ConsentForDataSources
array of strings

Some datasources require your customer provide consent to access them. For each datasource that requires consent, send the requred string if your customer has provided it. A list of these required strings for a country can be gotten by the Get Consents call. If consent is not provided the datasource will not be queried.

CountryCode
string
required

Country alpha2 code. Call Get Country Codes to get the countries available to you.

CustomerReferenceID
string

Use this field to send any internal reference ID to Global Gateway. It will be contained in the response so it is simple to link Trulioo's API to your system.

DataFields
object
required

The data field name-value pairs for the data elements on which the verification is to be performed

 
DataFields.Business
object

Business information

 
DataFields.Business.BusinessName
string

Name of the business to be verified.

DataFields.Business.BusinessRegistrationNumber
string

Registration number of business to be verified.

DataFields.Business.DayOfIncorporation
int32

Day of incorporation of the business to be verified.

DataFields.Business.MonthOfIncorporation
int32

Month of incorporation of the business to be verified.

DataFields.Business.YearOfIncorporation
int32

Year of incorporation of the business to be verified.

DataFields.Business.JurisdictionOfIncorporation
string

Jurisdiction Of Incorporation of the business to be verified. This is to be given as an ISO2 country code.

DataFields.Business.ShareholderListDocument
boolean

Whether or not to retrieve shareholderList document.

DataFields.Business.FinancialInformationDocument
boolean

Whether or not to retrieve financial information document.

DataFields.Business.Entities
boolean

Whether or not to retrieve entity detail

DataFields.Location
object

Location Information.

 
DataFields.Location.BuildingNumber
string

House / Civic / Building number of home address

DataFields.Location.BuildingName
string

Name of building of home address

DataFields.Location.UnitNumber
string

Flat/Unit/Apartment number of home address

DataFields.Location.StreetName
string

Street name of primary residence

DataFields.Location.StreetType
string

Street type of primary residence (Typically St, Rd etc)

DataFields.Location.City
string

City of home address

DataFields.Location.Suburb
string

Suburb / Subdivision / Municipality of home address

DataFields.Location.County
string

County / District of home address

DataFields.Location.StateProvinceCode
string

State of primary residence. US sources expect 2 characters. Australian sources expect 2 or 3 characters.

DataFields.Location.Country
string

Country of physical address (ISO 3166-1 alpha-2 code)

DataFields.Location.PostalCode
string

ZIP Code or Postal Code of home address

DataFields.Location.POBox
string

Post Office Box

DataFields.Location.AdditionalFields
object

Fields not normally used

 
DataFields.Location.AdditionalFields.Address1
string

Address1 is available in certain countries. It can be used to pass a compiled address field instead of sending individual address attributes (such as UnitNumber, BuidlingNumber, BuildingName, StreetName and StreetType).
GlobalGateway will provide a pass through of Address1 directly to connected datasources for the selected country.
Please note: each datasource requires the address fields to be configured in a certain manner, implementing and sending Address1 instead of individual address fields may affect your ability to verify this address.

DataFields.Communication
object

Communication Information.

 
DataFields.Communication.MobileNumber
string

Mobile phone number

DataFields.Communication.Telephone
string

Telephone number of the individual to be verified

DataFields.Communication.Telephone2
string

Additional Phone/Mobile Number of the individual to be verified

DataFields.Communication.EmailAddress
string

Email address of the individual to be verified

DataFields.CountrySpecific
object

CountrySpecific fields
{"CountryCode" : {"Field1" : "Value",
"Field2" : "Value"
}}

 
VerboseMode
boolean

Verbose Mode Output Flag.

Response

OK

TransactionIDstring

The id for the transaction it will be a GUID

UploadedDtstring

Time in UTC

CountryCodestring

Country Code

ProductNamestring

Product Name

Recordobject
Record.TransactionRecordIDstring

The TransactionRecordID, this is the ID you will use to fetch the transaction again.

Record.RecordStatusstring

'match' or 'nomatch' if the verification passed the rules configured on your account this will be 'match'.

Record.DatasourceResultsarray

Results for each datasource that was queried.

Record.Errorsarray
Record.Ruleobject

Rule used for record.

Record.Rule.RuleNamestring

Name of RecordRule.

Record.Rule.Notestring

Rule Description.

CustomerReferenceIDstring

Customer Reference Id

Errorsarray

See Errors for explanation of any error encountered.

Your request could not be processed, there should be more details in the response.

The user name and password you provided is not valid or you are using an account not configured to be an API user.

The request took longer to process than we waited.

You asked for a media type that we do not support. You should request application/json in the Content-Type header.

An error happened on the server without a specific message.

SDKs

//Example Username: JoeNapoli_API_Demo, Example Password: 05uZuPRCyPi!6
var truliooClient = new TruliooApiClient("JoeNapoli_API_Demo", "05uZuPRCyPi!6");
VerifyRequest request = new VerifyRequest()
{
    AcceptTruliooTermsAndConditions = true,
    ConfigurationName = "Identity Verification",
    CountryCode = "CA",
    DataFields = new DataFields()
    {
        Business = new Business()
        {
          BusinessName = "The Company Inc.",
          BusinessRegistrationNumber = "P987867",
          JurisdictionOfIncorporation = "BC",
          DayOfIncorporation = 1,
          MonthOfIncorporation = 9,
          YearOfIncorporation = 2014
        },
        Location = new Location()
        {
          BuildingNumber = "1450",
          UnitNumber = "7",
          StreetName =  "West",
          StreetType = "st",
          City = "Vancouver",
          StateProvinceCode = "BC",
          PostalCode = "V6l 19Y"
        },
        Location = new Location()
        {
          Telephone: "1 (888) 123-8959",
          EmailAddress: "business@company.com"
        }
    }
};
            
VerifyResult result = await truliooClient.Verification
    .VerifyAsync(request);
//Example Username: JoeNapoli_API_Demo, Example Password: 05uZuPRCyPi!6
ApiClient apiClient = new ApiClient();
apiClient.setUsername("JoeNapoli_API_Demo");
apiClient.setPassword("05uZuPRCyPi!6");
VerificationsApi verificationClient = new VerificationsApi(apiClient);
VerifyRequest request = new VerifyRequest()
    .acceptTruliooTermsAndConditions(Boolean.TRUE)
    .configurationName("Identity Verification")
    .countryCode("CA")
    .dataFields(new DataFields()       
        .business(new Business()
            .businessName("The Company Inc.")
            .businessRegistrationNumber("P987867")
            .jurisdictionOfIncorporation("BC")
            .dayOfIncorporation(1)
            .monthOfIncorporation(9)
            .yearOfIncorporation(2014))
        .location(new Location()
            .buildingNumber("1450")
            .unitNumber("7")
            .streetName("West")
            .streetType("st")
            .city("Vancouver")
            .stateProvinceCode("BC")
            .postalCode("V6l 19Y""))
         .communication(new Communication()
            .telephone("1 (888) 123-8959")
            .emailAddress("business@company.com")));
}}));
//verify
VerifyResult result = verificationClient.verify(request);



//verifyAsync
verificationClient.verifyAsync(request, new ApiCallback<VerifyResult>() {
    @Override
    public void onFailure(ApiException e, int statusCode, Map<String, List<String>> responseHeaders) {
        Logger.getLogger(SdkJavaV1Sample.class.getName()).log(Level.SEVERE, null, e);
    }
    @Override
    public void onSuccess(VerifyResult result, int statusCode, Map<String, List<String>> responseHeaders) {
        System.out.println(result); //To change body of generated methods, choose Tools | Templates.
    }
    @Override
    public void onUploadProgress(long bytesWritten, long contentLength, boolean done) {
        //To change body of generated methods, choose Tools | Templates.
    }
    @Override
    public void onDownloadProgress(long bytesRead, long contentLength, boolean done) {
        //To change body of generated methods, choose Tools | Templates.
    }
});
Suggest Edits

Download Document

 

Basic Auth

 Authentication is required for this endpoint.
gethttps://api.globaldatacompany.com/verifications/v1/documentdownload/transactionRecordId/fieldName
curl --request GET \
  --url https://api.globaldatacompany.com/verifications/v1/documentdownload/transactionRecordId/fieldName
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.globaldatacompany.com/verifications/v1/documentdownload/transactionRecordId/fieldName' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.globaldatacompany.com/verifications/v1/documentdownload/transactionRecordId/fieldName");

xhr.send(data);
require 'uri'
require 'net/http'

url = URI("https://api.globaldatacompany.com/verifications/v1/documentdownload/transactionRecordId/fieldName")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
import requests

url = "https://api.globaldatacompany.com/verifications/v1/documentdownload/transactionRecordId/fieldName"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

transactionRecordId
string
required

The TransactionRecordID from the Verify response, this will be a GUID.

fieldName
string
required

Document field name.

Response

This endpoint will return a media/pdf response of the document being requested.

Your request could not be processed, there should be more details in the response.

The user name and password you provided is not valid or you are using an account not configured to be an API user.

The request took longer to process than we waited.

You asked for a media type that we do not support. You should request application/json in the Content-Type header.

An error happened on the server without a specific message.

SDKs

Coming Soon...
Coming Soon...