Use the Check Type Person

Truora’s Background Checks, referred to as “checks” from now on, is a tool that allows for swift inspection of public records across various categories. The tool offers three default check types. This guide provides information specifically on the Person type.

Person: verifies national_id in multiple databases of public and legal entities in the LATAM region. For every national_id, it returns information on personal identity, criminal records, international background check, and professional background.

It is important to note that the Check type Person, has a different dataset and score for each country. If you want to learn more about this configuration, please create a GET request using the following https://api.checks.truora.com/v1/config. E.g: this is the configuration for Colombia:

Response 200


{
    "CO": {
        "person": [
                    {
                        "data_set": "personal_identity",
                        "weight": 0.2
                    },
                    {
                        "data_set": "criminal_record",
                        "weight": 0.6
                    },
                    {
                        "data_set": "legal_background",
                        "weight": 0.1
                    },
                    {
                        "data_set": "international_background",
                        "weight": 0.1
                    },
                    {
                        "data_set": "professional_background",
                        "weight": 0
                    },
                    {
                        "data_set": "affiliations_and_insurances",
                        "weight": 0
                    },
                    {
                        "data_set": "alert_in_media",
                        "weight": 0
                    },
                    {
                        "data_set": "taxes_and_finances",
                        "weight": 0
                    }
                ],
        }
}

Create a New Check

Create a POST request with the next URL: https://api.checks.truora.com/v1/checks. You can also refer to our API Reference.
Add the next headers
- Truora-API-Key: <api key> Get an API key
- Content-Type: application/x-www-form-urlencoded
Add the following key : values params in the request body and x-www-form-urlencoded format:
- type: Background check type. For example: Person If you want to perform a custom check, please refer to this guide
- force_creation: Defines the behavior of the API when creating a background check with the same input values used for a recently created background check. When true, forces the creation of a new background check; otherwise, it returns the result of the background check created earlier. Recommended: false.
- user_authorized: [Required] Must be true in order to proceed. Indicates that the person subject to the validation, authorizes the use and processing of their personal data, in the background check and/or Digital Identity validation processes. Must be true in order to proceed.
- country: The country where the validation is to be performed. Allowed: ALL,CO, CL, MX, BR,PE or CR.
- national_id: [Required] National ID to check

Note You can add more inputs for this checks please see our API Reference.

Response 200


{
    "check": {
        "check_id": "CHK198e142cdd582a613bb96ff5748fxxxx",
        "country": "CO",
        "creation_date": "2021-03-25T21:24:29.076788029Z",
        "homonym_score": 0,
        "id_score": 0,
        "previous_check": "CHKe04a7ab9ac5976153d8b69eabexxxx",
        "score": -1,
        "status": "not_started",
        "update_date": "2021-03-25T21:24:29.195834574Z",
        "billing_hub": "XXXXXXXXXXX",
        "national_id": "XXXXXXXXXXX",
        "type": "person"
    },
    "details": "/v1/checks/CHK198e142cdd582a613bb96ff5748f500d/details",
    "self": "/v1/checks/CHK198e142cdd582a613bb96ff5748f500d"
}

Get Check

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

Create a POST request with the next URL: https://api.checks.truora.com/v1/checks/{{check_id}}. You can also refer to our API Reference.
Add the next headers
- Truora-API-Key: <api key> Get an API key
- Content-Type: application/x-www-form-urlencoded
Scores:
- Global Score: Average risk associated with a person 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.
- Name Score: Average risk associated with a person according to the background check results. The name 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. For more information see this guide.

Get Check Details

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

Create a POST request with the next URL: https://api.checks.truora.com/v1/checks/{{check_id}}/details. You can also refer to our API Reference.
Add the next headers
- Truora-API-Key: <api key> Get an API key
- Content-Type: application/x-www-form-urlencoded
Set the following key : values within the request Query Params.
- start_key: start_key value for pagination. if you want to go to the previous or next page.
- report_id: Report id checks to be returned.

Possible statuses for a database

not_started: it’s the initial status
in_progress: it’s the status when a database response the result is pending, but this result can’t be set by collectors, so this status is not often used.
delayed: it’s the status when the database is making the search but we are waiting for another service response, for instance: captcha service, a partner, etc.
skipped: it’s the status when the check hasn’t all necessary inputs to search on the database.
error: it’s the status when the check tried to be searched on the database, but we obtained an error.
expired: it’s the status when the search couldn’t be completed before timeout.
completed: it’s the status when the check was searched on the database.

Receive results of the checks performed on users

The results are reported using webhooks that are configured from the dashboard. The information in the webhook contains the results of the checks, and you can receive different events. Additionally, you can create labels to filter different rules depending on the values that check variables may take. For example, you may want to filter checks for only types ‘person’ or ‘vehicle’. Please review this guide Creating a rule to trigger actions for more information.