Trulioo SDK for Java

Version 3.0.4

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.

Requirements

Building the API client library requires:

1. Java 1.8+
2. Maven (3.8.3+)/Gradle (7.2+)

Installation

To install the API client library to your local Maven repository, simply execute:

mvn clean install

To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:

mvn clean deploy

Refer to the OSSRH Guide for more information.

Maven users

Add this dependency to your project's POM:

<dependency>
  <groupId>com.trulioo</groupId>
  <artifactId>normalizedapi</artifactId>
  <version>3.0.2</version>
  <scope>compile</scope>
</dependency>

Gradle users

Add this dependency to your project's build file:

  repositories {
    mavenCentral()     // Needed if the 'normalizedapi' jar has been published to maven central.
    mavenLocal()       // Needed if the 'normalizedapi' jar has been published to the local maven repo.
  }

  dependencies {
     implementation "com.trulioo:normalizedapi:3.0.2"
  }

Others

At first generate the JAR by executing:

mvn clean package

Then manually install the following JARs:

• target/normalizedapi-3.0.2.jar
• target/lib/*.jar

Getting Started

Please follow the installation instruction and execute the following Java code:

// Import classes:
import com.trulioo.normalizedapi.ApiClient;
import com.trulioo.normalizedapi.ApiException;
import com.trulioo.normalizedapi.Configuration;
import com.trulioo.normalizedapi.auth.*;
import com.trulioo.normalizedapi.models.*;
import com.trulioo.normalizedapi.api.BusinessApi;

public class Example {
  public static void main(String[] args) {
    ApiClient client = new ApiClient("-- Client ID --", "-- CLIENT SECRET --");

    BusinessApi apiInstance = new BusinessApi(client);
    BusinessSearchRequest businessSearchRequest = new BusinessSearchRequest(); // BusinessSearchRequest | 
    try {
      BusinessSearchResponse result = apiInstance.businessSearch(businessSearchRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling BusinessApi#businessSearch");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Documentation for API Endpoints

All URIs are relative to http://api.trulioo.com

Class	Method	HTTP request	Description
BusinessApi	businessSearch	POST /v3/business/search	Search
BusinessApi	businessVerify	POST /v3/business/verify	Verify
BusinessApi	getBusinessRegistrationNumbers	GET /v3/business/businessregistrationnumbers	GetBusinessRegistrationNumbers
BusinessApi	getBusinessRegistrationNumbersWithParameters	GET /v3/business/businessregistrationnumbers/{countryCode}/{jurisdictionCode}	getBusinessRegistrationNumbersWithParameters
BusinessApi	getCountryJOI	GET /v3/business/countryJOI/	GetCountryJOI
BusinessApi	getCountryJOIWithCountryCode	GET /v3/business/countryJOI/{countryCode}	getCountryJOIWithCountryCode
ConfigurationApi	getAllDatasources	GET /v3/configuration/alldatasources/{packageID}	Get All Datasources by Country
ConnectionApi	sayHello	GET /v3/connection/sayhello/{name}	SayHello
ConnectionApi	testAuthentication	GET /v3/connection/testauthentication	TestAuthentication
VerificationsApi	getDocumentDownload	GET /v3/verifications/documentdownload/{transactionRecordID}/{fieldName}	DocumentDownload
VerificationsApi	getPartialResult	GET /v3/verifications/transaction/{transactionID}/partialresult	PartialResult
VerificationsApi	getTransactionRecord	GET /v3/verifications/transactionrecord/{transactionRecordID}	GetTransactionRecord
VerificationsApi	getTransactionStatus	GET /v3/verifications/transaction/{transactionID}/status	GetTransactionStatus
VerificationsApi	verify	POST /v3/verifications/verify	Verify

Documentation for Models

• Address
• AppendedField
• Business
• BusinessDataFields
• BusinessLocation
• BusinessRecord
• BusinessRegistrationNumber
• BusinessRegistrationNumberMask
• BusinessResult
• BusinessSearchRequest
• BusinessSearchRequestBusinessSearchModel
• BusinessSearchResponse
• BusinessSearchResponseIndustryCode
• BusinessVerifyRequest
• BusinessVerifyRequestMetadata
• CommonProviderCacheSchema
• CommonRequiredFieldMetadata
• Communication
• Consent
• CountrySubdivision
• DataField
• DataFields
• DatasourceField
• DatasourceResult
• DemoPause
• Document
• DriverLicence
• Location
• LocationAdditionalFields
• LoginSchemaRequest
• NationalId
• Passport
• PersonInfo
• PersonInfoAdditionalFields
• PersonOfSignificantControl
• ProblemDetails
• Record
• RecordRule
• Result
• RiskMonitorSettings
• ServiceError
• SubmitAddressVerificationCredentialsRequest
• TransactionRecordResult
• TransactionStatus
• VerifyAddressCredentials
• VerifyAddressRequest
• VerifyAddressResult
• VerifyRequest
• VerifyRequestMetadata
• VerifyResult
• VerifyResultPartial

Documentation for Authorization

Authentication schemes defined for the API:

oAuth2

• Type: OAuth
• Flow: application
• Authorization URL: https://auth-api.globaldatacompany.com/connect/token
• Scopes: N/A

Recommendation

It's recommended to create an instance of ApiClient per thread in a multithreaded environment to avoid any potential issues.

Changelog

The CHANGELOG.md file in the root of the repository contains a description of changes for each version of the SDK.

Documentation and resources

If you need to know more:

• For more about the Trulioo REST API V3, see the REST API Reference.

• For starter guides, product information and best practices see the Documentation.

• For more about Trulioo in general, see Trulioo Website.

Support

1. You will be granted support if you or your company are already covered under an existing maintenance/support agreement. Send an email to support@trulioo.com and include "Trulioo SDK for Java V3" in the subject line.

2. Trulioo will NOT provide support for the extension if the core library has been modified. We would also like to know why you modified the code please send feedback to support@trulioo.com

Contact Us

You can reach via channels listed on Trulioo website

License

The Trulioo SDK v3 for Java is licensed under the Apache License 2.0. Details about the license can be found in the LICENSE file. Copyright 2023 Trulioo Information Services Inc. Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0. Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.