Persona Developer Hub

Welcome to the Persona developer hub. You'll find comprehensive guides and documentation to help you start working with personaidentities as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started

iOS Inquiry SDK Integration Guide

iOS Inquiry SDK Integration Guide and Technical Documentation

The Persona Inquiry flow lets you securely and seamlessly collect your user's information.

Integration

Integrate the Persona Inquiry flow directly into your iOS app with our native SDK.

To integrate the Persona Inquiry SDK in your iOS app you can use Swift Package Manager, CocoaPods or download the XCFramework for manual integration or for use with Carthage.

Requirements - Make sure the SDK is compatible

Your app needs to support iOS 11.0 or later.

Swift 5.3Swift 5.3

Install via Swift Package Manager

To install the SDK with Swift Package Manager:

  1. Select your project’s Swift Packages tab
  2. Click on the + to add a package
  3. Add the repository URL https://github.com/persona-id/inquiry-ios.git, and click Next
  4. Choose the package options version rule you want to use. We recommend the default (up to next major version), and click Next
  5. Check that the package is being added to the right target and click Finish.

swift-package-managerswift-package-manager

Install via CocoaPods

To install the SDK with CocoaPods, add PersonaInquirySDK as one of your target dependencies in your Podfile:

source 'https://github.com/CocoaPods/Specs.git'
use_frameworks!

target 'Your Project' do
    pod 'PersonaInquirySDK'
end

Inquiry SDK latestInquiry SDK latest

Please be sure to run pod update and use pod install --repo-update to ensure you have the most recent version of the SDK installed.

Install via Carthage

Unfortunately Carthage (as of 0.37.0) does not appear to support framework binaries containing multi-architecture platforms. If you're using Carthage, you can download the pre-built XCFramework and integrate it using the steps outlined below.

Manual installation

The SDK is released as an XCFramework which makes manually installing the SDK a straightforward process:

  1. Go to the Persona Inquiry SDK Releases page
  2. Find the latest release
  3. Expand the Assets triangle and download the PersonaSDK.xcframework.zip file
  4. Unarchive the zip file and drag the Persona.xcframework folder into your Xcode project
  5. A dialog prompt will pop up asking to choose options for adding these files. Please ensure that Destination has Copy items if needed ticked and that it will be added to the correct target.
  6. Click on Finish

That's it!

Update your Info.plist

In addition to importing the dependency, you also need to modify your Info.plist:

  1. Navigate to your project's settings in Xcode and click the Info tab
  2. Add a new "Privacy - Camera Usage Description" (NSCameraUsageDescription) entry (if not already present) to enable camera access.
  3. Add a new "Privacy - Photo Library Usage Description" (NSPhotoLibraryUsageDescription) entry (if not already present) to enable photo library access.

Usage

📘

Technical Documentation

If you want to dive right in to the API documentation, you can do so here.

The Persona Inquiry verification flow is initiated with an InquiryConfiguration. This configuration can be initialized with either a templateId or an inquiryId.

Please refer to the code sample below and replace my_template_id with your template ID. You can find your template ID on the Persona Dashboard under "Development".

This starts the Inquiry flow and takes control of the user interface. Once the flow completes the control of the user interface is returned to the app and the appropriate delegate method will be called.

class MyViewController: UIViewController {
  
    // This is hooked up to a button which starts the flow
    @IBAction private func buttonTapped(_ sender: UIButton) {
        let config = InquiryConfiguration(templateId: "my_template_id")
        
        // Create the inquiry with the view controller 
        // as the delegate and presenter.
        Inquiry(config: config, delegate: self).start(from: self)
    }
}

 // MARK: - Inquiry Delegate Methods

extension MyViewController: InquiryDelegate {

    func inquirySuccess(inquiryId: String, attributes: Attributes, relationships: Relationships) {
        // ✅ Inquiry succeeded
    }

    func inquiryCancelled() {
        // ⏏️ Inquiry cancelled by user
    }

    func inquiryFailed(inquiryId: String, attributes: Attributes, relationships: Relationships) {
        // ❌ Inquiry failed
    }

    func inquiryError(_ error: Error) {
        // ⚠️ Inquiry errored
    }
}

Inquiry Results

The results of the inquiry are passed back to the InquiryDelegate, and are as follows

  • inquirySuccess — the inquiry passed
  • inquiryFailed — the inquiry failed
  • inquiryCancelled — the inquiry was cancelled by the user
  • inquiryError — the inquiry errored

Configuration Options

Some different configuration examples can be found below:

// Configuration with only a template ID
let config = InquiryConfiguration(
    templateId: "tmpl_JAZjHuAT738Q63BdgCuEJQre"
)

// Configuration with only a template ID in the sandbox
let config = InquiryConfiguration(
    templateId: "tmpl_JAZjHuAT738Q63BdgCuEJQre", 
    environment: .sandbox
)

// Configuration with a template and reference ID
let config = InquiryConfiguration(
    templateId: "tmpl_JAZjHuAT738Q63BdgCuEJQre", 
    referenceId: "myReference"
)

// Configuration with a template and account ID
let config = InquiryConfiguration(
    templateId: "tmpl_JAZjHuAT738Q63BdgCuEJQre", 
    accountId: "act_W6thEnEU19gphPqq5uTzZ4Y8"
)

// Configuration with only an inquiry ID
let config = InquiryConfiguration(
    inquiryId: "inq_JAZjHuAT738Q63BdgCuEJQre", 
)

// Configuration with only a template ID and a theme
var theme = InquiryTheme()
theme.backgroundColor = .purple
theme.bodyTextColor = .white

let config = InquiryConfiguration(
    templateId: "tmpl_JAZjHuAT738Q63BdgCuEJQre", 
    theme: theme
)

Customization

Make the Persona Inquiry flow look and feel like your app.

Replacing Strings

You can replace any title, body, or button text by providing your own strings file called Persona.strings in your app bundle. At runtime, the SDK will use any of the strings found there.

For example:

/* 
  Persona.strings
*/

"inquiryStartTitle" = "Verify your identity";
"inquiryStartBody" = "Let’s make sure you’re you!";
"inquiryStartButton" = "Get started";

Available String Keys

// Government ID
"governmentIdFailedTitle"
"governmentIdStartTitle"
"governmentIdStartBody"
"governmentIdSubmittingTitle"
"governmentIdSubmittingBody"
"governmentIdChooseType"

// Taking Government ID photos
"takeGovIdPhotoHint"
"takeGovIdRetakePhotoButtonText"
"takeGovIdReviewBackPhoto"
"takeGovIdReviewFrontOrBackPhoto"
"takeGovIdReviewFrontPhoto"
"takeGovIdUsePhotoButtonText"
"takeGovIdReviewPhotoHint"
"takeGovIdBackPhotoFormat"
"takeGovIdFrontPhotoFormat"

// Selfie
"selfieFailedTitle"
"selfieFailedBody"
"selfieFailedButton"
"selfieStartTitle"
"selfieStartBody"
"selfieStartButton"
"selfieSubmittingTitle"
"selfieSubmittingBody"

// Country selection
"countrySelectTitle"
"countrySelectBody"
"countrySelectButton"
"countrySelectPickerText"

// Inquiry Complete
"inquiryCompleteTitle"
"inquiryCompleteBody"
"inquiryCompleteButton"

// Inquiry Failed
"inquiryFailedTitle"
"inquiryFailedBody"
"inquiryFailedButton"

// Inquiry Start
"inquiryStartTitle"
"inquiryStartBody"
"inquiryStartButton"

Updated about a month ago

iOS Inquiry SDK Integration Guide


iOS Inquiry SDK Integration Guide and Technical Documentation

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.