Veryfi

https://docs.veryfi.com
Admin
Veryfi provides an OCR API for secure data extraction, a data capture mobile SDK, and toolkits to...
Tokens:275,100
Snippets:2,727
Trust Score:10
Update:3 months ago
Show doc for...
Tokens:
Raw
### Full implementation example

Source: https://docs.veryfi.com/lens/mobile/introduction/quick_start

A complete example showing integration within an Activity.

```kotlin
class MyActivity : AppCompatActivity(), VeryfiLensDelegate {  
  
    override fun onCreate(savedInstanceState: Bundle?) {  
        super.onCreate(savedInstanceState)  
  
        val credentials = VeryfiLensCredentials().apply {  
            clientId = "CLIENT_ID"  
            username = "USERNAME"  
            apiKey = "API_KEY"  
            url = "URL"  
        }  
  
        val settings = VeryfiLensSettings().apply {  
            autoCaptureIsOn = true  
            autoRotateIsOn = true  
            documentTypes = arrayListOf(DocumentType.RECEIPT)  
        }  
  
        VeryfiLens.setDelegate(this)  
        VeryfiLens.configure(application, credentials, settings) { }  
    }  
  
    override fun veryfiLensClose(json: JSONObject) { Log.d("Lens", json.toString(2)) }  
    override fun veryfiLensError(json: JSONObject) { Log.d("Lens", json.toString(2)) }  
    override fun veryfiLensSuccess(json: JSONObject) { Log.d("Lens", json.toString(2)) }  
    override fun veryfiLensUpdate(json: JSONObject) { Log.d("Lens", json.toString(2)) }  
  
    private fun onSomeButtonClicked() {  
        VeryfiLens.showCamera()  
    }  
}
```

--------------------------------

### Minimal Android Implementation

Source: https://docs.veryfi.com/lens/mobile/any-docs/initialization

A complete example showing the setup of credentials, settings, and delegate implementation within an Android Activity.

```csharp
namespace LensAndroidTest;  
using Com.Veryfi.Lens;  
using Com.Veryfi.Lens.Helpers;  
using Org.Json;  
  
[Activity(Label = "@string/app_name", MainLauncher = true)]  
  
  
public class MainActivity : Activity  
{  
  
    protected override void OnCreate(Bundle? savedInstanceState)  
    {  
        base.OnCreate(savedInstanceState);  
        // Set our view from the "main" layout resource  
        SetContentView(Resource.Layout.activity_main);  
  
        const String CLIENT_ID = "XXX"; // replace XXX with your assigned Client Id  
        const String USERNAME = "XXX";  // replace XXX with your assigned Username  
        const String API_KEY = "XXX";   // replace XXX with your assigned API Key  
        const String URL = "XXX";       // replace XXX with your assigned Endpoint URL e.g. api.veryfi.com  
  
        var veryfiLensCredentials = new VeryfiLensCredentials  
        {  
            ClientId = CLIENT_ID,  
            Username = USERNAME,  
            ApiKey = API_KEY,  
            Url = URL  
        };  
  
        VeryfiLensSettings veryfiLensSettings = new VeryfiLensSettings  
        {  
            AutoLightDetectionIsOn = false,  
            BlurDetectionIsOn = true,  
            DocumentTypes = new List<DocumentType> { DocumentType.Receipt },  
            ShowDocumentTypes = true  
        };  
  
  
        VeryfiLens.Configure(Application, veryfiLensCredentials, veryfiLensSettings);  
  
        VeryfiLens.SetDelegate(new VeryfiLensDelegateListener());  
  
        VeryfiLens.ShowCamera();  
  
    }  
  
    private class VeryfiLensDelegateListener : Java.Lang.Object, IVeryfiLensDelegate  
    {  
        public void VeryfiLensClose(JSONObject json)  
        {  
            Console.WriteLine(json.ToString());  
        }  
  
        public void VeryfiLensError(JSONObject json)  
        {  
            Console.WriteLine(json.ToString());  
        }  
  
        public void VeryfiLensSuccess(JSONObject json)  
        {  
            Console.WriteLine(json.ToString());  
        }  
  
        public void VeryfiLensUpdate(JSONObject json)  
        {  
            Console.WriteLine(json.ToString());  
        }  
    }  
}  
```

--------------------------------

### Service Start Date Example

