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

EmbedID (Beta)

Beta

Note that EmbedID is currently in beta. It is distributed as open source code under the Apache License 2.0.

EmbedID is a Trulioo built, React component to embed your entire Trulioo integration in a snippet of code. When you add it to your site it:

  • Accesses your Trulioo configuration to see what countries you have and what fields are available for each country.
  • From this it can generates a HTML form directly in your onboarding flow. By embedding it you simply display the form to your end-user.
  • When your end-user clicks submit EmbedID automatically builds and sends a request to Trulioo.
  • It then presents the end-user's data that was filled in, as well as the verification response in a callback that you can process to any tools of your choosing.

Pre-Requisites

  1. npm and Node installed npm install page. Note npm comes with node. Run the following on your command line/terminal to ensure it's installed:
npm -v

npm Verison

You need to have an npm version of 5.2+ to install the sample web app below in step 3. To update your version see the npm install page's 'A note on versions section'

npm errors

If you have errors running npm on windows ensure to add Node to your PATH variable, explained here: https://stackoverflow.com/a/27864253

  1. For a sample React site to try EmbedID out, React provide a sample application that is easy to install create-react-app.
npx create-react-app embedid-app
cd embedid-app
npm start

npx errors

Some users have had trouble on windows running npx, if this happens try running C:/Your_Node_Directory/npx create-react-app embedid-app

Optional/Useful

  1. A knowledge of Web development.
  2. A knowledge of React Components.

Install

With all of the pre-requisites sorted you now need to add EmbedID to your project. Also on npm, run the following command:

npm install trulioo-react

Next go to /src and edit App.js to be the following:

import React, { Component } from 'react';
import logo from './logo.svg';
import './App.css';
import EmbedID from 'trulioo-react/EmbedID'

class App extends Component {
  render() {
    const handleResponse = (e) => {
    // handle verification submission result here ...
      console.log(e);
    }

    return (
      <EmbedID url='http://localhost:5000' handleResponse={handleResponse} />
    );
  }
}

export default App;

Going back to the cmd/terminal run the following from the application's root to start:

npm start

A new tab in your browser should launch, however it needs to be able to talk to Trulioo...

Trulioo Proxy

To make requests to Trulioo's GlobalGateway - GlobalGateway - Trulioo provides a collection of API methods to help you build business processes powered by the GlobalGateway Normalized API. and get around CORS, it is required that an intermediate server (proxy) is used.

You have the option to develop your own, or simply use Trulioo-Proxy, a lightweight Node.js server maintained by Trulioo. It's hosted here:

To use this Trulioo proxy open a new cmd/terminal

git clone https://github.com/Trulioo/trulioo-proxy.git

Note: if you do not have/want to use Git you can click the Trulioo/trulioo-proxy Github link above and on the top right hand side of the screen select to Clone or Download and Download Zip.

Edit the trulioo-proxy/.env file with your username and password. If you don't have these yet, see the Keys and Authentication page.

TRULIOO_USERNAME=*YOUR USERNAME*
TRULIOO_PASSWORD=*YOUR PASSWORD*
TRULIOO_BASE_URL=https://api.globaldatacompany.com
TRULIOO_PORT=5000

Note that the TRULIOO_PORT is the port on localhost where the proxy will be waiting for requests. If you wish to change this also change the url='http://localhost:5000' line to be your new port. This is how EmbedID communicates with the proxy.

In the cmd/terminal run:

cd trulioo-proxy
node bin/trulioo-proxy

Now your proxy should be running in the background to handle requests between EmbedID and Trulioo.

Styling

EmbedID also plays really nicely with bootstrap. Adding the following line to your public/index.html will add a bootstrap theme to your form.

<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/css/bootstrap.min.css">

Verify

Now that your proxy is running in the background and EmbedID in your browser, refresh your browser tab.

  • You should see a dropdown with all of your countrycodes, select one to populate your form.
  • Fill in the data in the fields to submit to Trulioo.
  • The submit button will build the request to Trulioo and send it for you.
  • You can access the data that was filled in, as well as the verification response in the handleResponse method of App.js.