Installation

info

Access Credentials

are required to process with the installation of the SDK.

Please ensure that you have access to Veryfi Lens SDK. If you haven't already obtained access, please refer to the

Authentication

section for instructions.

iOS

info

The below steps assume that you already have Cocoapods installed and initialized in your project. If you're new to

Cocoapods

, visit the official

Getting Started

page.

1. Open your project's Podfile

2. Add the Veryfi private Cocoapods repository as a source at the top of the Podfile

Make sure that cocoapods spec repository is also specified as a source

source 'https://repo.veryfi.com/shared/lens/veryfi-lens-podspec.git'
source 'https://github.com/CocoaPods/Specs.git'

3. Add the VeryfiLens pod to your target

pod 'VeryfiLens'

3.1. (Optional) In case you're using static linkage in your pods:

Install cocoapods-pod-linkage plugin https://github.com/microsoft/cocoapods-pod-linkage

gem install "cocoapods-pod-linkage"

Import it in your Podfile

plugin 'cocoapods-pod-linkage'

Make sure to put use_framework! call inside your target

target 'MyTarget' do
    use_frameworks! :linkage => :static

Lastly, import Veryfi lens pod like this

pod 'VeryfiLens', 'x.x.x.x', :linkage => :dynamic

4. A minimal version of your Podfile should look similar to this:

source 'https://repo.veryfi.com/shared/lens/veryfi-lens-podspec.git'
source 'https://github.com/CocoaPods/Specs.git'
target 'VeryfiLensExample' do
use_frameworks!
pod 'VeryfiLens'
end

5. Using Swift package manager

• In Xcode go to File -> Add package dependencies and in the search field put the package url

https://repo.veryfi.com/shared/lens/veryfi-lens-spm.git

• You'll be prompted to put Username and Password to download the package, you must use the same credentials created for cocoapods in Next step

6. Generate Veryfi Lens SDK Access Credentials to pull the Lens SDK from Veryfi's private repository.

6.1. Navigate to the Keys Section:

• Sign in to the API Portal.
• Navigate to the Keys section under the Settings Menu.

6.2. Choose a Platform:

Within the Keys, choose Lens: Cocoapods (iOS) section and click the "Add Access Key" button.

6.3. Fill in required information:

You will be prompted to provide the following information:

• First and Last Name
• Email Address
• Create a Password

Upon providing the required information, your username will be generated.

In the documentation, the created cocoapods username and password will be referred to as COCOAPODS_USERNAME and COCOAPODS_PASSWORD. You can now use these credentials to access the privately stored SDK.

info

The password you create here will be used to access the SDK, and it won't be displayed in the Keys section again. Make sure to save it in a secure place.

6.4. Store Cocoapods Access Credentials with Git Credential Tool (Recommended)

For convenience and security, we recommend storing these access credentials using a Git Credential Storage. This will ensure that you are automatically logged in each time you install or update the Lens SDK.

• Replace COCOAPODS_USERNAME and COCOAPODS_PASSWORD with corresponding credentials

git credential approve <<EOF
protocol=https
host=repo.veryfi.com
path=shared/lens/veryfi-lens-podspec.git
username=COCOAPODS_USERNAME
password=COCOAPODS_PASSWORD

EOF

7. Install Lens

Run the command in the Terminal, in the root folder of your project:

pod install

Android

1. Generate Veryfi Lens SDK Access Credentials to pull the Lens SDK from Veryfi's private repository.

1.1. Navigate to the Keys Section:

• Sign in to the API Portal.
• Navigate to the Keys section under the Settings Menu.

1.2. Choose a Platform:

Within the Keys, choose Lens: Maven (Android) section and click the "Add Access Key" button.

1.3. Fill in required information:

You will be prompted to provide the following information:

• First and Last Name
• Email Address
• Create a Password

Upon providing the required information, your username will be generated.

The generated credentials are referred to as MAVEN_USERNAME and MAVEN_PASSWORD. You can now use these credentials to access the privately stored SDK.

info

The password you create here will be used to access the SDK, and it won't be displayed in the Keys section again. Make sure to save it in a secure place.

1.4. Add your Access Credentials to your system environment.

Open your system profile (~/.bash_profile, ~/.zshrc or similar) and add next environmental variables there.

Replace MAVEN_USERNAME and MAVEN_PASSWORD with corresponding credentials

export MAVEN_VERYFI_USERNAME=MAVEN_USERNAME
export MAVEN_VERYFI_PASSWORD=MAVEN_PASSWORD

