StructOCR Node.js SDK

Install the SDK

Install or upgrade the official structocr package from npm.

npm install structocr

Passport OCR quickstart

Store the API key in STRUCTOCR_API_KEY, keep it on the server, and pass a supported local file to the SDK.

const StructOCR = require("structocr");

const apiKey = process.env.STRUCTOCR_API_KEY;
if (!apiKey) throw new Error("STRUCTOCR_API_KEY is not configured");

const client = new StructOCR(apiKey);

async function main() {
  const result = await client.scanPassport("./passport.jpg");

  if (result.success) {
    const passport = result.data;
    console.log(passport.passport_number);
    console.log(passport.given_names, passport.surname);
  } else {
    console.error(result.error);
  }
}

main().catch(console.error);

For the complete request and response schema, see the Passport OCR API reference.

The SDK converts paths or in-memory data to Base64 locally. The REST API itself accepts JSON with an img Base64 string, not file paths, binary bodies, URLs, or multipart uploads.

Supported OCR methods

Package registries are the source of truth for the latest published version and release notes.