Risk iOS SDK

Last updated: October 7, 2026

Version 6.0.1

The checkout-risk-sdk-iOS supports the Fraud Detection solution by capturing advanced fraud signals that are leveraged in Checkout.com's machine learning model for risk scores.

Information

To enable access to the Risk SDK, contact your account manager or request support.

For more information, see Integrate with Risk SDK.

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
MSSD, which you can find in API endpoints
Environment


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

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