User Documentation

Statuses and lifecycles

Identity and credential status

Identities and credentials can be active or inactive. This is an ICAP business state; when PACS integration is enabled, the physical access outcome also depends on configuration, mappings, and downstream completion.

Visitor attendance

planned → checkedIn → checkedOut

New visitor-to-visit assignments begin as planned. Your application controls when to call the check-in and check-out endpoints; visit dates do not automatically change attendance.

Personal-share status

Status

Meaning

created

The offer has been created.

pending

The target can review and decide.

accepted

The target accepted and ICAP created or updated its target-owned record.

declined

The target declined the offer.

withdrawn

The source withdrew a pending offer.

failed

The workflow could not complete; inspect the share details and resolve before recreating.

Resource lifecycle

Most resources follow this broad pattern:

create → update → soft delete

Identities and visitors additionally support purge. Soft deletion and purge do not have a restore API. Read privacy and lifecycle before relying on either in a retention process.

Version lifecycle

Versioned resources begin at version 1. A successful guarded PATCH returns the resource with an incremented version. Guarded removals and purges return 204 No Content; retain no assumption that a subsequent request can reuse the old version. See updates and concurrency.