Credolab iOS SDK is a Swift library designed to capture a client's device metadata for future processing to gain scores and insights. # Pick The Right Modules The Credolab iOS SDK is modular by design. At its foundation is a single mandatory Core module, which operates without accessing any runtime permissions. All additional features are provided through optional modules and plugins, each requesting only the specific permissions they require. This approach allows you to begin integration with just the modules that align with your app's existing permission set, keeping the implementation flexible, secure, and fully permission-scoped.

### What are ![](https://img.shields.io/badge/runtime%20permissions-4cb9d6) ? Allows access to **protected resources** or **actions**, such as contacts, calendar, or media. These permissions must be explicitly **granted by the User at runtime**. Read more on developer.apple.com # Versions ### Framework Types The Credolab iOS SDK is available in two framework types: - **[Dynamic Frameworks](https://docs.credolab.com/docs/ios-sdk#dynamic-frameworks)** - **[Static Frameworks](https://docs.credolab.com/docs/ios-sdk#static-frameworks)** ## Dynamic Frameworks ### Mandatory module version | Dependency Name | Permissions | Version | | ----------------------------------------------------------------------------------------------------------------- | ----------- | ------- | | `CredoAppCore`
![no permissions required](https://img.shields.io/badge/no%20permissions%20required-c0d804) | — | 3.14.0 | ### Optional module versions | Dependency Name | Permissions | Version | | ------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------- | ------- | | `CredoAppApplication`
![no permissions required](https://img.shields.io/badge/no%20permissions%20required-c0d804) | — | 3.1.1 | | `CredoAppBehavioral`
![no permissions required](https://img.shields.io/badge/no%20permissions%20required-c0d804) | — | 3.8.2 | | `CredoAppCalendarEvents`
![runtime permissions](https://img.shields.io/badge/runtime%20permissions-4cb9d6) | `NSCalendarsUsageDescription`
`NSCalendarsFullAccessUsageDescription` | 3.2.0 | | `CredoAppCalendarReminders`
![runtime permissions](https://img.shields.io/badge/runtime%20permissions-4cb9d6) | `NSRemindersUsageDescription`
`NSRemindersFullAccessUsageDescription` | 3.2.0 | | `CredoAppContacts`
![runtime permissions](https://img.shields.io/badge/runtime%20permissions-4cb9d6) | `NSContactsUsageDescription` | 3.3.0 | | `CredoAppMusic`
![runtime permissions](https://img.shields.io/badge/runtime%20permissions-4cb9d6) | `NSAppleMusicUsageDescription` | 3.1.1 | | `CredoAppMedia`
![runtime permissions](https://img.shields.io/badge/runtime%20permissions-4cb9d6) | `NSPhotoLibraryUsageDescription` | 3.2.0 | | `CredoAppLocation`
![runtime permissions](https://img.shields.io/badge/runtime%20permissions-4cb9d6) | `NSLocationWhenInUseUsageDescription` or `NSLocationAlwaysUsageDescription` | 3.0.0 | | `CredoAppTelephony`
![no permissions required](https://img.shields.io/badge/no%20permissions%20required-c0d804) | — | 3.0.1 | | `CredoAppMaid`
![runtime permissions](https://img.shields.io/badge/runtime%20permissions-4cb9d6) | `NSUserTrackingUsageDescription` | 3.0.0 |
### Third-party module versions | Dependency Name | Permissions | Version | | ----------------------------------------------------------------------------------------------------------- | ----------- | ------- | | `FraudForce`
![runtime permissions](https://img.shields.io/badge/runtime%20permissions-4cb9d6) | — | 5.8.0 | | `CredoAppIovation`
![runtime permissions](https://img.shields.io/badge/runtime%20permissions-4cb9d6) | — | 3.4.0 |
`CredoAppIovation` requires a minimum iOS 15 starting from version `3.4.0`. `FraudForce` requires a minimum iOS 15 starting from version `5.8.0`. Use versions `3.3.0 `and `5.6.0`, respectively, if the app’s minimum target is iOS 12 or higher. ### Plugin versions | Dependency Name | Permissions | Version | | -------------------------------------------------------------------------------------------------------------------- | ----------- | ------- | | `CredoAppLogging`
![no permissions required](https://img.shields.io/badge/no%20permissions%20required-c0d804) | — | 3.4.0 | `CredoAppLogging` requires a minimum iOS 15 starting from version `3.4.0` ## Static Frameworks ### Mandatory module version | Dependency Name | Permissions | Version | | ----------------------------------------------------------------------------------------------------------------- | ----------- | ------- | | `CredoAppCore`
![no permissions required](https://img.shields.io/badge/no%20permissions%20required-c0d804) | — | 4.3.0 | ### Optional module versions | Dependency Name | Permissions | Version | | ------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------- | ------- | | `CredoAppApplication`
![no permissions required](https://img.shields.io/badge/no%20permissions%20required-c0d804) | — | 4.2.0 | | `CredoAppBehavioral`
![no permissions required](https://img.shields.io/badge/no%20permissions%20required-c0d804) | — | 4.2.0 | | `CredoAppCalendarEvents`
![runtime permissions](https://img.shields.io/badge/runtime%20permissions-4cb9d6) | `NSCalendarsUsageDescription`
`NSCalendarsFullAccessUsageDescription` | 4.0.0 | | `CredoAppCalendarReminders`
![runtime permissions](https://img.shields.io/badge/runtime%20permissions-4cb9d6) | `NSRemindersUsageDescription`
`NSRemindersFullAccessUsageDescription` | 4.0.0 | | `CredoAppContacts`
![runtime permissions](https://img.shields.io/badge/runtime%20permissions-4cb9d6) | `NSContactsUsageDescription` | 4.2.0 | | `CredoAppMusic`
![runtime permissions](https://img.shields.io/badge/runtime%20permissions-4cb9d6) | `NSAppleMusicUsageDescription` | 4.0.0 | | `CredoAppMedia`
![runtime permissions](https://img.shields.io/badge/runtime%20permissions-4cb9d6) | `NSPhotoLibraryUsageDescription` | 4.0.0 | | `CredoAppLocation`
![runtime permissions](https://img.shields.io/badge/runtime%20permissions-4cb9d6) | `NSLocationWhenInUseUsageDescription` or `NSLocationAlwaysUsageDescription` | 4.0.0 | | `CredoAppTelephony`
![no permissions required](https://img.shields.io/badge/no%20permissions%20required-c0d804) | — | 4.2.0 | | CredoAppAttest
![no permissions required](https://img.shields.io/badge/no%20permissions%20required-c0d804) | — | 4.0.0 | `CredoAppAttest` module extracts metadata that verifies the integrity of the app and the authenticity of the device by using Apple's App Attest service. The module generates a hardware-backed cryptographic key in the Secure Enclave and requests an attestation object for it from Apple. Because attestation is issued by Apple, the module performs a network request to Apple's App Attest servers. Available beginning from iOS 14. ### Third-party module versions | Dependency Name | Permissions | Version | | --------------------------------------------------------------------------------------------------------------------- | ----------- | ------- | | `FraudForce`
Dynamic framework | — | 5.8.0 | | `CredoAppIovation`
![no permissions required](https://img.shields.io/badge/no%20permissions%20required-c0d804) | — | 4.1.0 | `FraudForce` is distributed as a dynamic framework, regardless of whether you are using dynamic or static Credolab SDK frameworks. `CredoAppIovation` requires a minimum iOS 15 starting from version. ### Plugin versions | Dependency Name | Permissions | Version | | -------------------------------------------------------------------------------------------------------------------- | ----------- | ------- | | `CredoAppLogging`
![no permissions required](https://img.shields.io/badge/no%20permissions%20required-c0d804) | — | 4.1.0 | `CredoAppLogging` requires `Sentry` version 9.0.0 or higher.
### Using Xcode 15+, all privacy manifests in an app and its third-party SDKs automatically roll up into a [single privacy report](https://developer.apple.com/documentation/bundleresources/privacy_manifest_files/describing_data_use_in_privacy_manifests#4239187). Refer to this report when you provide your app’s privacy details in App Store Connect. *** # SDK Description ## Mandatory module ### Core ![](https://img.shields.io/badge/no%20permissions%20required-c0d804) Extracts various metadata connected with device characteristics and configuration. This includes info about the device brand, model, total and available free memory, and other data describing the device.
*** ## Optional modules ### Behavioral ![](https://img.shields.io/badge/no%20permissions%20required-c0d804) Extracts metadata related to the user’s in-app behavior, such as taps, text input, etc. ### Contacts ![](https://img.shields.io/badge/runtime%20permissions-4cb9d6) Extracts various metadata connected with Contacts and Contacts Group presented on the device. - `NSContactsUsageDescription` ### Calendar Events ![](https://img.shields.io/badge/runtime%20permissions-4cb9d6) Extracts metadata connected with calendar events information presented on the device. This includes metadata of calendar events, such as whether an event has an organiser, location, alarm or not, etc. - `NSCalendarsUsageDescription` - `NSCalendarsFullAccessUsageDescription` Starting from iOS 17 `NSCalendarsUsageDescription` has been deprecated. Please additionally declare `NSCalendarsFullAccessUsageDescription` permission to ensure compatibility with iOS 17 and higher. ### Calendar Reminders ![](https://img.shields.io/badge/runtime%20permissions-4cb9d6) Extracts metadata connected with calendar reminder information presented on the device. This includes metadata of calendar reminders such as whether the reminder has notes, attendees, alarms or not, etc. - `NSRemindersUsageDescription` - `NSRemindersFullAccessUsageDescription` Starting from iOS 17 `NSRemindersUsageDescription` has been deprecated. Please additionally declare `NSRemindersFullAccessUsageDescription` permission to ensure compatibility with iOS 17 and higher. ### Media ![](https://img.shields.io/badge/runtime%20permissions-4cb9d6) Extracts metadata connected with pictures, music, audio, and videos that are located in the device. - `NSPhotoLibraryUsageDescription` ### Music ![](https://img.shields.io/badge/runtime%20permissions-4cb9d6) Extracts metadata connected with audio that is located on the device. - `NSAppleMusicUsageDescription` ### Application ![](https://img.shields.io/badge/no%20permissions%20required-c0d804) Extracts metadata associated with determining the installation status of a specific application. This identification is carried out by examining the URL Schemas.
### Location ![](https://img.shields.io/badge/runtime%20permissions-4cb9d6) Extracts metadata associated with location information, including whether the location is spoofed and other related data. This metadata is available beginning from iOS 15. - `NSLocationWhenInUseUsageDescription`or `NSLocationAlwaysUsageDescription` ### Mobile Ad ID (IDFA) ![](https://img.shields.io/badge/runtime%20permissions-4cb9d6) Extracts a unique, resettable identifier Apple assigns to devices. This metadata is available beginning from iOS 14. - `NSUserTrackingUsageDescription` ### Telephony ![](https://img.shields.io/badge/no%20permissions%20required-c0d804) Extracts metadata related to calls and their states that are in progress. *** ## Third-party optional modules ### Iovation ![](https://img.shields.io/badge/no%20permissions%20required-c0d804) Extracts device profile metadata collected by TruValidate(formerly known as iovation) SDK, such as device type, geolocation & browser information, and system settings. *** ## Plugins ### Logging ![](https://img.shields.io/badge/no%20permissions%20required-c0d804) Optional plugin for capturing SDK errors. **Recommended for issue tracking.** # Mobile Data Flow

1. Mobile Client triggers the Core Module to start data collection 2. The Core Module collects data from attached modules and returns an encrypted dataset 3. Mobile Client sends the dataset to Credolab via a Reverse Proxy with a unique reference number 4. Client's Server requests scores and insights from Credolab using that reference number