/v1/behavior

Report Behavior

/v1/checks

List Checks

• start_key (query) — Start key value for the pagination
• report_id (query) — Report id checks to be returned

/v1/checks

Create a background check

• Truora-Priority (header) — Describes the background check priority. The amount of high priority checks is limited by country. Medium priority is used by default

/v1/checks/health

Get Health Dashboard

• country (query) — Country in ISO 3166, uppercase
• unixTimestampSeconds (query) — Unix timestamp in seconds. Send a day timestamp to view the database hourly status for that day or send the current time to know the current database status
• unixtimezoneOffsetSeconds (query) — Offset between the local time and the UTC time in seconds. (e.g., Colombia is at UTC -18000 seconds)

/v1/checks/{check_id}

Get Background Check

• check_id (path, required) — Check ID

/v1/checks/{check_id}/details

List Check Details

• start_key (query) — Start key value for the pagination
• lang (query) — This parameter is used to specify the language wanted for details, if not specified details will come in their original language.

/v1/checks/{check_id}/pdf

Get PDF

• lang (query) — Used to specify the language for the PDF, if not specified the PDF will be downloaded in Spanish.
• check_id (path, required) — ID of the check

/v1/checks/{check_id}/pdf

Create PDF

• check_id (path, required) — ID of the check

/v1/config

Delete Custom Type

• type (query, required) — Name of the custom type to be deleted
• country (query) — Country where the custom type is valid

/v1/config

List Score Configurations

• start_key (query) — The key to start the pagination

/v1/config

Create Score Configurations

/v1/config

Update Custom Type

/v1/continuous-checks

Lists all continuous checks

/v1/continuous-checks

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

/v1/continuous-checks/{continuous_check_id}

Lists history associated with a Check. It can be paginated

/v1/continuous-checks/{continuous_check_id}

Updates a continuous check

/v1/continuous-checks/{continuous_check_id}/history

Lists background check logs. It can be paginated

• continuous_check_id (path, required)

/v1/hooks

Lists all hooks

/v1/hooks

Creates a hook subscription

/v1/hooks/{hook_id}

Deletes hook

• hook_id (path, required) — Hook ID

/v1/hooks/{hook_id}

Updates hook

• hook_id (path, required) — Hook ID

/v1/reports

List Reports

• start_key (query) — Start value for pagination.
• username (query) — filter reports created by the specified username

/v1/reports

Create Report

/v1/reports/{report_id}

Get Report

/v1/reports/{report_id}/upload

Batch Upload