Checks API API

Overview

**NOTE:** This is a preview of the API and it is not considered stable since refinements are still being made. # Introduction Welcome to the **Truora Check** [**RESTful API**](https://en.wikipedia.org/wiki/Representational_state_transfer) reference. You may also want to check out our [**Validations API docs**](https://docs.validations.truora.com/) or our [**Signals API docs**](https://docs.signals.truora.com/). Truora Check API allows performing full background checks on people, vehicles and companies. There are three main types of background checks: - **Personal background check**: Verifies national IDs in multiple databases of public and legal entities in the LATAM region. For every national ID, returns information on: personal identity, criminal records, international background check, and professional background. - **Vehicle background check**: Verifies the vehicle documents and the owner identity in multiple databases of public and legal entities in the LATAM region. For every vehicle and owner type, returns information on: personal identity, driving records, criminal records, and vehicle information. - **Company background check**: Verifies the tax ID or a company name in multiple databases of public and legal entities in the LATAM region. For every company, returns the associated: business status, legal and criminal records, and media reports. # API Key V1 is live! API key version 1 is now live. Users with version 0 API keys are not immediately required to upgrade to V1 but should plan to do so at their earliest convenience. The changes for integration with API keys v1 are as follows: - The field ``user_authorized`` is now required to perform person checks. This field indicates the API user has authorization to perform the check in compliance with data protection law. - The field ``homonym_scores`` is no longer included in our person check response as its results are already included in the body of the check and keeping them duplicated is generating unnecessary confusion. # API composition ## Endpoints - **Check endpoints**: Provide an easy way to create and search for a background check. They also allow inserting groups of checks into reports. Each check contains scores, datasets and databases. ```plain https://api.truora.com/v1/checks ``` - **Report endpoints**: Support batch uploads and grouping multiple checks together. Excel and .csv files are supported for batch uploads. ```plain https://api.truora.com/v1/reports ``` - **Configuration endpoints**: Allows personalizing data sets and scores for customized background checks. ```plain https://api.truora.com/v1/config ``` - **Continuous check endpoints**: Allows creating recurring checks and get notified whenever a change in the check score occurs. ```plain https://api.truora.com/v1/continuous_checks ``` - **Behavior endpoints**: Allows sharing anonymous feedback about a person behavior when interacting with the company. ```plain https://api.truora.com/v1/behaviour ``` - **Hooks endpoints**: Allows sending notifications via requests to your service or another third-party service whenever certain events occur. ```plain https://api.truora.com/v1/hooks ``` ## Datasets Categories that group the resulting information for background checks from databases are called datasets. Datasets are divided in: - **Personal identity**: Corroborates the existence and validates personal identity documents. - **Criminal record**: Checks for crimes according to each country penal code or criminal code. Keep in mind that data aged less than 10 years is usually more consistent. - **Legal background**: Checks for lawsuits filed. Keep in mind that data aged less than 10 years is usually more consistent. - **International background**: Checks international lists for crimes related to identity theft, money laundering, terrorist financing, and high crimes. - **Professional background**: Checks professional regulatory entities for relevant information. - **Affiliations and insurances**: Checks the

Checks API is a geocoding API from truora.com. Requests are authenticated with an API key. It is served over HTTPS. Its OpenAPI description documents 25 endpoints.

At a glance

Authentication

API key

HTTPS

Yes

CORS

Unknown

Category

Geocoding

Base URL

https://api.truora.com

Version

1.0.0

Endpoints

25

OpenAPI

Specification ↗

Spec updated

2021-08-16

Make a first request

Replace the placeholders; the documentation says exactly where credentials go.

curl -X GET "https://api.truora.com/v1/checks" \
  -H "Accept: application/json" \
  -H "X-API-Key: YOUR_API_KEY"

const response = await fetch("https://api.truora.com/v1/checks", {
  method: "GET",
  headers: {
    "Accept": "application/json",
    "X-API-Key": "YOUR_API_KEY",
  },
});
const data = await response.json();
console.log(data);

import requests

response = requests.request(
    "GET",
    "https://api.truora.com/v1/checks",
    headers={
    "Accept": "application/json",
    "X-API-Key": "YOUR_API_KEY",
    },
    timeout=30,
)
print(response.json())

Endpoints

Questions