Checks 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…
Maps & location#openapi#location
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
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 reference. You may also want to check out our Validations API docs or our Signals API docs.
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_authorizedis 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_scoresis 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.
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.
https://api.truora.com/v1/reports- Configuration endpoints: Allows personalizing data sets and scores for customized background checks.
https://api.truora.com/v1/config- Continuous check endpoints: Allows creating recurring checks and get notified whenever a change in the check score occurs.
https://api.truora.com/v1/continuous_checks- Behavior endpoints: Allows sharing anonymous feedback about a person behavior when interacting with the company.
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.
https://api.truora.com/v1/hooksDatasets
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:
type=person&national_id=123456&country=COThe responses are always encoded in JSON format.
Errors
Whenever there is an error,…
Endpoints 25
checks
- GETList Checks
/v1/checks?start_key=string&report_id=stringLists the existing checks in the account or in a specified report. - POSTCreate a background check
/v1/checksCreates a background check and queues it to start collecting information. The full details of background checks can be retrieved with their respective Check… - GETGet Health Dashboard
/v1/checks/health?country=string&unixTimestampSeconds=string&unixtimezoneOffsetSeconds=stringGet the status of a database - GETGet Background Check
/v1/checks/:check_idReturns the results of the check that matches the ID provided, complete with a set of scores explained below. Scores: Global Score: Average risk associated… - GETList Check Details
/v1/checks/:check_id/details?start_key=string&lang=stringLists all details associated with a Check. It can be paginated.
reports
- GETList Reports
/v1/reports?start_key=string&username=stringLists all reports asociated with the client or user requesting. - POSTCreate Report
/v1/reportsCreates a Report to which it is possible to associate multiple Checks. - GETGet Report
/v1/reports/:report_idReturns a report with the given ID. - POSTBatch Upload
/v1/reports/:report_id/uploadUpload multiple checks and associate them to the report. The inputs for these checks must be sent in an xlsx file, please use the following templates: Person:…
custom-type
- GETList Score Configurations
/v1/config?start_key=stringLists the custom score configurations of the associated account. - PUTUpdate Custom Type
/v1/configAllows updating a custom type. Person, vehicle, and company types are not modifiable - POSTCreate Score Configurations
/v1/configCreate a custom score configuration selecting the weight for each background check dataset and the country where it applies. Weights are numbers between 0 and… - DELETEDelete Custom Type
/v1/config?type=string&country=BRAllows deleting a custom type. Person, vehicle, and company types cannot be deleted
behavior
- POSTReport Behavior
/v1/behaviorCreates a behavior item to report employee conducts that do not or might not be included in their background check. This report includes both possitive and…
hooks
- GETLists all hooks
/v1/hooksLists all the configured hooks in your account. - POSTCreates a hook subscription
/v1/hooksCreates a hook subscription to notify events in Truora plataform. Subscriptions broadcast data as events occur and additional subscription instances are not… - PUTUpdates hook
/v1/hooks/:hook_idUpdates a hook configuration. - DELETEDeletes hook
/v1/hooks/:hook_idDeletes hook configuration.
continuous
- GETListContinuousChecks
/v1/continuous-checksLists all continuous checks - POSTcreateContinuousCheck
/v1/continuous-checksCreates a continuous check that will run background checks recurrently according to the frequency provided. - GETGetContinuousCheck
/v1/continuous-checks/:continuous_check_idLists history associated with a Check. It can be paginated - PUTUpdateContinuousCheck
/v1/continuous-checks/:continuous_check_idUpdates a continuous check - GETGET /v1/continuous-checks/{continuous_check_id}/history
/v1/continuous-checks/:continuous_check_id/historyLists background check logs. It can be paginated
- GETGet PDF
/v1/checks/:check_id/pdf?lang=stringDownloads the PDF in the specified language, Spanish by default. - POSTCreate PDF
/v1/checks/:check_id/pdfCreates a PDF containing the background check results.
API details
- Base URL
https://api.truora.com- Authentication
- An API key in the Truora-API-Key header
- Operations
- 25 operations on 15 pathsGET 12POST 8PUT 3DELETE 2
- Main resources
- checks 5continuous 5custom-type 4hooks 4reports 4pdf 2behavior 1
- Response formats
application/jsonapplication/x-www-form-urlencodedpdf- Description format
- OpenAPI 3.0.2, API version
1.0.0 - Links
- OpenAPI document · Terms of service · Support
- Listed from
- APIs.guru OpenAPI Directory (CC0-1.0)
Source updated
How to test the Checks API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Checks API collection, without the publisher's secrets.
- Add your credentialsThis API uses an API key in the Truora-API-Key header. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “List Checks” (GET /v1/checks?start_key=string&report_id=string), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Checks 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… It is listed under Maps & location and has 25 endpoints.
Who publishes the Checks API?
It is listed from Truora's public API description (an OpenAPI document), not published by Truora on Swastik Codes. Anyone who controls truora.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Checks API?
Requests go to https://api.truora.com. Endpoint paths are added to this base URL.
How do I authenticate with the Checks API?
With an API key in the Truora-API-Key header.
How many endpoints does the Checks API have?
25 operations on 15 paths (12 GET, 8 POST, 3 PUT, 2 DELETE). The largest groups are checks, continuous, custom-type, hooks.
Is forking the Checks API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.