Source: https://docs.veryfi.com/api/receipts-invoices/create-a-line-item

Example of a service start date in ISO 8601 format.

```json
"2022-05-03"
```

--------------------------------

### Install Pods

Source: https://docs.veryfi.com/lens/mobile/any-docs/installation

Execute the installation command in the project root directory.

```bash
pod install  

```

--------------------------------

### Initialize Setup in OnAppearing

Source: https://docs.veryfi.com/lens/mobile/barcodes/initialization

Ensure setup is triggered only once during the page lifecycle by checking the _setupStarted flag.

```csharp
bool _configured;  
bool _setupStarted;  
  
protected override void OnAppearing()  
{  
    base.OnAppearing();  
    if (_setupStarted)  
    {  
        return;  
    }  
  
    _setupStarted = true;  
    SetupVeryfiLens();  
}  
```

--------------------------------

### Install project dependencies

Source: https://docs.veryfi.com/lens/mobile/any-docs/installation

Installs all dependencies defined in the project configuration.

```bash
npm install  
```

--------------------------------

### Full Implementation Example

Source: https://docs.veryfi.com/lens/mobile/barcodes/initialization

A complete example showing the integration of credentials, settings, and delegate listeners within an Android Activity.

```csharp
namespace LensAndroidTest;  
using Com.Veryfi.Lens;  
using Com.Veryfi.Lens.Helpers;  
using Org.Json;  
  
[Activity(Label = "@string/app_name", MainLauncher = true)]  
  
  
public class MainActivity : Activity  
{  
  
    protected override void OnCreate(Bundle? savedInstanceState)  
    {  
        base.OnCreate(savedInstanceState);  
        // Set our view from the "main" layout resource  
        SetContentView(Resource.Layout.activity_main);  
  
        const String CLIENT_ID = "XXX"; // replace XXX with your assigned Client Id  
        const String USERNAME = "XXX";  // replace XXX with your assigned Username  
        const String API_KEY = "XXX";   // replace XXX with your assigned API Key  
        const String URL = "XXX";       // replace XXX with your assigned Endpoint URL e.g. api.veryfi.com  
  
        var veryfiLensCredentials = new VeryfiLensCredentials  
        {  
            ClientId = CLIENT_ID,  
            Username = USERNAME,  
            ApiKey = API_KEY,  
            Url = URL  
        };  
  
        VeryfiLensSettings veryfiLensSettings = new VeryfiLensSettings  
        {  
            AutoLightDetectionIsOn = false,  
            BlurDetectionIsOn = true,  
            DocumentTypes = new List<DocumentType> { DocumentType.Receipt },  
            ShowDocumentTypes = true  
        };  
  
  
        VeryfiLens.Configure(Application, veryfiLensCredentials, veryfiLensSettings);  
  
        VeryfiLens.SetDelegate(new VeryfiLensDelegateListener());  
  
        VeryfiLens.ShowCamera();  
  
    }  
  
    private class VeryfiLensDelegateListener : Java.Lang.Object, IVeryfiLensDelegate  
    {  
        public void VeryfiLensClose(JSONObject json)  
        {  
            Console.WriteLine(json.ToString());  
        }  
  
        public void VeryfiLensError(JSONObject json)  
        {  
            Console.WriteLine(json.ToString());  
        }  
  
        public void VeryfiLensSuccess(JSONObject json)  
        {  
            Console.WriteLine(json.ToString());  
        }  
  
        public void VeryfiLensUpdate(JSONObject json)  
        {  
            Console.WriteLine(json.ToString());  
        }  
    }  
} 
```

--------------------------------

### cURL Request Example

Source: https://docs.veryfi.com/api/settings/retrieve-client-keys-list

Example command to retrieve the client-keys list using cURL.

```bash
curl -L -X GET 'https://api.veryfi.com/api/v8/partner/client-keys' \
-H 'Accept: application/json' \
-H 'CLIENT-ID: <API_KEY_VALUE>' \
-H 'AUTHORIZATION: <API_KEY_VALUE>' \
-H 'X-VERYFI-REQUEST-SIGNATURE: <API_KEY_VALUE>' \
-H 'X-VERYFI-REQUEST-TIMESTAMP: <API_KEY_VALUE>'
```

--------------------------------

### Minimal Veryfi Lens Implementation

