The Trulioo API works using RESTful architecture and only supports HTTPS for its main endpoint. Make sure all requests to this endpoint meet SSL/TLS standards. Use the correct base URL for accessing the API.
Data sent and received by the API must be in JSON format. The JSON structure might change over time as new fields are added, so don't rely on the order of data in responses. Set the Content-Type header in your requests to "application/json; charset=utf-8".
The API uses standard HTTP features like authentication and error handling that are familiar to most HTTP clients. For faster responses, include an Accept-Encoding header with the value "gzip, deflate" to receive compressed data.
What the Reference Section Includes
This section serves as a technical manual for all the APIs we offer. This reference includes:
Error documentation
- Endpoints organized by product.
- Detailed descriptions, parameters, and examples for each endpoint.
- SDK and API Library information (on this page)
-
Rate Limits and Usage Policies
Trulioo's API rate limits are designed to be very accommodating and flexible, allowing most clients to use the service without any issues. If you ever find yourself needing more capacity, our customer support team is here to help adjust the limits to better fit your needs.
SDKs and Libraries
Access our official SDKs and client libraries for various programming languages. These tools can simplify your integration process by providing pre-built methods for common API tasks, helping you save development time and effort.
The Trulioo 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. Please ensure you have the correct base URL for the API.
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.
Our API Libraries are user-friendly and support various programming languages like Java, .NET, PHP, Python, and Ruby. They simplify integration of Trulioo's identity verification services, whether you're improving customer onboarding, meeting regulations, or boosting security. Our documentation offers clear instructions for installing, configuring, and using these libraries, ensuring you can start smoothly and efficiently.
C#
To install the C# API Library, run the following command in the Package Manager Console .
Install-Package Trulioo.Client.V3
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-v3</artifactId>
<version>[3.0.0,)</version>
</dependency>
Gradle
To install using Gradle, declare the following under dependencies in your build.gradle script:
compile "com.trulioo:normalizedapi-v3:3.+"