Welcome to the Trulioo Platform Developer Documentation for Normalized API 1.0. This page hosts documentation for the developer lifecycle. The Trulioo Platform provides secure access to over 400 data sources worldwide. You can verify 5 billion people and 250 million business entities in real-time. Onboard customers faster and easier with our robust API documentation, trusted and vetted data sources, normalized data fields, and an easy RESTful API integration.
Developer Documentation Structure
The documentation has been arranged to make the information you need as easy to find as possible. The navigation bar to the left shows the main product offerings of the Trulioo Platform. Every Trulioo solution documentation has the following sections:
Overview - The overviews for the Trulioo Platform have three main product offerings: Electronic Identity Verification, Document Verification, and Business Verification.
Each overview links out to subpages describing common workflows or any other information that you may need.
Integration Guides - The Integration Guides for each solution is displayed with API integration recipes that will help in integrating our solutions easily and quickly.
Sample Use Case - Under each solution we have a sample use case. Each Use Case is represented by a sequence of simple steps, beginning with a goal and ending when that goal is fulfilled.
Best Practices & Help Guide - The Best Practices guide in each section consists of a set of guidelines, ethics, that represent the most efficient or prudent course of action for Trulioo solutions.
Technical Overview
The Trulioo Platform Normalized API (NAPI) is a stateless web service based on RESTful architecture. The production endpoint is supported solely on HTTPS. All requests to the production endpoint must be SSL/TLS compliant. Please ensure you have the base URL .
Request and response body data are required to be in JSON format. The output JSON should not be treated as fixed or as a schema. New fields can 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. The Content-Type header value must be set to application/json; charset=utf-8
We use built-in HTTP features, such as HTTP authentication, errors, and verbs that 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.
Trulioo solutions can be integrated in a simple four step method (with details explained after) as described in the workflow below:
1) Trulioo Platform API Login
Intended for customer applications to make Verification calls.
Before testing the API the most important thing you will need is credentials. You can contact Trulioo support to receive live API credentials. You will need a username and password for authenticating your API calls. NAPI uses HTTP Basic Authentication.
2) Making a Test Verification
Sandbox
If this is your first integration with Trulioo Platform you should have access to a sandbox account. If you are unsure whether you have a sandbox environment, or how to access it, please refer to Sandbox vs. Live Environment.
The sandbox environment is intended to let you get a feel for how the Trulioo Platform API works, but does not perform live transactions against real data. Rather, it checks the given identity against a static test database hosted on Trulioo Platform. For this reason you will need to use a test entity.
Test Entities
A test entity is a dummy identity provided by Trulioo, which matches a record in the Trulioo Platform test database. Test entities can be safely verified in sandbox accounts without having any impact on real people or data.
To obtain test entity data: Make a Trulioo Platform API call to Get Test Entities.
Live API
Once you have completed your initial test of the API, you can contact Trulioo support to receive live API credentials. This will allow you to begin checking identities against live datasources, rather than the Trulioo Platform hard-coded test entities.
3) API Integration
Let's start with verifying your first individual through the Trulioo Trulioo Platform API. Each step builds upon the one before it, letting you in succession with a Trulioo solution. To get started with the API integration, refer to our Global API page for more information.
4) Implementation & Go Live:
Ready to make the first move?
At any point, if you are considering expanding or updating your integrations, you can refer back to the API Reference. It provides detailed documentation for all the endpoints for the Trulioo Platform API and has an interactive web console so you can make your initial test calls straight from the browser.
The Implementation team will be there every step of the way to help lead you through the process of going live and ensure you have a seamless and timely launch.
Note: If you wish to go Live with our Trulioo Solutions, please contact the Trulioo Sales Team