Developers

Integration surfaces for the identity platform.

REST APIs and mobile SDKs for embedding TrueTap credential verification, plus the integration boundaries for biometric devices, identity platforms, enterprise IAM and custom hardware. Designed for enterprise integration with structured endpoints, predictable schemas and compliance-grade logging. Access is issued only after programme qualification.

REST API

Verification endpoint

The core verification API accepts a chip identifier and challenge response, returning a structured authentication result with event identifier and metadata.

All requests are authenticated with API keys issued per programme. Responses conform to a versioned JSON schema. Endpoints are available in regional configurations to meet data residency requirements.

Access qualification

API and SDK access is issued only after programme qualification. Contact the team to begin the onboarding process for your integration.

Illustrative example

POST /v1/verify Authorization: Bearer <api_key> Content-Type: application/json { "chip_id": "TT-4A2F9D8C", "challenge_response": "a3f8e1...", "programme_id": "PRG-0042" } HTTP 200 OK { "result": "authenticated", "event_id": "EVT-20260427-8823", "chip_id": "TT-4A2F9D8C", "issued_at": "2025-11-15T08:00:00Z", "status": "active", "programme": "PRG-0042" }
API reference

Core endpoints

POST /v1/verify

Verify a chip

Submit a chip identifier and challenge response for authentication. Returns authenticated, tampered, or unknown with event metadata.

GET /v1/chips/{id}

Retrieve chip record

Return the current status and metadata for a provisioned chip. Includes issue date, programme assignment, and lifecycle state.

POST /v1/chips/{id}/revoke

Revoke a chip

Mark a chip identity as revoked. Subsequent verification attempts will return a negative result with a revoked status flag.

GET /v1/events

Audit log export

Paginated export of verification events with filter parameters by date range, chip, programme, and result type. Suitable for compliance reporting.

POST /v1/webhooks

Webhook subscriptions

Subscribe to real-time event delivery for verification results, chip status changes, and programme lifecycle events.

Mobile SDKs

iOS and Android integration

Native SDK packages for embedding TrueTap verification directly in mobile applications. Handles NFC session management, challenge construction, and result parsing.

iOS SDK

Swift package supporting iOS 13+. Integrates with CoreNFC for NFC session management. Full support for background tag reading on compatible devices.

Illustrative example

import TrueTap let session = TrueTapSession(apiKey: "YOUR_KEY") session.verify(chipID: tag.identifier) { result in switch result { case .authenticated(let event): ... case .tampered: ... case .unknown: ... } }

Android SDK

Kotlin/Java library for Android 8.0+. Handles NFC intent dispatch, foreground dispatch for enforcement applications, and host card emulation contexts.

Illustrative example

val client = TrueTapClient(apiKey = "YOUR_KEY") client.verify( chipId = tag.id.toHexString(), programmeId = "PRG-0042" ) { result -> when (result) { is Authenticated -> handleAuth(result.event) is Tampered -> handleTamper() is Unknown -> handleUnknown() } }
Integration surfaces

Beyond the verification endpoint.

The credential verification API is one surface. Programmes typically combine it with biometric-device integration, an identity or registry platform, enterprise IAM connectors, mobile verification SDKs and - where required - custom hardware integration.

Credential APIs

Provision, verify, revoke and audit credentials

The REST surface covers the full credential lifecycle - provisioning at issuance, field verification, status and revocation management, and audit log export. Responses are versioned JSON; access is keyed per programme and rate-limited per integration.

Biometric-device integration

Enrolment stations and field readers

Biometric capture devices - fingerprint, iris, face, multimodal - are integrated through device-specific SDKs and drivers supplied by the approved manufacturing partner. TrueTap defines the verification workflow and the data contract; the capture pipeline is configured to the selected device and programme requirements.

Integration boundaries and supported device profiles depend on the selected programme configuration.

Identity platform APIs

Registry, deduplication and lifecycle

For national and large enterprise programmes, TrueTap integrates with the identity registry, deduplication services and lifecycle systems. Biometric matching may be performed against the sovereign identity platform or through a privacy-preserving secure-card implementation, depending on the selected architecture.

IAM connectors

Enterprise identity providers

Integration with Microsoft Entra ID, Active Directory and enterprise IAM platforms can be delivered through appropriate connectors, SDKs and identity protocols. Integration can be delivered through appropriate identity protocols, SDKs and connectors; protocol-level support is scoped per programme rather than claimed as universal plug-and-play.

Mobile verification SDKs

iOS and Android for field and consumer apps

Native SDK packages handle NFC session management, challenge construction, biometric capture orchestration and result parsing. Suitable for enforcement applications, workforce login apps, field officer tools and consumer verification experiences.

Hardware integration & HSA.dev

Custom engineering when the platform needs extending

For programmes that need custom enclosures, embedded modules, firmware integration, OEM form factors or bespoke administrative portals, custom engineering can be delivered through HSA.dev. Sovereign deployment engineering and integration with national infrastructure are scoped per programme.

Access

Request developer access.

API credentials, SDK packages and integration support are provided to qualified programme partners. Contact the team with your integration context - credential volume, target platforms, identity systems and deployment model.