Source: https://docs.veryfi.com/lens/mobile/any-docs/initialization

A complete example showing the integration of Veryfi Lens within a ViewController, including delegate setup and configuration.

```csharp
using CoreFoundation;  
using VeryfiLensiOS;  
namespace iOSVeryfiTestApp;  
  
public partial class ViewController : UIViewController  
{  
    const string CLIENT_ID = "XXXX"; //Replace with your clientId  
    const string AUTH_USRNE = "XXXX"; //Replace with your username  
    const string AUTH_API_K = "XXXX"; //Replace with your apiKey  
    const string API_URL = "XXXX"; //Replace with your url  
  
    VeryfiLensDelegateListener _veryfiLensDelegate;  
  
    public ViewController() : base(nameof(ViewController), null)  
    {  
    }  
  
    public ViewController(IntPtr handle) : base(handle)  
    {  
    }  
  
    public override void ViewDidLoad()  
    {  
        base.ViewDidLoad();  
        this.ShowLogs("Configuring Lens");  
        SetUpVeryfiLens();  
        SetUpVeryfiLensDelegate();  
    }  
  
    partial void OpenLens(NSObject sender)  
    {  
        VeryfiLens.Shared.ShowCameraIn(this);  
    }  
  
    private void SetUpVeryfiLensDelegate()  
    {  
        _veryfiLensDelegate = new VeryfiLensDelegateListener(this);  
        VeryfiLens.Shared.Delegate = _veryfiLensDelegate;  
    }  
  
    private void SetUpVeryfiLens()  
    {  
        VeryfiLensSettings veryfiLensSettings = new VeryfiLensSettings  
        {  
          AutoLightDetectionIsOn = false,  
          BlurDetectionIsOn = true,  
          DocumentTypes = new List<DocumentType> { DocumentType.Receipt },  
          ShowDocumentTypes = true  
        };  
        var veryfiLensCredentials = new VeryfiLensCredentials(CLIENT_ID, AUTH_USRNE, AUTH_API_K, API_URL);  
        Action<bool> completion = (success) =>  
        {  
            if (success)  
            {  
                DispatchQueue.MainQueue.DispatchAsync(() =>  
                {  
                    this.ShowLogs("Lens configured");  
                });  
            }  
        };  
  
        VeryfiLens.Shared.ConfigureWith(veryfiLensCredentials, veryfiLensSettings, completion);  
    }  
  
    private void ShowLogs(string log)  
    {  
        var text = Logs.Text + log + "\n";  
        Logs.Text = text;  
    }  
  
    private class VeryfiLensDelegateListener : VeryfiLensDelegate  
    {  
        private ViewController viewController;  
  
        public VeryfiLensDelegateListener(ViewController viewController)  
        {  
            this.viewController = viewController;  
        }  
  
        public override void VeryfiLensClose(NSDictionary<NSString, NSObject> json)  
        {  
            viewController.ShowLogs(json.ToString());  
        }  
  
        public override void VeryfiLensError(NSDictionary<NSString, NSObject> json)  
        {  
            viewController.ShowLogs(json.ToString());  
        }  
  
        public override void VeryfiLensSuccess(NSDictionary<NSString, NSObject> json)  
        {  
            viewController.ShowLogs(json.ToString());  
        }  
  
        public override void VeryfiLensUpdate(NSDictionary<NSString, NSObject> json)  
        {  
            viewController.ShowLogs(json.ToString());  
        }  
    }  
}  
```

--------------------------------

### Install Veryfi Lens SDK

Source: https://docs.veryfi.com/lens/browser-v3/getting-started/setup

Command to install the required npm package.

```bash
npm install veryfi-lens-wasm@latest
```

--------------------------------

### Install project dependencies via yarn

Source: https://docs.veryfi.com/lens/mobile/any-docs/installation

Installs all dependencies using yarn.

```bash
yarn install  
```

--------------------------------

### Install iOS Dependencies

Source: https://docs.veryfi.com/lens/mobile/introduction/setup

Execute this command in the iOS App folder to install the configured pods.

```bash
pod install --repo-update
```

--------------------------------

### Install Veryfi Lens SDK

Source: https://docs.veryfi.com/lens/browser-v3/getting-started/quick-start/prescription_label_guide

Install the latest version of the Veryfi Lens WASM SDK.