2. Add the Veryfi Maven repository to the dependencyResolutionManagement.repositories section of your settings.gradle

Groovy

dependencyResolutionManagement {
    repositories {
        //Add Veryfi Maven repository for VeryfiLens SDK
        maven {
            url "https://nexus.veryfi.com/repository/maven-releases/"
            credentials {
                username = System.getenv("MAVEN_VERYFI_USERNAME")
                password = System.getenv("MAVEN_VERYFI_PASSWORD")
            }
            authentication {
                basic(BasicAuthentication)
            }
        }
    }
}

Kotlin

dependencyResolutionManagement {
    repositories {
        //Add Veryfi Maven repository for VeryfiLens SDK
        maven {
            url = uri("https://nexus.veryfi.com/repository/maven-releases/")
            credentials {
                username = System.getenv("MAVEN_VERYFI_USERNAME")
                password = System.getenv("MAVEN_VERYFI_PASSWORD")
            }
        }
    }
}

3. Add Veryfi Lens to the dependencies in your build.gradle (:app) file:

Replace VERSION with the latest Veryfi Lens SDK version. Refer to

Release notes

for the version history.

Groovy

dependencies {
    implementation 'com.veryfi.lens:veryfi-lens-receipts-sdk:VERSION'
}

Kotlin

dependencies {
    implementation("com.veryfi.lens:veryfi-lens-receipts-sdk:VERSION")
}

Capacitor

info

Whether you are creating a project from scatch or adding a Capacitor to the existing project, follow the steps in the

Official Capacitor Documentation

to make sure that the project is configured correctly.

1. Install the native platforms

After the Capacitor project is configured, make sure that you have installed all the required native platfroms.

npm install @capacitor/ios @capacitor/android
npx cap add ios
npx cap add android

2. Generate Veryfi Lens SDK Access Credentials

1. Sign in to the API Portal.
2. Navigate to the Keys section under the Settings Menu.
3. Within the Keys, choose Lens: Capacitor (iOS + Android) section and click the "Add Access Key" button.
4. Fill in required information:

You will be prompted to provide the following information:

• First and Last Name
• Email Address
• Create a Password

Upon providing the required information, your username will be generated.

The generated credentials are referred to as NPM_USERNAME and NPM_PASSWORD. You can now use these credentials to access the privately stored SDK.

info

The password you create here will be used to access the SDK, and it won't be displayed in the Keys section again. Make sure to save it in a secure place.

3. Configure the npm registry location and credentials.

Add Access Credentials and Veryfi Nexus repository to your .npmrc configuration file

Replace NPM_USERNAME and NPM_PASSWORD with corresponding credentials.

echo "@veryfi:registry=https://nexus.veryfi.com/repository/npm/" >> ~/.npmrc

echo "config=set" >> ~/.npmrc

echo "//nexus.veryfi.com/repository/npm/:username=NPM_USERNAME" >> ~/.npmrc

echo "//nexus.veryfi.com/repository/npm/:_password=$(echo -n NPM_PASSWORD | base64)" >> ~/.npmrc

4.Add the Lens Capacitor plugin to your project

npm i @veryfi/veryfi-lens-capacitor

React Native

info

Whether you are creating a React Native project from scatch or using the existing one, follow the steps in the

Official React Native Documentation

to make sure that the project and enviroment are configured correctly.

1. Generate Veryfi Lens SDK Access Credentials

1.1. Navigate to the Keys Section:

• Sign in to the API Portal.
• Navigate to the Keys section under the Settings Menu.

1.2. Choose a Platform:

Within the Keys, choose Lens: React Native (iOS + Android) section and click the "Add Access Key" button.

1.3. Fill in required information:

You will be prompted to provide the following information:

• First and Last Name
• Email Address
• Create a Password

Upon providing the required information, your username will be generated.

The generated credentials are referred to as NPM_USERNAME and NPM_PASSWORD. You can now use these credentials to access the privately stored SDK.

info

The password you create here will be used to access the SDK, and it won't be displayed in the Keys section again. Make sure to save it in a secure place.

React Native

2. Configure the npm registry location and credentials.

Add Access Credentials and Veryfi Nexus repository to your .npmrc configuration file

Replace NPM_USERNAME and NPM_PASSWORD with corresponding credentials.

echo "@veryfi:registry=https://nexus.veryfi.com/repository/npm/" >> ~/.npmrc
echo "config=set" >> ~/.npmrc
echo "//nexus.veryfi.com/repository/npm/:username=NPM_USERNAME" >> ~/.npmrc
echo "//nexus.veryfi.com/repository/npm/:_password=$(echo -n NPM_PASSWORD | base64)" >> ~/.npmrc

