iPhone App Integration¶
iPhone integrations use YanezYID on iOS or an SDK flow for user capture and Apple App Attest, while partner secrets stay on the partner backend.
Responsibilities¶
| Component | Responsibility |
|---|---|
| Partner iPhone app | Starts the user flow and displays status. |
| YanezYID (iOS) | Performs biometric capture and YanezYID-side operations. |
| Partner backend | Signs partner API requests and validates resulting yid values. |
| Yanez backend | Verifies partner signatures, attestation, and record state. |
App Handoff¶
YanezYID opens via a signed yanezbio://sign? deep link. The partner
backend generates and signs the deep link; the partner app delivers it as a QR
code or tappable link.
See Deep Link Signing for the full parameter reference, signing steps, and a Python example.
User Activity and Integrations¶
YanezYID on iOS can read user-scoped activity and integrations for a yid
through app-attested Yanez endpoints:
GET /reg/ios/activities/{yid}
GET /reg/ios/activities/{yid}/recent
GET /reg/ios/integrations/{yid}
These are user-app endpoints, not partner backend endpoints. Partner backends should use the signed partner APIs documented in Backend API.
Completion¶
After the iPhone flow completes, the partner backend should validate any
returned yid using:
POST /api/partners/records/validate