{"id":22400083,"url":"https://github.com/regulaforensics/documentreader-web-js-client","last_synced_at":"2026-01-12T02:26:54.287Z","repository":{"id":40687264,"uuid":"279250721","full_name":"regulaforensics/DocumentReader-web-js-client","owner":"regulaforensics","description":"Regula Document Reader web API js client for the browser and node.js based on axios","archived":false,"fork":false,"pushed_at":"2025-07-24T17:48:03.000Z","size":6660,"stargazers_count":12,"open_issues_count":1,"forks_count":6,"subscribers_count":5,"default_branch":"develop","last_synced_at":"2025-07-27T22:20:50.983Z","etag":null,"topics":["barcode-reader","document-reader","document-recognition","idcard","mrz","mrz-codes","ocr","passport","regula","regulaforensics"],"latest_commit_sha":null,"homepage":"https://regulaforensics.com","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/regulaforensics.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2020-07-13T09:01:26.000Z","updated_at":"2025-07-24T07:18:03.000Z","dependencies_parsed_at":"2023-01-25T21:01:53.504Z","dependency_job_id":"33be7fec-4622-4813-a5c6-bbc5d38f045b","html_url":"https://github.com/regulaforensics/DocumentReader-web-js-client","commit_stats":{"total_commits":199,"total_committers":22,"mean_commits":9.045454545454545,"dds":0.778894472361809,"last_synced_commit":"c898a30566172e922b4f49fb40a09a548e514dec"},"previous_names":["regulaforensics/documentreader-api-js-client"],"tags_count":91,"template":false,"template_full_name":null,"purl":"pkg:github/regulaforensics/DocumentReader-web-js-client","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/regulaforensics%2FDocumentReader-web-js-client","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/regulaforensics%2FDocumentReader-web-js-client/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/regulaforensics%2FDocumentReader-web-js-client/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/regulaforensics%2FDocumentReader-web-js-client/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/regulaforensics","download_url":"https://codeload.github.com/regulaforensics/DocumentReader-web-js-client/tar.gz/refs/heads/develop","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/regulaforensics%2FDocumentReader-web-js-client/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":268057170,"owners_count":24188616,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-07-31T02:00:08.723Z","response_time":66,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["barcode-reader","document-reader","document-recognition","idcard","mrz","mrz-codes","ocr","passport","regula","regulaforensics"],"created_at":"2024-12-05T08:11:14.320Z","updated_at":"2025-12-30T10:53:05.149Z","avatar_url":"https://github.com/regulaforensics.png","language":"TypeScript","readme":"# Regula Document Reader js client for the browser and node.js based on axios\n\n[![npm version](https://img.shields.io/npm/v/@regulaforensics/document-reader-webclient?color=yellow\u0026style=flat-square)](https://www.npmjs.org/package/@regulaforensics/document-reader-webclient)\n![npm type definitions](https://img.shields.io/npm/types/typescript?style=flat-square\u0026collor=858df6)\n[![documentation](https://img.shields.io/badge/docs-en-f6858d?style=flat-square)](https://support.regulaforensics.com/hc/en-us/articles/115000916306-Documentation)\n[![OpenAPI](https://img.shields.io/badge/OpenAPI-defs-8c0a56?style=flat-square)](https://github.com/regulaforensics/DocumentReader-web-openapi)\n[![live](https://img.shields.io/badge/live-demo-0a8c42?style=flat-square)](https://api.regulaforensics.com/)\n\nDocuments recognition as easy as reading two bytes.\n\nIf you have any problems with or questions about this client, please contact us\nthrough a [GitHub issue](https://github.com/regulaforensics/DocumentReader-api-js-client/issues).\nYou are invited to contribute new features, fixes, or updates, large or small.\nWe are always thrilled to receive pull requests, and do our best to process them as fast as we can.\nSee [dev guide](https://github.com/regulaforensics/DocumentReader-web-js-client/blob/master/dev.md)\n\n## Install package\n\n```\nnpm install @regulaforensics/document-reader-webclient\n```\n## Basic Example\n\nPerforming request:\n```js\nimport { DocumentReaderApi, Scenario, TextFieldType, GraphicFieldType } from '@regulaforensics/document-reader-webclient';\nconst { DOCUMENT_NUMBER, SURNAME_AND_GIVEN_NAMES, DATE_OF_BIRTH } = TextFieldType;\nconst { PORTRAIT, SIGNATURE } = GraphicFieldType;\n\nconst imageAsBase64String = getDocImageAsBase64String();\nconst api = new DocumentReaderApi({ basePath: 'http://localhost:8080' });\nconst result = await api.process({ images: [documentImage], processParam: { scenario: Scenario.FULL_PROCESS} });\n```\n\nParsing results:\n```js\n// text fields\nconst docNumber = result.text?.getField(DOCUMENT_NUMBER);\nconst fullName = result.text?.getField(SURNAME_AND_GIVEN_NAMES);\nconst dateOfBirth = result.text?.getField(DATE_OF_BIRTH);\n\n// graphics fields\nconst portraitAsBase64 = result.images?.getField(PORTRAIT);\nconst signatureAsBase64 = result.images?.getField(SIGNATURE);\n```\n\n\n## Compatibility\n\nLanguage level\n* ES5 with some ES6 features [Promise] and whatwg **URL**. If your environment doesn't support ES6 required features, you can polyfill.\n* nodejs 18+\n\nModule system\n* CommonJS\n* ES6 module system\n\nDefinitions\n* TypeScript's definitions should be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/publishing.html#including-declarations-in-your-npm-package))\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fregulaforensics%2Fdocumentreader-web-js-client","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fregulaforensics%2Fdocumentreader-web-js-client","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fregulaforensics%2Fdocumentreader-web-js-client/lists"}