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

This is the official C# client library for communicating with the Veryfi OCR API. || read: https://veryfi.com/csharp
https://github.com/veryfi/veryfi-csharp

api csharp csharp-library csharp-sdk dotnet dotnet-core dotnetcore microsoft netstandard sdk

Last synced: about 1 month ago
JSON representation

This is the official C# client library for communicating with the Veryfi OCR API. || read: https://veryfi.com/csharp

• Host: GitHub
• URL: https://github.com/veryfi/veryfi-csharp
• Owner: veryfi
• License: mit
• Created: 2021-08-17T00:24:20.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2024-04-08T16:52:05.000Z (9 months ago)
• Last Synced: 2024-04-21T03:56:22.007Z (8 months ago)
• Topics: api, csharp, csharp-library, csharp-sdk, dotnet, dotnet-core, dotnetcore, microsoft, netstandard, sdk
• Language: C#
• Homepage:
• Size: 3.37 MB
• Stars: 9
• Watchers: 3
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Veryfi C# Client Library

[![Language](https://img.shields.io/badge/language-C%23-blue.svg?style=flat-square)](https://github.com/veryfi/veryfi-csharp/search?l=C%23&o=desc&s=&type=Code) 

[![License](https://img.shields.io/github/license/veryfi/veryfi-csharp.svg?label=License&maxAge=86400)](LICENSE) 

[![Requirements](https://img.shields.io/badge/Requirements-.NET%20Standard%202.0-blue.svg)](https://github.com/dotnet/standard/blob/master/docs/versions/netstandard2.0.md) 

[![Requirements](https://img.shields.io/badge/Requirements-.NET%20Framework%204.5-blue.svg)](https://github.com/microsoft/dotnet/tree/master/releases/net45) 

[![Build Status](https://github.com/veryfi/veryfi-csharp/workflows/.NET/badge.svg?branch=master)](https://github.com/veryfi/veryfi-csharp/actions/workflows/dotnet.yml)

**Veryfi** is a C# Client Library for communicating with the [Veryfi OCR API](https://veryfi.com/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/](https://hub.veryfi.com/signup/api/)

### Documentation

[OpenAPI 3 Specification](https://app.swaggerhub.com/apis/Veryfi/verify-api/)

## Nuget

[![NuGet](https://img.shields.io/nuget/dt/Veryfi.svg?style=flat-square&label=Veryfi)](https://www.nuget.org/packages/Veryfi/)

```

Install-Package Veryfi

```

## Usage

```cs

using Veryfi;

using var client = new HttpClient();

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

// Get Documents

var documentsResponse = await api.DocumentsAsync();

// Process Document URL.

var documentResponse = await api.Documents2Async(

    new DocumentPOSTJSONRequest

    {

        File_url = url

    });

// Process Document Base64

var documentResponse = await api.Documents2Async(

    new DocumentPOSTJSONRequest

    {

        File_name = file.FileName,

        File_data = Convert.ToBase64String(file.AsBytes())

    });

```

## 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/