Mobile SDK stages

The Mobile SDK supports the stages below.


This is the first screen and will always default to show as the first screen. It displays a welcome message and a summary of the stages you have configured for the client.

The welcome screen allows you to set a custom title.

let welcomeStage = WelcomeStageBuilder()
  .setTitle(title: "Custom Screen Title")
  .setMessage(message: "Custom welcome message.")

You can optionally add this stage to enforce explicit consent collection before the client can progress in the flow.

The consent screen allows you to set a custom title.

let consentStage = UserConsentStageBuilder()
     .setTitle(title: "Terms of Service")

Selfie photo and video

You can request a selfie photo (i.e. a Live Photo for an Identity Check) capture or video (i.e. a Live Video for an Enhanced Identity check) capture from your client.

  • Photo - will take a photo of the client and perform a liveness check before allowing them to submit.

let selfieStage = BiometricStageBuilder()
  .setType(type: .photo)
  // Enable ML assistance during capture
  .setEnableMLAssistant(enable: false)
  • Video - will take a video of the client and request them to perform a challenge before allowing them to submit.

let videoStage = BiometricStageBuilder()
  .setType(type: .video)
  // Enable ML assistance during capture
  .setEnableMLAssistant(enable: false)

If you attempt to add both types of stages, the SDK will throw a ComplyCubeErrorCode.BiometricStageCount error stating multiple conflicting stages.


This stage allows clients to select the type of identity document they would like to submit. You can customize these screens to:

  • Limit the scope of document types the client can select, e.g., Passport only.

  • Set the document issuing countries they are allowed for each document type.

  • Add or remove automated capture using smart assistance.

  • Show or hide the instruction screens before capture.

  • Set a retry limit to allow clients to progress the journey regardless of capture quality.

If you provide only one document type, the document type selection screen will be skipped. The country selection screen will be skipped if you provide only a single country for a given document type.

You can remove the information screens shown before camera captures by enabling or disabling guidance. You should only consider omitting this if you have clearly informed your client of the capture steps required.

let docStage = DocumentStageBuilder()
  // Set document types and limit the enabled countries
  .setAllowedDocumentTypes(types: [
    .drivingLicence(["GB", "US"]),
  // Set a maximum for quality check attempts before uploading
  .setRetryLimit(count: 3)
  // Enable or disable additional guidance for the user
  .setShowGuidance(enable: true)
  // Enable ML assistance during capture
  .setEnableMLAssistant(enable: true)

Please note the retryLimit you set here will take precedence over the retry limit that has been set globally in your automation settings.

NFC capture

Please get in touch with your Account Manager or support to get access to our NFC-enabled Mobile SDK.

ComplyCube's Mobile SDK enables NFC-based RFID chip reading in identity documents for accurate authentication and data extraction.


To use this feature, your app must have the Near Field Communication Tag Reading capability enabled. To add this capability to your app, refer to Apple's guide here.


  1. Install the CocoaPods Artifactory plugin by running the following command in your terminal:

    gem install cocoapods-art

  2. To add the library, copy your repository credentials into a .netrc file to your home directory and setup the repository:

    pod repo-art add cc-cocoapods-release-local ""

    Remember to fetch your credentials from Jfrog using the Set Me Up button here.

  3. Add plugin repos and install the pod using your Podfile:

     plugin 'cocoapods-art', :sources => [
     platform :ios, '13.0' # Or above
     target 'YourApp' do
       pod 'ComplyCubeMobileSDK'

  4. You must add the following keys to your application Info.plist file:

<string>Required to read from NFC enabled documents</string>
  1. To read NFC tags correctly, you need to add the following entries to your app target's Info.plist file:


Enabling NFC capture

let docStage = DocumentStageBuilder()
  // Add this property to enable NFC
  .setEnableNFC(enable: true)

Address capture

This stage allows clients to input their address. You can set the permitted countries and whether to enable our address autocomplete screen.

let addressCaptureStage = AddressCaptureStageBuilder()
  // This enables our address autocomplete feature
  .useAutoComplete(enable: false)
  // A list of acceptable countries for address capture feature
  .setAllowedCountries(["GB", "US"])

Proof of address

When requesting a proof of address document, you can set the allowed document types and whether the client can upload the document.

By default, this automatically incorporates the Address capture stage with autocomplete enabled. This option can be turned off.

let poaStage = AddressStageBuilder()
  .setAllowedDocumentTypes(types: [
  // When disabled, the client will be forced to perform a live capture
  .useLiveCaptureOnly(enable: false)
  // This enables address capture during the proof of address flow


You can add an optional completion stage at the end of the process and let the client know the process has been completed.

var completionStage = Complete(
    title: "Thank you!",
    message: "Your KYC submission has been completed"

Last updated