Identity, Credential and Access Provider (ICAP) is the HID Integration Service (HIS) API for managing the people, credentials, access targets, visits, and configuration used in physical access workflows.
This documentation is for tenant administrators and application developers. It explains how to use the current ICAP v1 API; the bundled OpenAPI contract and its OpenAPI definition are authoritative for request and response fields.
Start here
-
What ICAP does — scope, responsibilities, and core concepts.
-
Get access to ICAP — the Customer Central, partner, and support routes for a new customer.
-
Authentication — use a token issued through HID Authentication Service.
-
Quickstart — create the required configuration, a person, credential, and verified access assignments.
-
API basics — tenant paths, resource IDs, dates, and content types.
Choose a task
|
If you need to… |
Read |
|---|---|
|
Manage ongoing cardholders |
|
|
Issue a badge or PIN |
|
|
Create temporary access for guests |
|
|
Define doors, zones, or logical access targets |
|
|
Add tenant-specific attributes |
|
|
Connect a physical access-control system |
|
|
Configure access to the API |
|
|
Remove personal data |
|
|
Share selected person data with another tenant |
|
|
See current external integrations |
Integrate reliably
Documentation conventions
Examples use a placeholder base URL, tenant ID, and bearer token:
https://<your-icap-host>/icap/v1/tenant/<tenantId>
Authorization: Bearer <access-token>
Replace the placeholders with the endpoint and tenant context provided for your environment. URLs, capabilities, and permissions can vary by tenant configuration.