Skip to content

Identity Positioning

The HID Identity Positioning API provides the ability to manage an organization's site, building, floor, and zone information. It also provides granular data on occupancy, utilization, and proximity filtered based on time range.

Identity Positioning Solutions

Door centric solution, leveraging HID readers for low granularity use cases

The Origo APIs listed below must be utilized to create users and issue identity positioning credentials

User Management

Identity Positioning Users are created and managed using the User Management API.

Credential Management

The Credential Management API enables issuance and lifecycle management of digital credentials.

A Pass is used to represent these digital credentials. Every Pass is based on a Pass Template that specifies the type of credential(s).

Pass and Pass Template are created and maintained using Credential Management API.

Identity Positioning API Specification

These APIs facilitate the creation and management of sites, including the configuration of buildings, floors, and zones. They also provide separate APIs for managing readers within the site.

Additionally, the APIs offer comprehensive data on site information, including occupancy and utilization statistics, enabling users to monitor and analyze space usage effectively. Proximity reports can also be generated, providing insights into spatial relationships and movements within the site.

Release Notes

1.1.4

Version 1.1.4 introduces enhanced reporting capabilities for the HID Identity Positioning service, specifically targeting prepaid subscription insights.

  • New Report Types

The following report types are now available:
- Daily Report: Tracks daily subscription activity and usage metrics
- Monthly Report: Provides comprehensive monthly usage summaries
- Cumulative Monthly Report: Aggregates data from the beginning of the current month to the present date for trend analysis

  • Standard Behavior: Accumulates data from the 1st day of the current calendar month up to the current date
  • Year-Only Mode: When only a year is specified (without a month), the report aggregates data from January 1st of the specified year up to the current date

  • Use Case: Enables year-to-date monthly aggregation for historical performance review and trend analysis

  • Report Data Insights

The report response now includes the following key metrics:
- Active Users: Count of users who have utilized an Issuance Token at least once
- Activation Rate: Ratio of active users to the total number of purchased licenses
- Licenses Left: Calculated as: Total Purchased Licenses - Active Users

  • Benefits

These enhancements provide organizations with:
- Real-time visibility into subscription utilization
- Historical trend analysis capabilities
- Better license management insights
- Comprehensive usage reporting across different time periods

1.1.3

Version 1.1.3 includes the following changes:

  • Only the following credentialSubType values will be supported for HID Identity Positioning:
Value Name Description
1 SEOS_READER Support for HID Readers and Beacons (3rd Party)
3 SEOS_READER_ONDEMAND Support for HID Reader on demand use cases
4 TP_BEACON Support for Third-party iBeacon devices
5 SEOS_READER_ONLY Support for HID Readers only, and not for other readers/beacons
  • The credentialSubType value "1" provides support for HID Readers along with 3rd party beacons.
  • The credentialSubType value "2" (Premium Solution) is no longer in use and has been officially discontinued.
  • The credentialSubType value "3" provides support for HID Reader On Demand use cases.
  • The credentialSubType value "4" provides support for 3rd Party iBeacon devices only.
  • The credentialSubType value "5" provides support only for HID Readers and not for other readers/beacons.

    As part of the feature implementation for 3rd party beacons, we now provide support for all beacons in the market that adhere to iBeacon protocol standards.

1.1.2

Version 1.1.2 includes the following changes:

  • V1 changes to Credential configuration payload to support Site/Zone events
  • V1 changes to Install and Update Reader API at an organization level
  • Support for RevE readers and iBeacon along with existing support for Signo readers
  • Removal of Premium solution for HID Identity Positioning as this is officially discontinued. Only the following 2 credentialSubType field values will be supported henceforth:
    • 1 - SEOS_READER
    • 3 - SEOS_READER_ONDEMAND
  • Introduced Optional fields in Create Site API for adding (lat, lon, radius)

1.1.1

Version 1.1.1 includes the following changes:

  • Usage Report (Monthly/Quarterly/Yearly)
  • Get proximity data of device in Building/Site/Floor/Zone
  • deviceTrackingId field allow unique identifier while creating a Pass

1.1.0

Version 1.1.0 includes the following changes:

  • Get daily report to retrieve list of active devices and passes
  • Install Reader API will allow iBeacon UUID's minor value as an optional parameter for Enterprise customers
  • Delete user API in the User Management API, when invoked, will wipe all the user data
  • A new field, deviceTimeDelta, has been added while creating credential configuration

1.0.0

Version 1.0.0 includes the following changes:

  • Occupancy and Utilization data for a Site, Building, Floor or a Zone.
  • Proximity data for a specified period.
  • Site/Building/Floor/Zone metadata.
  • Supported approaches Reader, Beacon and On-Demand Reader

Glossary

Term Definition
Organization Unique identifier of the client. The organization_id field specifies it.
Site An Organization can have multiple sites. Thesite_id field specifies it and site_id will be unique for every organization
Building A Site can have multiple buildings. The building_id field specifies it and building_id will be unique for every site.
Floor A Building can have multiple floors. The floor_id field specifies it and floor_id will be unique for every building.
Zone A Floor can have multiple zones. The zone_id field specifies it and zone_id will be unique for every floor.
Reader A Reader can be installed only in zones. The reader_id field specifies it and reader_id will be unique for entire organization.
Proximity Data Proximity API provides relative location/device data for the given time period(time should be in epoch format).
Occupancy Occupancy API provides information on the count of people occupied in a site/building/floor/zone for a given period (time should be in epoch format).
Utilization Utilization API provides information on the percentage of area utilized in a zone for a given period (time should be in epoch format).
Application-ID The Application Identifier is used to identify an application calling HID Origo APIs. This value is provided by HID Partner Services. Please refer to Authentication for additional details.
X-Request-ID The X-Request-ID Identifier is used to track a request flow end to end. This value is provided by HID Partner Services.
Granularity P is the duration designator (for period) placed at the start of the duration representation.
M is the month designator that follows the value for the number of months.
W is the week designator that follows the value for the number of weeks.
D is the day designator that follows the value for the number of days.
T is the time designator that precedes the time components of the representation.
The details for the time component are,
  H is the hour designator that follows the value for the number of hours.
  M is the minute designator that follows the value for the number of minutes.