https://github.com/havendv/veryfi-csharp
This is the official C# client library for communicating with the Veryfi OCR API.
https://github.com/havendv/veryfi-csharp
api csharp invoice ocr receipt sdk-csharp veryfi veryfi-api
Last synced: 6 months ago
JSON representation
This is the official C# client library for communicating with the Veryfi OCR API.
- Host: GitHub
- URL: https://github.com/havendv/veryfi-csharp
- Owner: HavenDV
- License: mit
- Created: 2021-08-04T21:20:43.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2021-08-12T23:54:23.000Z (about 4 years ago)
- Last Synced: 2025-03-19T20:07:10.521Z (7 months ago)
- Topics: api, csharp, invoice, ocr, receipt, sdk-csharp, veryfi, veryfi-api
- Language: C#
- Homepage: https://www.veryfi.com
- Size: 1.07 MB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Veryfi C# Client Library
[](https://github.com/HavenDV/veryfi-csharp/search?l=C%23&o=desc&s=&type=Code)
[](LICENSE)
[](https://github.com/dotnet/standard/blob/master/docs/versions/netstandard2.0.md)
[](https://github.com/microsoft/dotnet/tree/master/releases/net45)
[](https://github.com/HavenDV/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/HavenDV/Veryfi/)
## Nuget
[](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);
// 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 support@veryfi.com.
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/