README.md

Veryfi C# Client Library

Veryfi is a C# Client Library for communicating with the Veryfi OCR API

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/

Documentation

OpenAPI 3 Specification

Nuget

Install-Package Veryfi

Usage

using Veryfi;

using var client = new HttpClient();
var api = new VeryfiApi("username", "apiKey", "clientId", client);

// Process Base64
var document = await api.ProcessDocumentAsync(
    new DocumentUploadOptions
    {
        File_name = "fileName.jpg",
        File_data = Convert.ToBase64String(bytes),
    });

// Process url
var document = await api.ProcessDocumentAsync(
    new DocumentUploadOptions
    {
        File_url = "https://raw.githubusercontent.com/HavenDV/veryfi-csharp/master/src/tests/Veryfi.IntegrationTests/Assets/receipt_public.jpg",
    });

// Process urls
var document = await api.ProcessDocumentAsync(
    new DocumentUploadOptions
    {
        File_urls = new [] {
            "https://raw.githubusercontent.com/HavenDV/veryfi-csharp/master/src/tests/Veryfi.IntegrationTests/Assets/receipt_public.jpg",
        },
    });

// Process stream
var document = await api.ProcessDocumentFileAsync(
    new Stream(),
    new DocumentUploadOptions
    {
        File_name = "fileName.jpg",
    });

// Process bytes
var document = await api.ProcessDocumentFileAsync(
    new byte[0],
    new DocumentUploadOptions
    {
        File_name = "fileName.jpg",
    });

// Process path
var document = await api.ProcessDocumentFileAsync(
    "C:/invoice.png",
    new DocumentUploadOptions
    {
        // any custom options, File_name is not required.
    });

//

Live Example

C# .NET Fiddle - https://dotnetfiddle.net/voU3yG
VB.NET .NET Fiddle - https://dotnetfiddle.net/4B8z6n

Developers

The code is generated using https://github.com/RicoSuter/NSwag
NuGet packages are released and versioned automatically. Any commit with the feat:/fix:/perf: prefix will release a new version of the package (according to https://www.conventionalcommits.org/en/v1.0.0/).

Need help?

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/