```bash
npm install veryfi-lens-wasm@latest  
```

--------------------------------

### Product Description Example

Source: https://docs.veryfi.com/api/receipts-invoices/create-a-line-item

Example value for a product or service description field.

```json
"GNGR CRT SOUP"
```

--------------------------------

### cURL Request Example

Source: https://docs.veryfi.com/api/get-business-card-tags

Example command to fetch business card tags using cURL.

```bash
curl -L -X GET 'https://api.veryfi.com/api/v8/partner/business-cards/:document_id/tags' \
-H 'Accept: application/json' \
-H 'CLIENT-ID: <API_KEY_VALUE>' \
-H 'AUTHORIZATION: <API_KEY_VALUE>'
```

--------------------------------

### Example Field Values

Source: https://docs.veryfi.com/api/receipts-invoices/create-a-line-item

Sample values for grouping and SKU fields.

```json
"Deli"
```

```json
"038902058959"
```

--------------------------------

### Start development server

Source: https://docs.veryfi.com/lens/browser-v3/getting-started/quick-start/general

Execute the command to run the local development server.

```bash
npm run dev  
```

--------------------------------

### Get webhooks request

Source: https://docs.veryfi.com/api/settings/get-webhooks

Example curl command to retrieve the list of webhooks.

```bash
curl -X GET 'https://{environment_url}/api/v8/partner/settings/webhooks' \
  -H 'Accept: application/json'
```

--------------------------------

### Get Blueprints via cURL

Source: https://docs.veryfi.com/api/get-blueprints

Example request to retrieve blueprints using the cURL command-line tool.

```bash
curl -L -X GET 'https://api.veryfi.com/api/v8/partner/blueprints' \
-H 'Accept: application/json' \
-H 'CLIENT-ID: <API_KEY_VALUE>' \
-H 'AUTHORIZATION: <API_KEY_VALUE>'
```

--------------------------------

### Get a Line Item cURL Request

Source: https://docs.veryfi.com/api/receipts-invoices/get-a-line-item

Example cURL command to retrieve a specific line item from a document.

```bash
curl -L -X GET 'https://api.veryfi.com/api/v8/partner/documents/:document_id/line-items/:line_item_id' \
-H 'Accept: application/json' \
-H 'CLIENT-ID;' \
-H 'AUTHORIZATION: apikey USERNAME:API_KEY'
```

--------------------------------

### API Request via cURL

Source: https://docs.veryfi.com/api/receipts-invoices/get-documents-from-pdf

Example command to retrieve document set details using the GET method.

```bash
curl -L -X GET 'https://api.veryfi.com/api/v8/partner/documents-set/:document_id' \
-H 'Accept: application/json' \
-H 'CLIENT-ID: <API_KEY_VALUE>' \
-H 'AUTHORIZATION: <API_KEY_VALUE>'
```

--------------------------------

### Create a new project

Source: https://docs.veryfi.com/lens/browser-v3/getting-started/setup

Commands to initialize a new project using Next.js or Vite.

```bash
npx create-next-app@latest
```

```bash
npm create vite@latest
```

--------------------------------

### Get W-9 Tags cURL Request

Source: https://docs.veryfi.com/api/get-w-9-tags

Example cURL command to retrieve tags for a specific W-9 document.

```bash
curl -L -X GET 'https://api.veryfi.com/api/v8/partner/w9s/:document_id/tags' \
-H 'Accept: application/json' \
-H 'CLIENT-ID;' \
-H 'AUTHORIZATION: apikey USERNAME:API_KEY'
```

--------------------------------

### Get Document Line Items Request

Source: https://docs.veryfi.com/api/receipts-invoices/get-document-line-items

Example cURL command to retrieve line items for a specific document ID.

```bash
curl -L -X GET 'https://api.veryfi.com/api/v8/partner/documents/:document_id/line-items' \
-H 'Accept: application/json' \
-H 'CLIENT-ID;' \
-H 'AUTHORIZATION: apikey USERNAME:API_KEY'
```

--------------------------------

### Install Capacitor Native Platforms

Source: https://docs.veryfi.com/lens/mobile/any-docs/installation

Initialize the required native platforms for a Capacitor project.

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

--------------------------------

### Initialize the SDK

Source: https://docs.veryfi.com/lens/mobile/checks/integration_guide

Configure the SDK with the application instance, credentials, and settings.

