Checks API

Create PDF Creates a PDF containing the background check results.

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

Lists history associated with a Check. It can be paginated

Get Health Dashboard Get the status of a database

Lists all continuous checks

Updates a continuous check

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

Batch Upload 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:** [Chile](https://app.truora.com/files/person/person-input-cl.xlsx), [Colombia](https://app.truora.com/files/person/person-input-co.xlsx), [Mexico](https://app.truora.com/files/person/person-input-mx.xlsx), [Peru](https://app.truora.com/files/person/person-input-pe.xlsx), [Costa Rica](https://app.truora.com/files/person/person-input-cr.xlsx), [Brazil](https://app.truora.com/files/person/person-input-br.xlsx) **Vehicle:** [Chile](https://app.truora.com/files/vehicle/vehicle-input-cl.xlsx), [Colombia](https://app.truora.com/files/vehicle/vehicle-input-co.xlsx), [Mexico](https://app.truora.com/files/vehicle/vehicle-input-mx.xlsx), [Peru](https://app.truora.com/files/vehicle/vehicle-input-pe.xlsx) **Company** [Colombia](https://app.truora.com/files/company/company-input-co.xlsx), [Mexico](https://app.truora.com/files/company/company-input-mx.xlsx), [Brazil](https://app.truora.com/files/company/company-input-br.xlsx) 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.

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 | |:-------:|:---------------:|:---------------:|:-------:|:----------------:|:-----------------:| | ChileCL | national_id*date_of_birthphone_number | foreign_id*date_of_birth*phone_numberfirst_name*last_name*native_country* | N/A | national_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) | | ColombiaCO | national_id*date_of_birthissue_datephone_number | foreign_id* or PEP*date_of_birthphone_numberissue_date* | tax_id*national_id | national_id*date_of_birthphone_numberlicense_plate*owner_document_typeowner_document_id | foreign_id*date_of_birthphone_numberlicense_plate*issue_date* | | MexicoMX | national_id*phone_number | foreign_id* | tax_id* | license_plate*national_idvehicle_iddriver_license(Estado de Mexico only) | N/A | | BrazilBR | national_id*date_of_birth*region*phone_number | N/A | tax_id* | license_plate* | N/A | | Costa RicaCR | national_id*phone_number | foreign_id* | N/A | license_plate* | N/A | | EcuadorEC | national_id*phone_number | foreign_id* | tax_id* | license_plate* | N/A | | PeruPE | national_id*date_of_birthphone_number | foreign_id*ptpdate_of_birth*phone_number | N/A | national_id*date_of_birthlicense_plate* | foreign_id*ptpdate_of_birth*license_plate* | | ArgentinaAR | national_id* | N/A | N/A | national_id* | N/A | | InternationalALL | name* | name* | company_name* | N/A | N/A | (*) Required field

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

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.

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

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.

Deletes hook configuration.

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.

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

Get Report Returns a report with the given ID.

Lists background check logs. It can be paginated

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

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

Lists all hooks Lists all the configured hooks in your account.

List Reports Lists all reports asociated with the client or user requesting.

List Score Configurations Lists the custom score configurations of the associated account.

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 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 Unknown No information **NOTE:** If the reason of your report is not here, please contact Truora support team.

Updates hook Updates a hook configuration.