Risk iOS SDK

Last updated: March 19, 2025

The checkout-risk-sdk-iOS captures advanced fraud signals that are leveraged in our fraud scoring machine learning model.

Information

To enable access to the Risk SDK, contact your Account Manager or [email protected].

Generate a public API key from your Dashboard.

The minimum requirements to use the iOS SDK are:

iOS 12.0 or later as a deployment target
Xcode 12.4 or later
Swift 5.3 or later

We recommend using Swift Package Manager to add our SDK due to its ease of use, but we also support integration via the CocoaPods dependency manager.

Add our GitHub repository's URL (https://github.com/checkout/checkout-risk-sdk-ios) as a package dependency in your app.

For detailed steps, follow the guide on Apple's documentation.

Note

You must have the latest CocoaPods 1.10 or later installed.

Add the SDK to your app's Podfile:


1source 'https://github.com/CocoaPods/Specs.git'
2platform :ios, '12.0'
3use_frameworks!
4
5target '<Your Target Name>' do
6    pod 'Risk', '~> <latest_version>' 
7end

Then, run the following command in the terminal:


1$ pod install

To update your existing Cocoapod dependencies, use:


1$ pod update

Initialize the package by passing the:

Public API key
Environment


1let yourConfig = RiskConfig(publicKey: "pk_qa_xxx", environment: RiskEnvironment.qa)
2
3// Initialize early-on in your app
4self.riskSDK = Risk.init(config: yourConfig)

Use the configure method to complete your setup after initialization. When the method is called, preliminary checks are made to Checkout. com's internal APIs. These APIs retrieve other configurations required for collecting device data.

If the checks fail or the merchant is disabled, an error is returned and logged. You can also see more information on your Xcode console while in development mode.

If the checks are successful, the method returns an instance of Risk. You can then call the publishData method on the instance to publish the data.


1import RiskSDK
2
3// Example usage of package
4let yourConfig = RiskConfig(publicKey: "pk_qa_xxx", environment: RiskEnvironment.qa)
5
6// Initialize in your app
7self.riskSDK = Risk.init(config: yourConfig)  
8
9// Complete your setup and publish data
10self.riskSDK.configure { configurationResult in
11
12    switch configurationResult {
13    case .failure(let errorResponse):
14        print(errorResponse.localizedDescription)
15    case .success():
16        self.riskSDK.publishData { result in
17            
18            switch result {
19            case .success(let response):
20                print(response.deviceSessionId)
21            case .failure(let errorResponse):
22                print(errorResponse.localizedDescription)
23            }
24        }
25    }
26    
27}


1public func configure(completion: @escaping (Result<Void, RiskError.Configuration>) -> Void) {
2    ...
3}
4
5public func publishData(cardToken: String? = nil, completion: @escaping (Result<PublishRiskData, RiskError>) -> Void) {
6        ...
7}
8public struct RiskConfig {
9    let publicKey: String
10    let environment: RiskEnvironment
11    let framesMode: Bool
12    
13    public init(publicKey: String, environment: RiskEnvironment, framesMode: Bool = false) {
14        self.publicKey = publicKey
15        self.environment = environment
16        self.framesMode = framesMode
17    }
18}
19
20public enum RiskEnvironment {
21    case qa
22    case sandbox
23    case production
24}
25
26public struct PublishRiskData {
27    public let deviceSessionId: String
28}
29
30public enum RiskError: LocalizedError, Equatable {
31    case configuration(Configuration)
32    case publish(Publish)
33}
34
35public enum RiskError {
36    case configuration(Configuration)
37    case publish(Publish)
38}
39
40public extension RiskError {
41    enum Configuration: LocalizedError {
42        case integrationDisabled
43        case couldNotRetrieveConfiguration
44        
45        public var errorDescription: String? {
46            switch self {
47            case .integrationDisabled:
48                return "Integration disabled"
49                
50            case .couldNotRetrieveConfiguration:
51                return "Error retrieving configuration"
52            }
53        }
54    }
55    
56    enum Publish: LocalizedError {
57        case couldNotPublishRiskData
58        case couldNotPersisRiskData
59        case fingerprintServiceIsNotConfigured
60        
61        public var errorDescription: String? {
62            switch self {
63            case .couldNotPublishRiskData:
64                return "Error publishing risk data"
65                
66            case .couldNotPersisRiskData:
67                return "Error persisting risk data"
68                
69            case .fingerprintServiceIsNotConfigured:
70                return "Fingerprint service is not configured. Please call configure() method first."
71            }
72        }
73    }
74}

Risk iOS SDK

Information

Before you start

Step 1: Add the SDK as a project dependency

Minimum requirements

Add the SDK dependency

Note

Step 2: Initialize the SDK

Step 3: Publish and persist device data

Sample configuration

Type definition