```kotlin
VeryfiLens.configure(application, credentials, settings) { }
```

--------------------------------

### Run Development Server

Source: https://docs.veryfi.com/lens/browser-v3/getting-started/quick-start/prescription_label_guide

Command to start the local development environment.

```bash
npm run dev
```

--------------------------------

### Initialize Project with Vite

Source: https://docs.veryfi.com/lens/browser-v3/getting-started/quick-start/prescription_label_guide

Commands to create a new Vite project using the vanilla template in the current or a new directory.

```bash
npm create vite@latest . -- --template vanilla  
```

```bash
npm create vite@latest prescription-label-app -- --template vanilla  
cd prescription-label-app  
```

--------------------------------

### Initialize SDK Configuration

Source: https://docs.veryfi.com/lens/mobile/checks/integration_guide

Apply the credentials and settings to the shared SDK instance.

```swift
VeryfiLens.shared().delegate = self  
VeryfiLens.shared().configure(  
    with: veryfiLensCredentials,  
    settings: veryfiLensSettings  
) { success in  
    if success {  
        // SDK configured successfully  
        print("Veryfi Lens configured successfully")  
    } else {  
        // Handle configuration failure  
        print("Veryfi Lens configuration failed")  
    }  
}  
```

--------------------------------

### Example Podfile Configuration

Source: https://docs.veryfi.com/lens/mobile/headless/credit_cards/installation

A minimal complete Podfile configuration for integrating the Veryfi Lens SDK.

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

```

--------------------------------

### Local Development Setup

Source: https://docs.veryfi.com/lens/browser-v3/getting-started/quick-start/qr_capture_guide

Commands and configuration for exposing local webhook endpoints.

```bash
ngrok http 3000
```

```text
https://a1b2c3d4.ngrok-free.app/api/webhook
```

--------------------------------

### OnClose Payload Example

Source: https://docs.veryfi.com/lens/mobile/any-docs/communication

Example of the dictionary payload received in the OnClose callback.

```json
{
  "status": "close",
  "queue_count": 1,
  "session_scan_count": 1,
  "framework-version": "1.4.0",
  "framework-build": "1"
}
```

--------------------------------

### Tax Code Example

Source: https://docs.veryfi.com/api/receipts-invoices/create-a-line-item

Example of a tax classification string for a line item.

```json
"A"
```

--------------------------------

### Initialize Vanilla JS Project

Source: https://docs.veryfi.com/lens/browser-v3/getting-started/quick-start/general

Commands to scaffold a new project using Vite with a vanilla template.

```bash
npm create vite@latest . -- --template vanilla  
```

```bash
npm create vite@latest lfb-test-app -- --template vanilla  
cd lfb-test-app  
```

--------------------------------

### Create Next.js Project

Source: https://docs.veryfi.com/lens/browser-v3/getting-started/quick-start/checks_guide

Commands to initialize a new Next.js project.

```bash
npx create-next-app@latest .
```

```bash
npx create-next-app@latest check-scanner-app  
cd check-scanner-app
```

--------------------------------

### cURL Request Example

Source: https://docs.veryfi.com/api/get-tls-certificates

Example cURL command to retrieve TLS certificates.

```bash
curl -L -X GET 'https://api.veryfi.com/api/v8/partner/settings/tls-certificate' \
-H 'Accept: application/json' \
-H 'CLIENT-ID: <API_KEY_VALUE>' \
-H 'AUTHORIZATION: <API_KEY_VALUE>'
```

--------------------------------

### Create Next.js Project

Source: https://docs.veryfi.com/lens/browser-v3/getting-started/quick-start/anydocs_guide

Commands to initialize a new Next.js project.

```bash
npx create-next-app@latest .
```

```bash
npx create-next-app@latest anydoc-scanner-app  
cd anydoc-scanner-app
```

--------------------------------

### Build Project and Fetch Dependencies

Source: https://docs.veryfi.com/lens/mobile/introduction/setup

Run these commands in the project root to build and navigate to the iOS App directory.

```bash
npm run build
```

```bash
cd ./ios/App
```

--------------------------------

### cURL Request Example

Source: https://docs.veryfi.com/api/anydocs/add-a-tag-to-a-A-doc

Example command to add a tag using cURL.

```bash
curl -L -X PUT 'https://api.veryfi.com/api/v8/partner/any-documents/:document_id/tags' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'CLIENT-ID;' \
-H 'AUTHORIZATION: apikey USERNAME:API_KEY' \
--data-raw '{
  "name": "string"
}'
```

--------------------------------

### CURL Request Example

Source: https://docs.veryfi.com/api/anydocs/get-A-doc-tags

Example command to retrieve tags using cURL.

```bash
curl -L -X GET 'https://api.veryfi.com/api/v8/partner/any-documents/:document_id/tags' \
-H 'Accept: application/json' \
-H 'CLIENT-ID: <API_KEY_VALUE>' \
-H 'AUTHORIZATION: <API_KEY_VALUE>'
```

--------------------------------

### Create Next.js Project

Source: https://docs.veryfi.com/lens/browser-v3/getting-started/quick-start/general

Commands to initialize a new Next.js application.

```bash
npx create-next-app@latest .
```

```bash
npx create-next-app@latest lfb-test-app  
cd lfb-test-app
```

--------------------------------

### Minimal Podfile Example

Source: https://docs.veryfi.com/lens/mobile/any-docs/installation

A basic configuration template for a project using the VeryfiLens pod.

```ruby
source 'https://repo.veryfi.com/shared/lens/veryfi-lens-podspec.git'  
source 'https://github.com/CocoaPods/Specs.git'  
  