Expo

2. Store Access Credentials in EAS Secrets

If you use EAS to build your iOS or Android project, you need to add in the Secrets section of your EAS project the variable enviroments that you set in the previous step with your credentials. Make sure to upload this .npmrc in the root of your project.

NPM_USERNAME=[USERNAME]
NPM_PASSWORD=[PASSWORD]

2.1 Create an .npmrc file and store it in the root of your project:

The .npmrc files content should be:

@veryfi:registry=https://nexus.veryfi.com/repository/npm/
config=set
//nexus.veryfi.com/repository/:username=${NPM_USERNAME}
//nexus.veryfi.com/repository/:_password=${NPM_PASSWORD}

3. Add the plugin to your React Native project.

npm i @veryfi/react-native-veryfi-lens

Flutter

info

The Veryfi Lens Flutter SDK only supports flutter >=1.20.0 SDK versions

info

Whether you are creating a project from scatch or using the existing FLuuter project, follow the steps in the

Official Flutter Documentation

to make sure that it is configured correctly.

1. Generate Veryfi Lens SDK Access Credentials

1.1. Navigate to the Keys Section:

• Sign in to the API Portal.
• Navigate to the Keys section under the Settings Menu.

1.2. Choose a Platform:

Within the Keys, choose Lens: Flutter (iOS + Android) section and click the "Add Access Key" button.

1.3. Fill in required information:

You will be prompted to provide the following information:

• First and Last Name
• Email Address
• Create a Password

Upon providing the required information, your username will be generated.

The generated credentials are referred to as FLUTTER_USERNAME and FLUTTER_PASSWORD. You can now use these credentials to access the privately stored SDK.

info

The password you create here will be used to access the SDK, and it won't be displayed in the Keys section again. Make sure to save it in a secure place.

2. Add the Veryfi Lens SDK dependency to your Flutter project's pubspec.yaml file.

1. Open the pubspec.yaml file
2. Add the following lines under the dependencies section
3. Replace FLUTTER_USERNAME and FLUTTER_PASSWORD with the corresponding credentials
4. Replace PLUGIN_VERSION with the

   latest Veryfi Lens SDK version

   listed in the

   Release Notes

   section.

dependencies:
  ...
  veryfi:
    git:
      url: https://FLUTTER_USERNAME:FLUTTER_PASSWORD@repo.veryfi.com/shared/lens/flutter-plugin-veryfi-lens.git
      ref: PLUGIN_VERSION

The minimal version of the dependencies section should look like:

dependencies:
  flutter:
    sdk: flutter
  veryfi:
    git:
      url: https://XXX:XXX@repo.veryfi.com/shared/lens/flutter-plugin-veryfi-lens.git
      ref: 1.5.25

3. Install Veryfi Lens SDK

info

Check

Official Flutter Documentation

to learn how to add and install Flutter packages

Terminal

Run the next command from terminal

flutter pub get

VS Code

Click Get Packages located in right side of the action ribbon at the top of pubspec.yaml indicated by the Download icon.

Android Studio/IntelliJ

Click Pub get in the action ribbon at the top of pubspec.yaml.

.NET

1. With your Xamarin project open in Visual Studio, right-click on your project's Packages and select Manage NuGet Packages...

The generated credentials are referred to as DOTNET_USERNAME and DOTNET_PASSWORD. You can now use these credentials to access the privately stored SDK.

info

The password you create here will be used to access the SDK, and it won't be displayed in the Keys section again. Make sure to save it in a secure place.

2. Add Veryfi Lens SDK NuGet Package

1. Open your Xamarin Project
2. In the menu bar, go to the Project -> Manager NuGet Packages
3. In Package Sources Dropdown, select Configure Sources...
4. Add a new Package Source
5. Fill in the required information

Name: Veryfi
Location: https://nexus.veryfi.com/repository/nuget/
Username: DOTNET_USERNAME
Password: DOTNET_PASSWORD

tip

If you are getting "Invalid Credentials" error, try closing and opening the Manager NuGet Packages Window one more time

3. Install Veryfi Lens Plugin package

.NET iOS Project

1. Select Veryfi in the Package source dropdown
2. Select VeryfiLensiOSNetBinding
3. Add this package to your iOS .NET project

.NET Android Project

1. Select Veryfi in the Package source dropdown
2. Select VeryfiLenAndroidNetBinding
3. Add this package to your iOS .NET project