Home
Genetec ClearID User Guide
Learn how to set up and use ClearID in Security Center SaaS.
Synchronizing data
Learn how to connect ClearID to other systems.
Synchronizing identities using an API
Use the Genetec ClearID™ API to code your own solutions to automate various functions in ClearID. The primary use for the REST API is synchronizing identities. However, many other scenarios are also possible.
About the ClearID API
The Genetec ClearID™ API is an Application Programming Interface that developers can use to help customers and partners integrate additional software or perform custom functions.

Deployment guide
Learn how to install and connect your Security Center SaaS application.
User guide
Learn about Security Center SaaS.
Genetec ClearID User Guide
Learn how to set up and use ClearID in Security Center SaaS.
- Getting started
  Learn about the ClearID self-service physical access management solution.
- Requirements
  Check your compatibility and deployment requirements.
- Managing identities and users
  Learn how to manage identities and users.
- Managing sites
  Learn how to manage sites.
- Managing areas
  Learn how to manage areas.
- Managing visitors
  Learn how to manage visit requests and access requests.
- Managing visitor watchlists
  Learn how to manage visitor access using watchlists.
- Synchronizing data
  Learn how to connect ClearID to other systems.
  - Authenticating your connection
    Before you can connect with Genetec ClearID™ to synchronize data or issue API commands, you must first authenticate your applications (or API environment) so that your applications or API can communicate with ClearID.
  - Synchronizing identities using an API
    Use the Genetec ClearID™ API to code your own solutions to automate various functions in ClearID. The primary use for the REST API is synchronizing identities. However, many other scenarios are also possible.
    - About the ClearID API
      The Genetec ClearID™ API is an Application Programming Interface that developers can use to help customers and partners integrate additional software or perform custom functions.
  - Synchronizing identities using One Identity
    Use the Genetec ClearID™ One Identity Synchronization Tool to synchronize external system attributes into Genetec ClearID™ identity attributes. These identity attributes in ClearID can then be used to assign people to roles and automate role-based access control.
- Self-Service Kiosk
  Learn about the ClearID Self-Service Kiosk mobile app that simplifies visitor management and check-in.
- Troubleshooting
  Troubleshoot common issues that can occur.
Additional resources
Review the supported device list and other resources.
Glossary

About the ClearID API

2024-08-26

The Genetec ClearID™ API is an Application Programming Interface that developers can use to help customers and partners integrate additional software or perform custom functions.

Genetec ClearID™ is an API first service and the Web interface is built on top of that REST API. As a result most of the functionality from the Web interface is accessible by using Representational State Transfer (REST) endpoints.

The ClearID API is developed with two main objectives:

Platform independence: Any client should be able to call the API, regardless of how the API is implemented internally. This platform independence requires standard protocols, and a mechanism where the client and the web service can agree on the data format to exchange.
Service evolution: The web API should be able to evolve and add functionality independently from client applications. As the API evolves, existing client applications should continue to function without modification.

The ClearID API follows the best practices for Representational State Transfer (REST) and uses the standard HTTP actions: GET, POST, PUT, PATCH, and DELETE.

Examples

The primary use for the REST API is synchronizing identities. However, many other scenarios are also possible.

Here are some examples of the reports or data that you can obtain from ClearID using the REST API:

List of all upcoming and past visit events.
List of all approved visitor hosts.
List of all upcoming and past visit events for a specific requester, host, or site.
List of all active or inactive hosts, permissions information for each host, contact details, title, department, and company.

For each visit you can also obtain the following:

Event
Event name
Expected arrival and departure date and time
Visit requester
List of guests
Visit type
Parking location
Meetup location
Site visited
Areas on that site
Approval details

For more information about automating functions using the ClearID REST API, see the Genetec™ Developer documentation.