https://github.com/veryfi/veryfi-swift

Swift framework for communicating with the Veryfi OCR API
https://github.com/veryfi/veryfi-swift

invoice invoice-parser ios ios-swift mobile ocr ocr-library receipt receipt-capture sdk sdk-swift swift

Last synced: 2 months ago
JSON representation

Swift framework for communicating with the Veryfi OCR API

• Host: GitHub
• URL: https://github.com/veryfi/veryfi-swift
• Owner: veryfi
• Created: 2021-07-26T19:08:04.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2023-11-07T16:41:03.000Z (about 1 year ago)
• Last Synced: 2024-04-21T03:56:23.007Z (9 months ago)
• Topics: invoice, invoice-parser, ios, ios-swift, mobile, ocr, ocr-library, receipt, receipt-capture, sdk, sdk-swift, swift
• Language: Swift
• Homepage:
• Size: 2.56 MB
• Stars: 9
• Watchers: 6
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        





![Swift 5.3](https://img.shields.io/badge/Swift-5.3-orange.svg?style=flat)

[![code coverage](.github/metrics/code_coverage.svg)](.github/metrics/code_coverage.svg)

[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](https://opensource.org/licenses/MIT)

## Installation

Install from Swift Package Manager, using this repository as the url.

## Getting Started

### Obtaining Client ID and user keys

If you don't have an account with Veryfi, please go ahead and register here: [https://hub.veryfi.com/signup/api/](https://hub.veryfi.com/signup/api/).

### Veryfi Swift Client Library

The **veryfi** library can be used to communicate with Veryfi API. All available functionality is described [here](https://veryfi.github.io/veryfi-swift/documentation/veryfisdk/).

Below is the sample Swift code using **veryfi** to OCR and extract data from a document:

#### Process a document

```swift

import UIKit

import VeryfiSDK

class ViewController: UIViewController {

    

    let clientId = "your_client_id"

    let clientSecret = "your_client_secret"

    let username = "your_username"

    let apiKey = "your_password"

    

    override func viewDidLoad() {

        super.viewDidLoad()

        let client = Client(clientId: clientId, clientSecret: clientSecret, username: username, apiKey: apiKey)

        let file = "receipt"

        let url = Bundle(for: Self.self).url(forResource: file, withExtension: "jpeg")!

        let fileData = try? Data(contentsOf: url)

        client.processDocument(fileName: file, fileData: fileData!) { result in

            switch result {

            case .success(let data):

                print("Succeded")

            case .failure(let error):

                print("Error")

            }

        }

    }

}

```

#### Update a document

```swift

import UIKit

import VeryfiSDK

class ViewController: UIViewController {

    

    let clientId = "your_client_id"

    let clientSecret = "your_client_secret"

    let username = "your_username"

    let apiKey = "your_password"

    

    override func viewDidLoad() {

        super.viewDidLoad()

        let client = Client(clientId: clientId, clientSecret: clientSecret, username: username, apiKey: apiKey)

        let documentId = "your_document_id"

        var parameters = [String : Any]()

        parameters["category"] = "Meals & Entertainment"

        parameters["total"] =  11.23

        client.updateDocument(documentId: documentId, params: parameters) { result in

            switch result {

            case .success(let data):

                print("Succeded")

            case .failure(let error):

                print("Error")

            }

        }

    }

}

```

## Release

1. Create new branch for your code

2. Change version in `Constants.swift`

3. Commit changes and push to Github

4. Create PR pointing to master branch and add a Veryfi member as a reviewer

5. Tag your commit with the new version

6. The new version will be accesible through Swift Package Manager

## Need help?

Visit https://docs.veryfi.com/ to access integration guides and usage notes in the Veryfi API Documentation Portal

If you run into any issue or need help installing or using the library, please contact [email protected].

If you found a bug in this library or would like new features added, then open an issue or pull requests against this repo!

To learn more about Veryfi visit https://www.veryfi.com/