target 'MyTarget' do  
  pod 'VeryfiLens'  
end  

```

--------------------------------

### Line Items Schema Example

Source: https://docs.veryfi.com/api/receipts-invoices/get-document-line-items

Example structure of the line_items object returned by the API.

```json
{
  "line_items": [
    {
      "id": 0,
      "order": 0,
      "text": "string",
      "type": "room",
      "product_info": {},
      "description": "string",
      "country_of_origin": "RO",
      "custom_fields": {},
      "product_details": []
    }
  ]
}
```

--------------------------------

### Project Directory Structure

Source: https://docs.veryfi.com/lens/browser-v3/getting-started/quick-start/general

Overview of the expected file layout after project setup.

```text
/your-project  
├── node_modules/  
│   └──veryfi-lens-wasm/  # Installed sdk files  
├── src/  
│   ├── main.js  
│   ├── style.css  
│   └── components/     # Optional: for organized code  
├── index.html  
├── package.json  
└── .env                # CLIENT_ID (add to .gitignore)
```

--------------------------------

### VeryfiLens.configure

Source: https://docs.veryfi.com/lens/mobile/checks/integration_guide

Initializes the SDK with provided credentials and settings.

```APIDOC
## VeryfiLens.configure

### Description
Configures the Veryfi Lens SDK instance with the required authentication credentials and operational settings.

### Method
`VeryfiLens.shared().configure(with:settings:completion:)`

### Parameters
- **with** (VeryfiLensCredentials) - Required - The credentials object containing clientId, username, apiKey, and url.
- **settings** (VeryfiLensSettings) - Required - The configuration settings for document types and behavior.
- **completion** (Closure) - Required - A callback block returning a boolean indicating success or failure.
```

--------------------------------

### CURL Request Example

Source: https://docs.veryfi.com/api/get-w-2-tags

Example command to retrieve W-2 tags using cURL.

```bash
curl -L -X GET 'https://api.veryfi.com/api/v8/partner/w2s/:document_id/tags' \
-H 'Accept: application/json' \
-H 'CLIENT-ID: <API_KEY_VALUE>' \
-H 'AUTHORIZATION: <API_KEY_VALUE>'
```

--------------------------------

### CURL Request Example

Source: https://docs.veryfi.com/api/get-contract-tags

Example command to retrieve contract tags using cURL.

```bash
curl -L -X GET 'https://api.veryfi.com/api/v8/partner/contracts/:document_id/tags' \
-H 'Accept: application/json' \
-H 'CLIENT-ID: <API_KEY_VALUE>' \
-H 'AUTHORIZATION: <API_KEY_VALUE>'
```

--------------------------------

### Response Schema Examples

Source: https://docs.veryfi.com/api/add-tags-to-a-w-9

Examples of successful and error response bodies returned by the API.

```json
{
  "tags": [
    {
      "id": 0,
      "name": "string"
    }
  ]
}
```

```json
{}
```

```json
{
  "status": "fail",
  "error": "string"
}
```

--------------------------------

### Initialize and Launch Veryfi Lens

Source: https://docs.veryfi.com/lens/mobile/introduction/quick_start

Import required classes, configure credentials and settings, and launch the camera interface.

```kotlin
import com.veryfi.lens.VeryfiLens
     import com.veryfi.lens.VeryfiLensDelegate
     import com.veryfi.lens.helpers.DocumentType
     import com.veryfi.lens.helpers.VeryfiLensCredentials
     import com.veryfi.lens.helpers.VeryfiLensSettings

     val credentials = VeryfiLensCredentials().apply {
         clientId = "CLIENT_ID"
         username = "USERNAME"
         apiKey = "API_KEY"
         url = "URL"
     }

     val settings = VeryfiLensSettings().apply {
         autoRotateIsOn = true
         autoSubmitDocumentOnCapture = true
         documentTypes = arrayListOf(DocumentType.RECEIPT)
         galleryIsOn = false
         moreMenuIsOn = false
     }

     VeryfiLens.setDelegate(this)
     VeryfiLens.configure(application, credentials, settings) { }
     VeryfiLens.showCamera()
