← Back to catalog

Other

Checks

auto-generated
swirls add truora
actionPOSTv1.0.0

Create a background check

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. | Country | Person-National | PersonForeigner | Company | Vehicle-National | Vehicle-Foreigner | |:-------:|:---------------:|:---------------:|:-------:|:----------------:|:-----------------:| | Chile<br>CL | national_id*<br>date_of_birth<br>phone_number | foreign_id*<br>date_of_birth*<br>phone_number<br>first_name*<br>last_name*<br>native_country* | N/A | national_id*<br>license_plate*<br>payment_date (Santiago only)<br>driver_license (Santiago only) | foreign_id*<br>first_name*<br>last_name*<br>date_of_birth*<br>native_country*<br>license_plate*<br>payment_date (Santiago only)<br>driver_license (Santiago only) | | Colombia<br>CO | national_id*<br>date_of_birth<br>issue_date<br>phone_number | foreign_id* or PEP*<br>date_of_birth<br>phone_number<br>issue_date* | tax_id*<br>national_id | national_id*<br>date_of_birth<br>phone_number<br>license_plate*<br>owner_document_type<br>owner_document_id | foreign_id*<br>date_of_birth<br>phone_number<br>license_plate*<br>issue_date* | | Mexico<br>MX | national_id*<br>phone_number | foreign_id* | tax_id* | license_plate*<br>national_id<br>vehicle_id<br>driver_license(Estado de Mexico only) | N/A | | Brazil<br>BR | national_id*<br>date_of_birth*<br>region*<br>phone_number | N/A | tax_id* | license_plate* | N/A | | Costa Rica<br>CR | national_id*<br>phone_number | foreign_id* | N/A | license_plate* | N/A | | Ecuador<br>EC | national_id*<br>phone_number | foreign_id* | tax_id* | license_plate* | N/A | | Peru<br>PE | national_id*<br>date_of_birth<br>phone_number | foreign_id*<br>ptp<br>date_of_birth*<br>phone_number | N/A | national_id*<br>date_of_birth<br>license_plate* | foreign_id*<br>ptp<br>date_of_birth*<br>license_plate* | | Argentina<br>AR | national_id* | N/A | N/A | national_id* | N/A | | International<br>ALL | name* | name* | company_name* | N/A | N/A | (*) Required field

Source
actionPOSTv1.0.0

Create PDF

Creates a PDF containing the background check results.

Source
actionPOSTv1.0.0

Create Report

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

Source
actionPOSTv1.0.0

Create Score Configurations

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.

Source
actionPOSTv1.0.0

createContinuousCheck

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

Source
actionPOSTv1.0.0

Creates a hook subscription

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.

Source
actionDELETEv1.0.0

Delete Custom Type

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

Source
actionDELETEv1.0.0

Deletes hook

Deletes hook configuration.

Source
actionGETv1.0.0

Get Background Check

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.

Source
actionGETv1.0.0

Get PDF

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

Source
actionGETv1.0.0

Get Report

Returns a report with the given ID.

Source
actionGETv1.0.0

GetContinuousCheck

Lists history associated with a Check. It can be paginated

Source
actionGETv1.0.0

List Check Details

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

Source
actionGETv1.0.0

List Checks

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

Source
actionGETv1.0.0

List Reports

Lists all reports asociated with the client or user requesting.

Source
actionGETv1.0.0

Lists all hooks

Lists all the configured hooks in your account.

Source
actionPOSTv1.0.0

Report Behavior

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 <table> <tr> <td style="width: 100px"><center><b>Very High</b><br>(Score: 1)</td> <td>Rape, Drug Dealing, Sexual Harassment</td> </tr> <tr> <td><center><b>High</b><br>(Score: 0.8)</td> <td>Theft, Fights, Aggressive Behaviour, Identity Fraud, Drunk, Drug Possession</td> </tr> <tr> <td><center><b>Medium</b><br>(Score: 0.6)</td> <td>Absences</td> </tr> <tr> <td><center><b>Low</b><br>(Score: 0.4)</td> <td>Tardiness, Confidentiality Breach</td> </tr> <tr> <td><center><b>None</b><br>(Score: 0)</td> <td>Good Reputation</td> </tr> <tr> <td><center><b>Unknown</b></td> <td>No information</td> </tr> </table> **NOTE:** If the reason of your report is not here, please contact Truora support team.

Source
actionPUTv1.0.0

Update Custom Type

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

Source
actionPUTv1.0.0

Updates hook

Updates a hook configuration.

Source
Beyond the catalog

Any provider, on request.

01

Request it

Tell us which provider you need, and we will ship it in the registry.

02

Generate it

Point swirls add at an OpenAPI or GraphQL spec. Typed actions for any API you hold credentials for, today.

acme · integrations
terminal
~/acme $swirls add linear
✓ 12 typed actions · scopes and schemas included
 
~/acme $swirls add https://api.acme.dev/openapi.json
◆ Fetched spec · 38 operations
✓ 6 typed actions · generated from spec