API reference map | HIS User documentation

The ICAP API is versioned under /icap/v1/tenant/{tenantId} and uses bearer authentication. For exact request schemas, response schemas, query parameters, permissions, and status codes, use the hosted interactive API explorer or open the supplied OpenAPI 3 contract in your own tool. The explorer provides endpoint navigation, schema views, authorization entry, server selection, and Try it out when this documentation is served over HTTP(S).

The contract deliberately defaults to the non-routable your-icap-host.invalid placeholder. Set the server host to the host supplied in your environment record before authorizing or trying an operation. Do not use a host copied from another HID environment.

First-call and administration endpoints

These commonly needed operations are shown here with their current contract permissions. All require bearer authentication.

Method and path	Purpose	Required ICAP permission
`PUT /icap/v1/tenant/{tenantId}`	Register a tenant with `name` and `tenantAdminId`.	`TenantRegister`
`GET /icap/v1/tenant/{tenantId}/permission`	List the tenant permission catalog.	None
`POST /icap/v1/tenant/{tenantId}/role`	Create a task-focused tenant role.	`RoleCreate`
`POST /icap/v1/tenant/{tenantId}/role/{roleId}/assignment`	Assign a role to an external HID user ID.	`RoleAssign`
`GET /icap/v1/tenant/{tenantId}/health`	Check the tenant-scoped service health.	None stated in the contract
`POST /icap/v1/tenant/{tenantId}/cardType`	Create a card type.	`CardTypeCreate`
`POST /icap/v1/tenant/{tenantId}/accessUnit`	Create an access unit.	`AccessUnitCreate`
`POST /icap/v1/tenant/{tenantId}/identity`	Create an identity.	`IdentityCreate`
`POST /icap/v1/tenant/{tenantId}/cardCredential`	Create a card credential.	`CardCredentialCreate`
`POST /icap/v1/tenant/{tenantId}/identity/{identityId}/credential`	Assign a credential.	`IdentityCredentialAssign`
`POST /icap/v1/tenant/{tenantId}/identity/{identityId}/accessUnit`	Assign access.	`IdentityAccessUnitAssign`

Use the verified quickstart for these configuration and assignment calls in order.

Tenant and health

Resource	Operations
Health	Get tenant health
Tenant	Register, get, update, get statistics
Tenant features	Get and update features

Related guidance: tenants and features. Tenant registration is PUT /icap/v1/tenant/{tenantId} and requires TenantRegister.

PACS and PACS transactions

Resource	Operations
PACS	Register, list, get, update, deregister
PACS discovery	List PACS access units and card formats
PACS transactions	List transactions with filters
PACS callback	Invoke the authorized callback endpoint

Related guidance: PACS integration.

Identity and identity access

Resource	Operations
Identity	Create, list, get, update, remove, purge, share
Identity credentials	Assign, list, remove
Identity access units	Assign, list, remove
Identity photo request	Create, get, remove

Related guidance: identities, credentials, and access units.

Visitors and visits

Resource	Operations
Visitor	Create, list, get, update, remove, purge, list visits, share
Visitor photo request	Create, get, remove
Visitor credentials	List assigned credentials
Visit	Create, list, get, update, remove
Visit participants	Assign, list, check in, check out, remove
Visit-participant credentials	Assign, list, remove
Visit access units	Assign, list, remove

Related guidance: visitors and visits.

Configuration resources

Resource	Operations
Extension field definitions	Create, list, get, update, remove
Access units	Create, list, get, update, remove, list assignments
Card types	Create, list, get, update, remove
Card credentials	Create, list, get, update, remove, get assignment
PIN credentials	Create, list, get, update, remove, get assignment

Related guidance: custom fields, access units, and credentials and card types.

Roles, permissions, and users

Resource	Operations
Permissions	List tenant permission catalog
Roles	Create, list, get, update, remove
Role assignments	Create, list, get, remove
User roles	List roles assigned to a user

Related guidance: roles and permissions.

Resource	Operations
Outgoing personal shares	List, get, withdraw
Incoming personal shares	List, get, accept, decline
Person share creation	Create an outgoing offer from an identity or visitor

Related guidance: personal data sharing.

Shared behavior

List operations use offset and limit; consult filtering and pagination.
Versioned PATCH, removal, and purge operations need If-Match; consult updates and concurrency.
Standard failure handling is described in errors and retry behavior.
The supplied OpenAPI 3 contract is the source for endpoint-level permissions, request fields, response fields, and status codes; this page intentionally does not duplicate every schema.