Hardware Sentry TrueSight Presentation Server REST API
**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 history and status of social security affiliations.
- **Alert in media**: Checks major media agencies for relevant news related to violent actions.
- **Vehicle information**: Checks for the physical characteristics of the vehicle, technical status, insurance history, and other relevant information.
- **Traffic fines**: Checks for outstanding traffic fines.
- **Driving licenses**: Shows information relevant to the driver. Such as license status and driver certificates.
- **Business background**: Checks for business status, legal and criminal history, and other relevant information.
- **Taxes and Finances**: Checks for the information related to personal finances, liabilities, and taxes.
## Requests Format
The POST requests receive a body that must be encoded in `www-x-form-urlencoded`, for instance:
```plain
type=person&national_id=123456&country=CO
```
The responses are always encoded in `JSON` format.
## Errors
Whenever there is an error, a JSON with the following format is returned:
```json
{
"code":
Access to the user API is only possible for users with a [premium](http://www.tvmaze.com/premium) account. A user can only access their own user data. Authentication uses HTTP Basic. Use the TVmaze username as authentication username, and the TVmaze API key as authentication password. Your API key can be found on your [dashboard](http://www.tvmaze.com/dashboard). To try out these API calls from this page, click the "Authorize" button on top and input your credentials.
This is the public Twilio REST API.
This is the public Twilio REST API.
This is the public Twilio REST API.
This is the public Twilio REST API.
This is the public Twilio REST API.
This is the public Twilio REST API.
This is the public Twilio REST API.
This is the public Twilio REST API.
This is the public Twilio REST API.
This is the public Twilio REST API.
This is the public Twilio REST API.
This is the public Twilio REST API.
This is the public Twilio REST API.
This is the public Twilio REST API.
This is the public Twilio REST API.
This is the public Twilio REST API.