mindee

Mindee API Helper Library for Node.js

Quickly and easily connect to Mindee's API services using Node.js.

Quick Start

Here's the TL;DR of getting started.

First, get an API Key

Then, install this library:

npm install mindee

Finally, Node.js away!

Loading a File and Parsing It

Global Documents

const mindee = require("mindee");
// for TS or modules:
// import * as mindee from "mindee";

// Init a new client
const mindeeClient = new mindee.Client({ apiKey: "my-api-key" });

// Load a file from disk and parse it
const apiResponse = mindeeClient
    .docFromPath("/path/to/the/file.ext")
    .parse(mindee.InvoiceV4);

Region-Specific Documents

const mindee = require("mindee");
// for TS or modules:
// import * as mindee from "mindee";

// Init a new client
const mindeeClient = new mindee.Client({ apiKey: "my-api-key" });

// Load a file from disk and parse it
const apiResponse = mindeeClient
    .docFromPath("/path/to/the/file.ext")
    .parse(mindee.fr.IdCardV1);

Custom Documents (API Builder)

const mindee = require("mindee");
// for TS or modules:
// import * as mindee from "mindee";

// Init a new client and add your document endpoint
const mindeeClient = new mindee.Client({ apiKey: "my-api-key" })
    .addEndpoint({
        accountName: "john",
        endpointName: "wsnine",
    });

// Load a file from disk and parse it
const apiResponse = mindeeClient
    .docFromPath("/path/to/the/file.ext")
    .parse(mindee.CustomV1, { endpointName: "wsnine" });

Handling the Return

// Handle the response Promise
apiResponse.then((resp) => {

    // The `document` property can be undefined:
    // * TypeScript will not compile without this guard clause
    //   (or consider using the '?' notation)
    // * JavaScript will be very happy to produce subtle bugs
    //   without this guard clause
    if (resp.document === undefined) return;

    // full object
    console.log(resp.document);

    // string summary
    console.log(resp.document.toString());
});

Further Reading

There's more to it than that for those that need more features, or want to customize the experience.

All the juicy details are described in the Official Guide.

License

Copyright © Mindee

Available as open source under the terms of the MIT License.

Changelog

v3.6.0 - 2023-02-01

Changes

• :sparkles: Add support for the mindee_vision API (for internal testing)
• :sparkles: support Proof of Address V1
• :sparkles: Add support for: financial document v1
• :arrow_up: update jsdoc

¡Warning!

The FinancialDocumentV1 class now uses an actual API call to the new route financial_document. Previously, determining whether a document is an invoice or a receipt was done internally by this library.

The API call way is much better, however some fields have been renamed compared to the internal handling. This was done so field names now match exactly Invoice and Receipt classes.

As such, we encourage users to migrate to the new field structure.

If this is problematic, it's possible to use the deprecated way. Simply pass FinancialDocumentV0 to the parse method. Usage is otherwise identical.