```

--------------------------------

### Install Expo Font Library

Source: https://docs.veryfi.com/lens/mobile/settings

Installs the necessary dependency for managing fonts in an Expo project.

```bash
npx expo install expo-font  
```

--------------------------------

### Veryfi Lens Delegate Setup

Source: https://docs.veryfi.com/lens/mobile/any-docs/communication

Kotlin implementation for setting up the VeryfiLens delegate.

```kotlin
VeryfiLens.setDelegate(object : VeryfiLensDelegate {
    override fun veryfiLensClose(json: JSONObject) {
        Log.d(TAG, json.toString(2)) // do something with the JSON response here
    }
  
    override fun veryfiLensError(json: JSONObject) {
        Log.d(TAG, json.toString(2)) // do something with the JSON response here
    }
  
    override fun veryfiLensSuccess(json: JSONObject) {
        Log.d(TAG, json.toString(2)) // do something with the JSON response here
    }
  
    override fun veryfiLensUpdate(json: JSONObject) {
        Log.d(TAG, json.toString(2)) // do something with the JSON response here
    }
})
```

--------------------------------

### Initialize Lens SDK

Source: https://docs.veryfi.com/lens/mobile/any-docs/initialization

Call Configure with credentials and settings, ensuring success before interacting with the Lens UI.

```csharp
VeryfiLensBinding.Configure(credentials, settings, success =>  
{  
    _configured = success;  
    OpenCameraBtn.IsEnabled = success;  
    OpenGalleryBtn.IsEnabled = success;  
    OpenBrowserBtn.IsEnabled = success;  
  
    if (!success)  
    {  
        return;  
    }  
  
    try  
    {  
        VeryfiLensBinding.ObserveAnalyticsEvents();  
    }  
    catch (Exception ex)  
    {  
        // Handle analytics setup failure if needed  
    }  
});  
```

--------------------------------

### Install CocoaPods Dependencies

Source: https://docs.veryfi.com/lens/mobile/checks/integration_guide

Run these commands in your terminal to update the repo and install the specified pods.

```bash
pod repo update  
pod install  

```

--------------------------------

### Install Static Linkage Plugin

Source: https://docs.veryfi.com/lens/mobile/any-docs/installation

Install the cocoapods-pod-linkage plugin for projects requiring static linkage.

```bash
gem install "cocoapods-pod-linkage"  

```

--------------------------------

### Launch Camera Interface

Source: https://docs.veryfi.com/lens/mobile/checks/integration_guide

Present the camera view controller to start the scanning process.

```swift
VeryfiLens.shared().showCamera(in: self)  
```

--------------------------------

### Initialize Lens in OnAppearing

Source: https://docs.veryfi.com/lens/mobile/any-docs/initialization

Ensures the SDK is configured once when the page appears.

```csharp
bool _configured;  
bool _setupStarted;  
  
