Skip to content

2.4.0

Latest

Choose a tag to compare

@footprint-release-bot footprint-release-bot released this 17 Nov 17:31

Changelog for Swift onboarding components SDK

Updating this file is one of the requirements for GitHub CI/CD for Swift package release

2.4.0

  • The hosted flow reads FootprintL10n the way footprint-js does, so a field you leave out no longer falls back to English or en-US. With only language set, dates follow the phone's format instead of US order. With only locale set, the flow shows that locale's language instead of English. FootprintSupportedLanguage gains pt and ja, and FootprintSupportedLocale gains pt_BR, ja_JP and nine English locales such as en_GB and en_CA.

  • Record the selfie video in native capture when the playbook asks for one, with an identity document's selfie or a Selfie node, and upload it before the selfie is processed. As in idv2, a required clip that gets no answer or a server error is tried once more, and one that still doesn't upload has the camera ask for another selfie without spending one of its attempts. captureSelfie now captures a Selfie node that requires the video, and throws E_SELFIE_VIDEO_REQUIRED only when the device records no clip. uploadDocumentSide takes an optional videoPath, FootprintDocumentConfig exposes shouldRecordSelfieVideo, and FootprintDocumentCaptureContext passes it to capture providers.

    Breaking for custom capture providers: FootprintDocumentCaptureContext.uploadSide takes the clip's videoPath. This minor release accepts that, since the provider interface is undocumented and only the bundled document capture implements it.

  • Launch the onboarding flow with Onboarding.initialize(onboardingSessionToken:), without .shared, as on Android. Onboarding.shared still works but is deprecated, and the next major version removes it.

  • Document image and video uploads get 61 s, like the web flow. On Android they failed after the HTTP engine's 15 s, which every other request keeps; on iOS they had no overall limit.

2.3.0

  • The FootprintDeviceIntelligence product now uses Fingerprint's v4 SDK (https://github.com/fingerprintjs/fingerprint-ios, 4.2 or later) in place of fingerprintjs-pro-ios. Apps that opted in pick it up with this update and need no code change.

2.2.0

  • Added captureSelfie() for the standalone selfie a Selfie node asks for; getDocumentConfig() reports it with isSelfie. It opens the front camera and captures manually when the node's face detection is off. A selfie that requires a video clip (isSelfieVideoRequired) throws E_SELFIE_VIDEO_REQUIRED, since native capture doesn't record video yet; hand it off to the hosted flow. See the native onboarding docs.
  • Capture results gain isRetryLimitExceeded, set when the backend rejected the last allowed capture.
  • Behavior change: native capture now honors autoCapture and allowGalleryUpload, which it ignored before, so autoCapture: false starts in manual capture and hides the toggle.
  • Breaking for custom capture providers: FootprintDocumentCaptureContext.countryCode is now optional, since a selfie has no country.
  • Behavior change: device intelligence is now opt-in. FingerprintPro moved out of Footprint into the FootprintDeviceIntelligence product, so apps that already bundle FingerprintPro avoid a duplicate framework. To keep sending device signals, add that product and call registerFootprintDeviceIntelligence() once before onboarding; without it, onboarding completes without them.

2.1.0

  • Added a single initialize(authToken:); initializeWithAuthToken / initializeWithPublicKey are deprecated (still functional this version; public-key init is removed next major).
  • Added the opt-in FootprintDocumentCapture product for native document capture, and collect_custom_data support. See the native onboarding docs.

2.0.0

Bank linking is now a separate, opt-in product, and the previous Plaid dependency has been removed.

  • Removed the Plaid (LinkKit) dependency. Removed the Plaid dependency.
  • Bank linking moved to a new FootprintBankLinking product. If you use bank linking, you must:
    1. Add the FootprintBankLinking library product to your target (alongside Footprint).
    2. Add import FootprintBankLinking to any file that uses FootprintBankLinking, BankLinkingCompletionResponse, or the other bank-linking types.
  • Onboarding-only consumers: no changes required. The core Footprint product no longer links MoneyKit or Plaid, so your app gets a smaller binary.

1.5.6

Add internal baseUrl overrides for automated testing to enhance stability of releases. No changes required on the client side.

1.5.5

Add internal tracking for SDK version to we can upgrade clients when their version is outdated. No changes required on the client side.

1.5.4

Upgrade MKit to v1.11.2. No changes needed on client side other than upgrading.

1.5.3

Lock internal dep MKit to v1.10.7. because the new version they released breaks the integration. No changes needed on client side other than upgrading.

1.5.2

Fix double sheet problem in BAL

1.5.1

Internal API fix

1.5.0

Update BAL interface

1.4.1

Upgrade to MK 1.10.4

1.4.0

Previous 1.3.9 got corrupt because MK didn't provide stable version. Releasing with stable MK 1.10.3

1.3.9

Use MK branch "release/1.10.3"

v1.3.8

BAL thread callback issue fixed in new MoneyKit release

v1.3.7

Internal API updates

v1.3.4

Add SDK version to the URL, remove sandbox outcome and options props from Onboarding.shared.initialize()

v1.3.3

Add Kosovo to supported countries for doc collection

v1.3.2

Update api types

v1.3.1

Update prop name in Onboarding.shared.initialize

v1.3.0

Onboarding in background

v1.2.1

Patch: make the success meta fields public BAL

v1.2.0

Added additional metadata in onSuccess callback for bank linking

v1.1.1

Add support for onEvent callback in bank linking

v1.1.0

Add custom fields support

v1.0.3

Add better support appearance and bootstrap data in hosted flow (launchHosted function)

v1.0.2

Update APIs for OBE support

v1.0.1

Patch Bank linking to return validation token onSuccess

v1.0.0

Publish a new stable version

v1.0.3-beta

Publish Footprint Bank Linking

v1.0.2-beta

Bump some dependencies version

v1.0.1-beta

Add fingerprint integration

v1.0.0-beta

Initial beta release

v1.0.0-alpha

Initial alpha release

v0.2.43

Initial test release