Client-Side Integration

iOS SDK

Use the Persona iOS SDK to run the user-facing Relay verification in a native iOS app.

The iOS SDK uses the Relay session access token to run the user-facing verification.

Prerequisites

This integration requires Persona iOS SDK 3.5.0 or later. Follow the iOS integration guide to install the SDK and configure platform permissions.

How the iOS flow works

  1. Your server creates a Relay session.
  2. Your server stores the Relay token and Relay secret for claim retrieval.
  3. Your server returns the Relay session access token to the iOS app.
  4. The app initializes the Persona iOS SDK in Relay mode with that token.
  5. The SDK presents the Relay-specific Inquiry experience, including the applicable Relay consent UI.
  6. When the user-facing experience ends, the app asks your server to retrieve the claim result.

Store the Relay secret securely on your server. Never expose it to the client.

Start Relay

Follow the iOS integration guide to install the SDK and handle Inquiry results.

To start Relay, create the Inquiry with Inquiry.from(relaySessionToken:delegate:) instead of a template or Inquiry ID:

1let inquiry = Inquiry.from(
2  relaySessionToken: relaySessionAccessToken,
3  delegate: self
4).build()
5
6inquiry.start(from: self)

The delegate reports how the Inquiry experience ended. It does not return the Relay claim payload or PII to the app.

Relay mode behavior

Relay token initialization is a dedicated entry point. Do not combine it with template IDs, template versions, Inquiry IDs, one-time links, share tokens, or field mappings.

In Relay mode, the SDK omits information that identifies the host app, such as the iOS bundle identifier.

Use the Inquiry delegate to coordinate your app’s UI. Retrieve the claim result through your server-side Relay integration.