{"@context": "https://schema.org", "@type": "WebAPI", "name": "Checks API API", "description": "**NOTE:** This is a preview of the API and it is not considered stable since refinements are still being made. # Introduction Welcome to the **Truora Check** [**RESTful API**](https://en.wikipedia.org/wiki/Representational_state_transfer) reference. You may also want to check out our [**Validatio", "provider": {"@type": "Organization", "name": "truora.com"}, "documentation": "https://docs.truora.com/openapi.json"}
**NOTE:** This is a preview of the API and it is not considered stable since refinements are still being made. # Introduction Welcome to the **Truora Check** [**RESTful API**](https://en.wikipedia.org/wiki/Representational_state_transfer) reference. You may also want to check out our [**Validatio
Every row below was read from the vendor's own OpenAPI document. The summary text is theirs. What this registry adds is that each operation is indexed with its method, path, base URL and auth scheme, so a search for a capability can answer with a call rather than a name, and that the endpoint is probed on a schedule.
Specifications as held by the APIs.guru corpus, whose newest record is 2023-04-21. Operations the vendor has added since are not listed here; the origin links above are the vendor's own current documents.
base URLs: https://api.truora.com
auth: a p i k e y
find it by capability: POST /search {"query":{"text":"..."}} returns these
operations with their invocation detail. Connect any agent client.
**NOTE:** This is a preview of the API and it is not considered stable since refinements are still being made. # Introduction Welcome to the **Truora Check** [**RESTful API**](https://en.wikipedia.org/wiki/Representational_state_transfer) reference. You may also want to check out our [**Validations API docs**](https://docs.validations.truora.com/) or our [**Signals API docs**](https://docs.sign
| method | path | what the vendor says it does |
|---|---|---|
POST | /v1/behavior | Report Behavior Creates a behavior item to report employee conducts that do not or might not be included in th |
GET | /v1/checks | List Checks Lists the existing checks in the account or in a specified report. checks |
POST | /v1/checks | Create a background check Creates a background check and queues it to start collecting information. The full d |
GET | /v1/checks/health | Get Health Dashboard Get the status of a database checks |
GET | /v1/checks/{check_id} | Get Background Check Returns the results of the check that matches the ID provided, complete with a set of sco |
GET | /v1/checks/{check_id}/details | List Check Details Lists all details associated with a Check. It can be paginated. checks |
GET | /v1/checks/{check_id}/pdf | Get PDF Downloads the PDF in the specified language, Spanish by default. pdf |
POST | /v1/checks/{check_id}/pdf | Create PDF Creates a PDF containing the background check results. pdf |
GET | /v1/config | List Score Configurations Lists the custom score configurations of the associated account. custom-type |
POST | /v1/config | Create Score Configurations Create a custom score configuration selecting the weight for each background check |
PUT | /v1/config | Update Custom Type Allows updating a custom type. Person, vehicle, and company types are not modifiable custom |
DELETE | /v1/config | Delete Custom Type Allows deleting a custom type. Person, vehicle, and company types cannot be deleted custom- |
GET | /v1/continuous-checks | Lists all continuous checks continuous |
POST | /v1/continuous-checks | Creates a continuous check that will run background checks recurrently according to the frequency provided. co |
GET | /v1/continuous-checks/{continuous_check_id} | Lists history associated with a Check. It can be paginated continuous |
PUT | /v1/continuous-checks/{continuous_check_id} | Updates a continuous check continuous |
GET | /v1/continuous-checks/{continuous_check_id}/history | Lists background check logs. It can be paginated continuous |
GET | /v1/hooks | Lists all hooks Lists all the configured hooks in your account. hooks |
POST | /v1/hooks | Creates a hook subscription Creates a hook subscription to notify events in Truora plataform. Subscriptions br |
PUT | /v1/hooks/{hook_id} | Updates hook Updates a hook configuration. hooks |
DELETE | /v1/hooks/{hook_id} | Deletes hook Deletes hook configuration. hooks |
GET | /v1/reports | List Reports Lists all reports asociated with the client or user requesting. reports |
POST | /v1/reports | Create Report Creates a Report to which it is possible to associate multiple Checks. reports |
GET | /v1/reports/{report_id} | Get Report Returns a report with the given ID. reports |
POST | /v1/reports/{report_id}/upload | Batch Upload Upload multiple checks and associate them to the report. The inputs for these checks must be sent |
specification origin: https://docs.truora.com/openapi.json
nothing on this page is a rating, an endorsement or a claim about quality. Reachability is what our probes observed from one network; answering is a floor under usefulness, not a measure of it.