Clearance is a digital evidence management system that helps organizations securely collect, manage, review, and share digital evidence from a single application. All components of Clearance are developed using publicly available APIs that can be used to integrate to third-party incident and risk reporting systems, computer-aided dispatch (CAD) applications, discovery systems, body cameras, and more.
The application is built with an open architecture to allow users to centralize media and files across the variety of sources that organizations regularly use across their operations.
Clearance is designed using the "API First" development principle for all aspects of the service. All APIs are RESTful web services and respect the OpenAPI Specification (OAS) which define a language-agnostics interface to cloud services. APIs are built with Swagger, and sample code is available for reference in C#.
Before reading this API documentation, it is recommended to watch the following tutorial videos:
Also, we recommend that you request a demo account so you can test the APIs with it.
Clearance is a multi-tenant cloud service deployed in several Datacenters such as USA, US-Gov, Europe, Canada, and Australia. Each datacenter instance is stand-alone and entirely independent from the other instances.
When working with the API, the API endpoints do not have a fixed URL for all the tenants, but vary based on their datacenter. The list of endpoints is provided in the JSON Connection File when creating a service account on a Clearance tenant.
The customer account (Clearance Tenant) is provisioned in one of the Clearance datacenters based on the location of the customer. For example, if a customer account is in Europe, the servers managing that customer's data are in one of the Europeans datacenters.
Clearance's back-end is composed of several micro-services that each implement a portion of Clearance. Therefore, the number of API endpoints depends on the type of services you are accessing.
Here is an overview of the different API endpoints that are available.
The documentation shows examples where a variable name hides the base URL of the different services. This is a reminder to avoid hardcoding the base URL in your code, as it varies depending on the Clearance datacenter associated with your account.
Developer accounts are always created in the US datacenters but the real production account might be in a different datacenter with a different set of URLs.
When you have a Clearance account, you can create a service user and download the JSON Connection File, which includes all the required URL endpoints to communicate with the platform.