iOS SDK v1 Integration Guide

1
source 'https://github.com/CocoaPods/Specs.git'
2
use_frameworks!
3
4
target 'Your Project' do
5
    pod 'PersonaInquirySDK'
6
end

1
class MyViewController: UIViewController {
2
  
3
    // This is hooked up to a button which starts the flow
4
    @IBAction private func buttonTapped(_ sender: UIButton) {
5
        let config = InquiryConfiguration(templateId: "my_template_id")
6
        
7
        // Create the inquiry with the view controller 
8
        // as the delegate and presenter.
9
        Inquiry(config: config, delegate: self).start(from: self)
10
    }
11
}
12
13
 // MARK: - Inquiry Delegate Methods
14
15
extension MyViewController: InquiryDelegate {
16
17
    func inquirySuccess(inquiryId: String, attributes: Attributes, relationships: Relationships) {
18
        // ✅ Inquiry succeeded
19
    }
20
21
    func inquiryCancelled() {
22
        // ⏏️ Inquiry cancelled by user
23
    }
24
25
    func inquiryFailed(inquiryId: String, attributes: Attributes, relationships: Relationships) {
26
        // ❌ Inquiry failed
27
    }
28
29
    func inquiryError(_ error: Error) {
30
        // ⚠️ Inquiry errored
31
    }
32
}

1
// Configuration with only a template ID
2
let config = InquiryConfiguration(
3
    templateId: "tmpl_JAZjHuAT738Q63BdgCuEJQre"
4
)
5
6
// Configuration with only a template ID in the sandbox
7
let config = InquiryConfiguration(
8
    templateId: "tmpl_JAZjHuAT738Q63BdgCuEJQre", 
9
    environment: .sandbox
10
)
11
12
// Configuration with a template and reference ID
13
let config = InquiryConfiguration(
14
    templateId: "tmpl_JAZjHuAT738Q63BdgCuEJQre", 
15
    referenceId: "myReference"
16
)
17
18
// Configuration with a template and account ID
19
let config = InquiryConfiguration(
20
    templateId: "tmpl_JAZjHuAT738Q63BdgCuEJQre", 
21
    accountId: "act_W6thEnEU19gphPqq5uTzZ4Y8"
22
)
23
24
// Configuration with only an inquiry ID
25
let config = InquiryConfiguration(
26
    inquiryId: "inq_JAZjHuAT738Q63BdgCuEJQre", 
27
)
28
29
// Configuration with only a template ID and a theme
30
var theme = InquiryTheme()
31
theme.backgroundColor = .purple
32
theme.bodyTextColor = .white
33
34
let config = InquiryConfiguration(
35
    templateId: "tmpl_JAZjHuAT738Q63BdgCuEJQre", 
36
    theme: theme
37
)

1
/// Creates a UIFont using the embedded font
2
let customFont: ((Bool, CGFloat) -> UIFont) = { bold, size in
3
    let name = "CustomFontName-".appending(bold ? "Bold" : "Regular")
4
5
    guard let font = UIFont(name: name, size: size) else {
6
        fatalError("Could not find a font called \(name)")
7
    }
8
    return font
9
}
10
11
var theme = InquiryTheme()
12
theme.titleTextFont = customFont(true, 26)
13
theme.bodyTextFont = customFont(false, 18)
14
theme.buttonFont = customFont(true, 18)

1
// Government ID
2
"governmentIdFailedTitle" = "Couldn’t verify photos";
3
"governmentIdFailedGenericReason" = "Make sure the ID details are clear to read.";
4
"governmentIdFailedButton" = "Retry";
5
"governmentIdStartTitle" = "Upload a photo ID";
6
"governmentIdStartBody" = "We require a photo of a government ID to verify your identity.";
7
"governmentIdSubmittingTitle" = "Processing ID";
8
"governmentIdSubmittingBody" = "This may take a few seconds";
9
"governmentIdChooseType" = "Choose 1 of the following options";
10
11
// Taking Government ID photos
12
"takeGovIdPhotoHint" = "Take a clear photo of the ID";
13
"takeGovIdRetakePhotoButtonText" = "Retake";
14
"takeGovIdReviewBackPhoto" = "Review the back of ID";
15
"takeGovIdReviewFrontOrBackPhoto" = "Review the ID";
16
"takeGovIdReviewFrontPhoto" = "Review the front of ID";
17
"takeGovIdUsePhotoButtonText" = "Looks good";
18
"takeGovIdReviewPhotoHint" = "Ensure lighting is good and lettering is clear";
19
"takeGovIdBackPhotoFormat" = "Back of %@";
20
"takeGovIdFrontPhotoFormat" = "Front of %@";
21
"takeGovIdGuideHintBackFormat" = "Position the back of the %@ in the frame";
22
"takeGovIdGuideHintFrontFormat" = "Position the front of the %@ in the frame";
23
24
// Selfie
25
"selfieFailedTitle" = "Something went wrong";
26
"selfieFailedBody" = "Make sure your face is visible, well lit, and try again.";
27
"selfieFailedButton" = "Retry";
28
"selfieStartTitle" = "Take a selfie";
29
"selfieStartBody" = "Let’s make sure you’re you";
30
"selfieStartButton" = "Get started";
31
"selfieSubmittingTitle" = "Processing selfie";
32
"selfieSubmittingBody" = "This may take a few seconds";
33
"takeSelfieCenterPhoto" = "Center yourself in the frame.";
34
"takeSelfieLeftPhoto" = "Look slightly left.";
35
"takeSelfieRightPhoto" = "Look slightly right.";
36
37
// Country selection
38
"countrySelectTitle" = "What country is your government ID from?";
39
"countrySelectBody" = "This helps us determine the best way to verify your identity.";
40
"countrySelectButton" = "Select country";
41
"countrySelectPickerText" = "Country of government ID";
42
43
// Country List
44
"countryListAllCountries" = "ALL COUNTRIES";
45
"countryListSuggested" = "SUGGESTED";
46
"countryListTitle" = "Select country of ID";
47
48
// Inquiry Complete
49
"inquiryCompleteTitle" = "Congratulations, you’re done!";
50
"inquiryCompleteBody" = "Thanks for verifying your identity.";
51
"inquiryCompleteButton" = "Done";
52
53
// Inquiry Failed
54
"inquiryFailedTitle" = "Could not verify your identity";
55
"inquiryFailedBody" = "We were unable to verify your identity.";
56
"inquiryFailedButton" = "Close";
57
58
// Inquiry Start
59
"inquiryStartTitle" = "Verify your identity";
60
"inquiryStartBody" = "Let’s make sure you’re you";
61
"inquiryStartButton" = "Get started";
62
63
// Database
64
"databaseStartTitle" = "Just the basics";
65
"databaseStartBody" = "Nothing fancy, just a few things to verify your identity.";
66
"databaseStartButton" = "Continue";