{"templateId":"markdown","versions":[{"version":"v1","label":"v1 (Latest)","link":"/products/sca-exemptions/device-data/ios","default":true,"active":true,"folderId":"edc06d3d"}],"sharedDataIds":{"sidebar":"sidebar-products/sca-exemptions/sidebars.yaml","current-catalog-info":"current-catalog-info-/products/sca-exemptions/openapi"},"props":{"metadata":{"markdoc":{"tagList":["partial","admonition"]},"custom_product":"SCA Exemptions","type":"markdown"},"seo":{"title":"iOS device data","description":"Worldpay for Developers - docs, code examples, resources and tools. Everything you need to build your omnichannel payment solution.","siteUrl":"https://docs.worldpay.com/access","image":"/access/assets/worldpay-logo-light.21b7daf79984773a9fcd7d4fbcb07ae5289dfffd6023c4c3dca720c7058e53dc.33f780a6.svg","keywords":"documentation, api, openapi, sdks, developer, payments, json, payouts, 3ds","jsonLd":{"@context":"https://schema.org","@type":"Organization","url":"https://docs.worldpay.com/access","name":"Worldpay"},"meta":[{"name":"google-site-verification","content":"zjziIKaP3ImsqsfhYnEBnq1R85UabiSwl7HTXuwtZuo"},{"name":"doc_product","content":"Access"},{"name":"doc_category","content":"Documentation"}],"llmstxt":{"hide":false,"sections":[{"title":"Payments API","description":"Payment orchestration API combining fraud assessment, 3ds authentication, SCA exemptions, Worldpay Token creation and a card or wallet based payment.","includeFiles":["products/payments/@20240601/**/*"],"excludeFiles":[]},{"title":"Payment Queries API","description":"Querying your payments data, based on a variety of parameters.","includeFiles":["products/payment-queries/@v1/**/*"],"excludeFiles":[]},{"title":"Card BIN Data API","description":"Provides detailed information about a card.","includeFiles":["products/card-bin/@v1/**/*"],"excludeFiles":[]},{"title":"3DS Authentication API","description":"Request 3DS authentication to protect against fraud, be SCA compliant and to shift liability using this standalone API.","includeFiles":["products/3ds/@v3/**/*"],"excludeFiles":[]},{"title":"FraudSight API","description":"Request a risk assessment and receive a response with an outcome (e.g. lowRisk) using this standalone API.","includeFiles":["products/fraudsight/@v1/**/*"],"excludeFiles":[]},{"title":"Checkout SDK","description":"Integrate using our clientside SDKs for both web and native devices. Benefit from SAQ-A/PCI-SSF compliance.","includeFiles":["products/checkout/web/@v2/**/*","products/checkout/ios/@v4/**/*","products/checkout/android/@v4/**/*","products/checkout/react-native/@v3/**/*","products/checkout/flutter/@v1/**/*"],"excludeFiles":[]},{"title":"Tokens API","description":"Minimizes the exposure of sensitive card details and increases the security of your customer's card details.","includeFiles":["products/tokens/@v3/**/*"],"excludeFiles":[]},{"title":"Card Payments API","description":"Request a card payment using this standalone API, requires separate requests for 3DS, Fraud assessment etc.","includeFiles":["products/card-payments/@v7/**/*"],"excludeFiles":[]},{"title":"Card Verifications API","description":"Verify your customer's card to maximize your authentication rates.","includeFiles":["products/card-verifications/@v6/**/*"],"excludeFiles":[]},{"title":"Account Payouts API","description":"Send funds to your customer's bank accounts and search for payouts using parameters.","includeFiles":["products/account-payouts/@20250101/**/*"],"excludeFiles":[]},{"title":"APMs","description":"Pay using eWallets, bank transfers, direct debits, local card schemes, Postpay and eInvoice/ Buy Now Pay Later.","includeFiles":["products/apms/@20240701/**/*"],"excludeFiles":[]},{"title":"Balance API","description":"Request your account details for a single account or all accounts under an entity.","includeFiles":["products/balance/@20250101/**/*"],"excludeFiles":[]},{"title":"Card Payouts API","description":"Send funds to your customer's cards.","includeFiles":["products/card-payouts/@v4/**/*"],"excludeFiles":[]},{"title":"Events (Webhooks)","description":"Receive status updates from Access Worldpay by setting up a webhook.","includeFiles":["products/events/@v1/**/*"],"excludeFiles":[]},{"title":"FX API","description":"Manage Foreign Exchange (FX) on your payments.","includeFiles":["products/fx/@v1/**/*"],"excludeFiles":[]},{"title":"Hosted Payment Pages (HPP) API","description":"Our low-code option to take payments securely at the lowest PCI compliance level - SAQ A.","includeFiles":["products/hosted-payment-pages/@v1/**/*"],"excludeFiles":[]},{"title":"Money Transfers API","description":"Money Transfer OCTs (Original Credit Transaction) allow funds to be pushed to an eligible card in 30 minutes or less.","includeFiles":["products/money-transfers/@v1/**/*"],"excludeFiles":[]},{"title":"Parties API","description":"Create parties, manage your payout instruments and beneficial owners and carry out identity verification checks.","includeFiles":["products/parties/@20250101/**/*"],"excludeFiles":[]},{"title":"SCA Exemptions API","description":"Maximize a frictionless checkout experience by using issuer data insights to apply exemptions.","includeFiles":["products/sca-exemptions/@v1/**/*"],"excludeFiles":[]},{"title":"Split Payments API","description":"Divide funds from a single payment amongst yourself and your parties/sellers.","includeFiles":["products/split-payments/@20250625/**/*"],"excludeFiles":[]},{"title":"Statements API","description":"Retrieve your account statement and see individual entries for all credits and debits.","includeFiles":["products/statements/@20250101/**/*"],"excludeFiles":[]},{"title":"Transfers API","description":"Transfer funds from source account to target account.","includeFiles":["products/transfers/@20250101/**/*"],"excludeFiles":[]},{"title":"Verified Tokens API","description":"Verified Tokens ensures that your customer's payment details are valid and CIT compliant when creating a token.","includeFiles":["products/verified-tokens/@v3/**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Last updated"]},": 30 September 2024 | ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/sca-exemptions/changelog/"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Change log"]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"ios-device-data","__idx":0},"children":["iOS device data"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["When combined with order and transaction details, device data (IP Address, Device Id, Geolocation Information, etc.) can be a strong indicator for fraud or used via GeoIP lookup to create manual rules based on location. Utilizing device data with Access Exemptions is a two-step process. Step one is to collect the device data. Step two is to submit an ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/sca-exemptions/assessment"},"children":["assessment"]}," that will use the device data for evaluation. Described below is step one for iOS."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"threatmetrix-ios-sdk","__idx":1},"children":["ThreatMetrix iOS SDK"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The ThreatMetrix iOS SDK provides mobile application developers with iOS specific libraries. It leverages the ThreatMetrix platform to detect fraud and security vulnerabilities originating from mobile devices in real-time."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The instructions are applicable to ThreatMetrix SDK version ",{"$$mdtype":"Tag","name":"b","attributes":{},"children":["V6-2"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"overview-of-implementation","__idx":2},"children":["Overview of implementation"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Include the ThreatMetrix SDK modules for profiling in the application."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Call the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["initProfile()"]}," method to initialize the SDK."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Call the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["doProfile()"]}," method to begin device profiling. ThreatMetrix SDK modules will transmit the collected attributes and a unique sessionId to the ThreatMetrix platform."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Apply the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sessionId"]}," in the Exemption assessment request so it forms part of the risk assessment."]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"how-to-get-the-sdk","__idx":3},"children":["How to get the SDK"]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"warning","name":"Note"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This will be released shortly, this documentation is for preview only"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"modules-to-include","__idx":4},"children":["Modules to include"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["TMXProfiling:"]}," This module is responsible for performing profiling exclusively. It does not transfer anything over the network, so the module does not send or receive data on its own. This module needs to be paired with the TMXProfilingConnections module or a custom profiling connections module to send and receive data to and from the backend for successful profiling."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["TMXProfilingConnections:"]}," It is the default networking module provided by ThreatMetrix. This module only transfers data over the network without changing the data."]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Download ",{"$$mdtype":"Tag","name":"b","attributes":{},"children":[".dmg"]}," files of TMXProfiling and TMXProfilingConnections modules and extract them to get ",{"$$mdtype":"Tag","name":"b","attributes":{},"children":[".xcframework"]}," file."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Copy the .xcframework files to your application directory as a dependency."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"using-threatmetrix-sdk","__idx":5},"children":["Using ThreatMetrix SDK"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"profiling","__idx":6},"children":["Profiling"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Profiling is a mechanism by which ThreatMetrix collects information about the device that is accessing a customer's online service, either via a website or a native application."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Identify the screen in your native application that provides the optimal opportunity for profiling. The majority of profiling is completed in a short span and may take up to 5 seconds to collect the full set of profiling attributes."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Common screens where we can initiate profiling are Account creation screen, Payments screen and Login screen."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"details-required","__idx":7},"children":["Details required"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Pass the below details to configure() method."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Placeholder"},"children":["Placeholder"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["TMXOrgId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["For testing use: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["afevfjm6"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["For live use: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["dzppsd1h"]}]}]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["TMXFingerprintServer/Profiling domain"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["For testing use: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ddc-test.worldpay.com"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["For live use: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ddc.worldpay.com"]}]}]}]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"get-instance-and-initialize","__idx":8},"children":["Get instance and initialize"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Create the instance of the TMXProfiling inside ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["initProfile()"]}," method."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Call ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["configure()"]}," method by passing at a minimum ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["TMXOrgId"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["TMXFingerprintServer/Profiling domain"]},"."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sharedInstance()"]}," method of TMXProfiling class is used to return a singleton instance of the ThreatMetrix Object. The instance is only required to be initialized once."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"start-profiling","__idx":9},"children":["Start profiling"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Create a method ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["doProfile()"]}," to start profiling and send some additional attributes along with profiling information."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Here’s an example of how you can create instance and initialize profiling by creating initProfile() and doProfile() methods."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"import TMXProfiling\nimport TMXProfilingConnections\nclass TmxProfileController : ObservableObject{\n\n    //Get a singleton instance of TMXProfiling\n    let profile: TMXProfiling!       = TMXProfiling.sharedInstance()\n    var sessionID     : String  = \"\"\n\n    func initProfile(){\n\n        // The profile.configure method is effective only once and subsequent calls to it will be ignored.\n        // Please note that configure may throw NSException if NSDictionary key/value(s) are invalid.\n        // This only happen due to programming error, therefore we don't catch the exception to make sure there is no error in our configuration dictionary\n\n            profile.configure(configData:[\n                                // (REQUIRED) Organisation ID\n                                TMXOrgID              :\"afevfjm6\",\n                                // (REQUIRED) Enhanced fingerprint server\n                                TMXFingerprintServer  :\"ddc-test.worldpay.com\"\n                                ])\n\n    }\n\n   func doProfile()\n    {\n\n        let customAttributes : [String : Array<String>] = [TMXCustomAttributes: [\"attribute 1\", \"attribute 2\"]]\n\n        // Fire off the profiling request.\n        // You will be notified of the profiling result in the closure passed in callbackBlock\n        let profileHandle: TMXProfileHandle = profile.profileDevice(profileOptions:customAttributes, callbackBlock:{(result: [AnyHashable : Any]?) -> Void in\n                let results:NSDictionary! = result! as NSDictionary\n                let status:TMXStatusCode  = TMXStatusCode(rawValue:(results.value(forKey: TMXProfileStatus) as! NSNumber).intValue)!\n\n                let statusString: String =\n                status == .ok                  ? \"OK\"                   :\n                status == .networkTimeoutError ? \"Timed out\"            :\n                status == .connectionError     ? \"Connection Error\"     :\n                status == .hostNotFoundError   ? \"Host Not Found Error\" :\n                status == .internalError       ? \"Internal Error\"       :\n                status == .interruptedError    ? \"Interrupted Error\"    :\n                \"Other\"\n                print(\"\\nProfile completed with: \\(statusString)\\nSession ID: \\(self.sessionID)\")\n        })\n        // Session id is immediately available on the instance of TMXProfileHandle following to the call to profile.profileDevice()\n        self.sessionID = profileHandle.sessionID;\n        print(\"Session equals :- \\(self.sessionID)\");\n    }\n\n}\n\n"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"obtaining-profiling-result","__idx":10},"children":["Obtaining profiling result"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Obtain the result of profiling using ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["TMXStatusCode"]}," and get SessionId using ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["profileHandle.sessionId"]},". Profiling is successful, if the status of profiling result is returned as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["OK"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"linking-the-device-data-with-the-assessment","__idx":11},"children":["Linking the device data with the assessment"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["When sending the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/sca-exemptions/assessment"},"children":["Exemption assessment"]}," request include the sessionId in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["deviceData.collectionReference"]}," ."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Next steps"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/sca-exemptions/assessment"},"children":["Assessment"]}]}]},"headings":[{"value":"iOS device data","id":"ios-device-data","depth":1},{"value":"ThreatMetrix iOS SDK","id":"threatmetrix-ios-sdk","depth":2},{"value":"Overview of implementation","id":"overview-of-implementation","depth":3},{"value":"How to get the SDK","id":"how-to-get-the-sdk","depth":2},{"value":"Modules to include","id":"modules-to-include","depth":2},{"value":"Using ThreatMetrix SDK","id":"using-threatmetrix-sdk","depth":2},{"value":"Profiling","id":"profiling","depth":3},{"value":"Details required","id":"details-required","depth":3},{"value":"Get instance and initialize","id":"get-instance-and-initialize","depth":3},{"value":"Start profiling","id":"start-profiling","depth":3},{"value":"Obtaining profiling result","id":"obtaining-profiling-result","depth":3},{"value":"Linking the device data with the assessment","id":"linking-the-device-data-with-the-assessment","depth":2}],"frontmatter":{"seo":{"title":"iOS device data"}},"lastModified":"2025-11-26T14:54:42.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/products/sca-exemptions/device-data/ios","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}