integrations.sh
← all integrations

Checks API

OpenAPI apis-guru location

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 reference. You may also want to check out our or our .

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": <Truora error code>,    "http_code": <The HTTP status of the response>,    "message": <The error message>}

for instance:

json
{    "code": 10404,    "http_code": 404,    "message": "The Check was not found"}

SDKs

If your favorite language was not on the next list, You can use our to generate it using the .

To download the SDK click on the desired programming language:

You can see the full list of supported platforms here:

Homepage
https://api.apis.guru/v2/specs/truora.com/1.0.0.json
Provider
truora.com
OpenAPI version
3.0.2
Spec (JSON)
https://api.apis.guru/v2/specs/truora.com/1.0.0/openapi.json
Spec (YAML)
https://api.apis.guru/v2/specs/truora.com/1.0.0/openapi.yaml

Tools (27)

Extracted live via the executor SDK.

  • behavior.reportBehavior

    Creates 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 negative behaviors and sorts them by severity.

    Reasons to report a person

    Very High
    (Score: 1)    		Rape, Drug Dealing, Sexual Harassment
    High
    (Score: 0.8)    		Theft, Fights, Aggressive Behaviour, Identity Fraud, Drunk, Drug Possession
    Medium
    (Score: 0.6)    		Absences
    Low
    (Score: 0.4)    		Tardiness, Confidentiality Breach
    None
    (Score: 0)    		Good Reputation
    UnknownNo information

    NOTE: If the reason of your report is not here, please contact Truora support team.

  • checks.createCheck

    Creates a background check and queues it to start collecting information. The full details of background checks can be retrieved with their respective Check IDs using getCheck endpoint. Keep in mind that, depending on the check type, input document, and country of a search, certain inputs are required. You should always provide as many inputs as possible in order to get the highest accuracy.

    If your check type is not referenced in the following table, please reach out to find out the fields that apply for you.

    CountryPerson-NationalPersonForeignerCompanyVehicle-NationalVehicle-Foreigner
    Chile
    CL    		national_id*
    date_of_birth
    phone_number    		foreign_id*
    date_of_birth*
    phone_number
    first_name*
    last_name*
    native_country*    		N/Anational_id*
    license_plate*
    payment_date (Santiago only)
    driver_license (Santiago only)    		foreign_id*
    first_name*
    last_name*
    date_of_birth*
    native_country*
    license_plate*
    payment_date (Santiago only)
    driver_license (Santiago only)
    Colombia
    CO    		national_id*
    date_of_birth
    issue_date
    phone_number    		foreign_id* or PEP*
    date_of_birth
    phone_number
    issue_date*    		tax_id*
    national_id    		national_id*
    date_of_birth
    phone_number
    license_plate*
    owner_document_type
    owner_document_id    		foreign_id*
    date_of_birth
    phone_number
    license_plate*
    issue_date*
    Mexico
    MX    		national_id*
    phone_number    		foreign_id*tax_id*license_plate*
    national_id
    vehicle_id
    driver_license(Estado de Mexico only)    		N/A
    Brazil
    BR    		national_id*
    date_of_birth*
    region*
    phone_number    		N/Atax_id*license_plate*N/A
    Costa Rica
    CR    		national_id*
    phone_number    		foreign_id*N/Alicense_plate*N/A
    Ecuador
    EC    		national_id*
    phone_number    		foreign_id*tax_id*license_plate*N/A
    Peru
    PE    		national_id*
    date_of_birth
    phone_number    		foreign_id*
    ptp
    date_of_birth*
    phone_number    		N/Anational_id*
    date_of_birth
    license_plate*    		foreign_id*
    ptp
    date_of_birth*
    license_plate*
    Argentina
    AR    		national_id*N/AN/Anational_id*N/A
    International
    ALL    		name*name*company_name*N/AN/A

    (*) Required field

  • checks.getCheck

    Returns the results of the check that matches the ID provided, complete with a set of scores explained below.

    Scores:

    • Global Score: Average risk associated with a person, company or vehicle, according to the background check results. The global score considers results that are validated with the ID number provided. The score ranges from 0 to 1, where 0 represents high risk and 1 low risk.

    • ID Score: Average risk associated with a person according to the background check results. The ID score considers the results that are validated with a person identity document. The score ranges from 0 to 1, where 0 represents high risk and 1 low risk.

    • Homonym Score: Average risk associated with a person according to the background check results. The homonym score considers results that are validated against the name of a person and could not be validated with their ID number. These results might have homonyms associated with them. The score ranges from 0 to 1, where 0 represents high risk and 1 low risk.

    In order to calculate these scores, a weighted average is considered with different weights allocated to each dataset. Scores can be customized using the config endpoints by assigning a weight to each dataset according to its relevance.

    Keep in mind that results from the API vary depending on the country, check type and the inputs entered on check creation.

  • checks.getHealthDashboard

    Get the status of a database

  • checks.listCheckDetails

    Lists all details associated with a Check. It can be paginated.

  • checks.listChecks

    Lists the existing checks in the account or in a specified report.

  • continuous.createContinuousCheck

    Creates a continuous check that will run background checks recurrently according to the frequency provided.

  • continuous.getContinuousCheck

    Lists history associated with a Check. It can be paginated

  • continuous.getV1ContinuousChecksContinuousCheckIdHistory

    Lists background check logs. It can be paginated

  • continuous.listContinuousChecks

    Lists all continuous checks

  • continuous.updateContinuousCheck

    Updates a continuous check

  • customType.createScoreConfig

    Create a custom score configuration selecting the weight for each background check dataset and the country where it applies. Weights are numbers between 0 and 1 that represent how impactful the dataset is for the score. Keep in mind that the sum of all weights must equal 1.

  • customType.deleteCustomType

    Allows deleting a custom type. Person, vehicle, and company types cannot be deleted

  • customType.listScoreConfigs

    Lists the custom score configurations of the associated account.

  • customType.updateCustomType

    Allows updating a custom type. Person, vehicle, and company types are not modifiable

  • hooks.createHook

    Creates a hook subscription to notify events in Truora plataform. Subscriptions broadcast data as events occur and additional subscription instances are not required in order to refresh the information. Events are received in an array as a JWT and are decoded using the signing key returned by this endpoint. Their structure is as follows:

    {    "events": [        {            "event_action": "created",            "event_type": "check",            "id": "HKEdd28c569cf5eb74e45f0f4c092096e62c1c95ba2",            "object": {                "check_id": "CHK9c39003424c521aec8566ce59e1ddc86",                "country": "CO",                "creation_date": "2020-04-01T23:00:30.581232281Z",                "homonym_score": 0,                "id_score": 0,                "national_id": "1151959906",                "previous_check": "CHK4ec814fecd147eaae41027081d7d5caf",                "score": -1,                "status": "not_started",                "type": "person",                "update_date": "2020-04-01T23:00:30.680937413Z"            },            "timestamp": "2020-04-01T23:00:30Z",            "version": "1.0"        }    ],    "iat": 1585782031,    "iss": "Truora"}

    Keep in mind that the object attribute varies depending on the event_type.

  • hooks.deletHook

    Deletes hook configuration.

  • hooks.listHook

    Lists all the configured hooks in your account.

  • hooks.updateHook

    Updates a hook configuration.

  • pdf.createPdf

    Creates a PDF containing the background check results.

  • pdf.getPdf

    Downloads the PDF in the specified language, Spanish by default.

  • reports.batchUpload

    Upload 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: , , , , ,

    Vehicle: , , ,

    Company , ,

    Keep in mind that we currently do not support batch uploads for custom check types. Background checks created by batch upload are processed with low priority.

  • reports.createReport

    Creates a Report to which it is possible to associate multiple Checks.

  • reports.getReport

    Returns a report with the given ID.

  • reports.listReports

    Lists all reports asociated with the client or user requesting.

  • openapi.previewSpec

    Preview an OpenAPI document before adding it as a source

  • openapi.addSource

    Add an OpenAPI source and register its operations as tools