Creating a Background Check

Use the API to create a check.

Let’s make our first background check to help illustrate the usage of our API. The following requisites must be met in order to proceed:

Truora API-Key: grants access to our services, reach out to our sales team to get a demo API-key if you don’t have one already. Postman: a collaboration tool for API development. Although it is not required to perform the integration, it helps to perform tests along the way.

Follow these steps to perform a background check:

  1. Create a POST request to https://api.checks.truora.com/v1/checks in Postman.
  2. Click the Headers tab. Create a new key named Truora-API-Key.
  3. Set the value for Truora-API-Key as your Truora API-key.
  4. Create a new key named Content-Type.
  5. Set the value for Content-Type as application/x-www-form-urlencoded.
  6. Click the Body tab. Tick the x-www-form-urlencoded box.
  7. Create a new key named national_id.
  8. Set the value for national_id as your ID card number (numbers only, CC for Colombia, CURP for Mexico, DNI for Peru and so on).
  9. Create a new key named country and set its value to your country, CO for Colombia, MX for Mexico, BR for Brazil. Check the create check section for the complete list.
  10. Create a new key named type and set its value to person (If you created a Custom Type and want to use it, set the value to its name instead).
  11. For background checks in Brazil, create a new key named date_of_birth and set its value to your date of birth.
  12. Create a new key named user_authorized and set its value to true. This indicates that you have the authorization of the person to be checked and is mandatory in order to comply with data protection laws.
  13. Create a new key named force_creation and set its value to true. This forces the creation of a check on the person rather than searching for a previous check.
  14. Click Send. The API returns a response in JSON format. Copy the check_id from the response.
  15. Create a GET request to https://api.checks.truora.com/v1/checks/{{check_id}}.
  16. Replace {{check_id}} with the check_id from the response.
  17. Click the Headers tab. Create a new key named Truora-API-Key.
  18. Set the value for Truora-API-Key as your Truora API-key.
  19. Click Send. The API returns a response in JSON format containing the check result.
  20. Click Send to refresh the response in case some results are missing, the time it takes for results to be ready varies between countries and depends on the availability of the databases we use.
  21. Additionally, You can look at the check details by creating a GET request to https://api.checks.truora.com/v1/checks/{check_id}/details and replacing {{check_id}} with the check_id from the response.