protected override void OnAppearing()  
{  
    base.OnAppearing();  
    if (_setupStarted)  
    {  
        return;  
    }  
  
    _setupStarted = true;  
    SetupVeryfiLens();  
}
```

--------------------------------

### Exception Payload Example

Source: https://docs.veryfi.com/lens/mobile/any-docs/communication

Example of a JSON error payload returned by the SDK when an exception occurs.

```json
{
    "status": "error",
    "package_id": "edc8653e4c2b4ef1",
    "exception": "java.lang.IllegalArgumentException: Cannot create enum from value!\n\tat com.amazonaws.regions.Regions.fromName(Regions.java:126)\n\tat com.veryfi.lens.helpers.RegionHelper.getRegion(RegionHelper.kt:28)\n\tat com.veryfi.lens.service.UploadDocumentsService.setAccelerateModeEnable(UploadDocumentsService.kt:94)\n\tat com.veryfi.lens.service.UploadDocumentsService.onUploadType(UploadDocumentsService.kt:186)\n\tat com.veryfi.lens.service.UploadDocumentsService.onStartCommand(UploadDocumentsService.kt:161)\n\tat android.app.ActivityThread.handleServiceArgs(ActivityThread.java:4236)\n\tat android.app.ActivityThread.access$1800(ActivityThread.java:231)\n\tat android.app.ActivityThread$H.handleMessage(ActivityThread.java:1925)\n\tat android.os.Handler.dispatchMessage(Handler.java:106)\n\tat android.os.Looper.loop(Looper.java:223)\n\tat android.app.ActivityThread.main(ActivityThread.java:7478)\n\tat java.lang.reflect.Method.invoke(Native Method)\n\tat com.android.internal.os.RuntimeInit$MethodAndArgsCaller.run(RuntimeInit.java:549)\n\tat com.android.internal.os.ZygoteInit.main(ZygoteInit.java:941)\n"
}
```

--------------------------------

### Start Camera Scanning

Source: https://docs.veryfi.com/lens/browser-v3/getting-started/Initialization

Launch the camera interface to begin scanning, optionally providing a callback to handle the captured base64 image.

```javascript
// Basic camera start  
VeryfiLens.showCamera();  
```

```javascript
// With image setter callback  
VeryfiLens.showCamera((image) => {  
    console.log("Captured image:", image);  
    // image is base64 encoded  
});  
```

--------------------------------

### Get Business Cards Endpoint

Source: https://docs.veryfi.com/api/business-cards/get-business-cards

The base URL for the GET request to retrieve business cards.

```http
GET 
## https://api.veryfi.com/api/v8/partner/business-cards
```

--------------------------------

### Configure and Launch Lens

Source: https://docs.veryfi.com/lens/mobile/introduction/usage

Initializes the SDK with credentials and settings, ensuring the camera launches only after configuration completes.

```javascript
VeryfiLens.configureWithCredentials(
    veryfiLensCredentials,
    veryfiLensSettings,
    () => {
        VeryfiLens.showCamera();
    },
);
```

--------------------------------

### View project structure

Source: https://docs.veryfi.com/lens/browser-v3/getting-started/quick-start/general

The expected directory layout for the initialized project.

```text
  
/your-project  
├── app/  
│ ├── page.tsx  
│ ├── layout.tsx  
│ └── globals.css  
├── .env.local  
└── package.json  
  
```

--------------------------------

### Initialize Veryfi Lens SDK

Source: https://docs.veryfi.com/lens/mobile/any-docs/initialization

Configure the SDK with credentials and settings, providing a completion callback to handle the initialization result.

```csharp
Action<bool> completion = (success) => {  
    if (success) {  
        DispatchQueue.MainQueue.DispatchAsync(() => {  
            // Start using Lens  
            // ex.  VeryfiLens.Shared.ShowCameraIn(this);  
        });  
    }  
};  
  
VeryfiLens.Shared.ConfigureWith(veryfiLensCredentials, veryfiLensSettings, completion);
```

--------------------------------

### Create Tax Line Request Example

Source: https://docs.veryfi.com/api/create-a-tax-line

Example request for creating a tax line using cURL.

```bash
curl -L -X POST 'https://api.veryfi.com/api/v8/partner/documents/:document_id/tax-lines' \
-H 'Content-Type: application/json' \
-H 'CLIENT-ID;' \
-H 'AUTHORIZATION: apikey USERNAME:API_KEY' \
--data-raw '{
  "base": 0,
  "name": "string",
  "rate": 0,
  "total": 0,
  "code": "string",
  "total_inclusive": 0,
  "order": 0
}'
```
Tokens:
Raw