01 / Začíname
Rýchly štart
Vytvorte kľúč, nastavte dve premenné prostredia a odošlite prvú overenú požiadavku.
- Vytvorte účet pracovného priestoru a vyberte plán.
- Vytvorte API kľúč s najmenším rozsahom spracovania, ktorý služba potrebuje. Tajný údaj si skopírujte okamžite; neskôr sa už nezobrazí.
- Premenné SCANVERION_API_URL a SCANVERION_API_KEY nastavte iba v serverovom prostredí.
- Odošlite multipart požiadavku a uložte vrátené requestId spolu s vlastným identifikátorom trasovania.
curl --request POST "$SCANVERION_API_URL/api/v1/ai/document-processing" --header "Authorization: Bearer $SCANVERION_API_KEY" \
--header "Idempotency-Key: invoice-20260807-001" --form "File=@invoice.pdf;type=application/pdf" --form "Operations=Scanner" \
--form "Operations=Rotation" --form "ScannerFields=invoiceNumber" --form "ScannerFields=issueDate" --form "ScannerFields=dueDate" --form "ScannerFields=paymentReference" --form "ScannerFields=supplierIban" --form "ScannerFields=customerIban" --form "ScannerFields=supplierAddress" --form "ScannerFields=supplierStreetName" --form "ScannerFields=supplierStreetNumber" --form "ScannerFields=supplierPostalCode" --form "ScannerFields=supplierCity" --form "ScannerFields=customerAddress" --form "ScannerFields=supplierVatNumber" --form "ScannerFields=customerVatNumber" --form "ScannerFields=netTotal" --form "ScannerFields=vatTotal" --form "ScannerFields=vatBreakdown" --form "ScannerFields=lineItems" --form "ScannerFields=grossTotal"02 / Bezpečnosť
Autentifikácia a API kľúče
Bezpečne používajte strojové prihlasovacie údaje s rozsahmi z dôveryhodného backendu.
03 / Spoľahlivosť
Idempotencia a opakovanie
Každému pokusu o spracovanie priraďte stabilný kľúč a vedome riešte duplicity.
S každou požiadavkou na spracovanie odošlite Idempotency-Key. Rovnakú hodnotu použite iba pri opakovaní toho istého logického nahratia a rovnakých operácií. Duplicitná rezervácia vráti 409 Conflict; nový kľúč môže vytvoriť druhý účtovaný pokus.
04 / AI endpoint
Spracovanie dokumentov
Nahrajte JPEG, PNG, WebP alebo PDF na synchrónnu analýzu dokumentu.
Použite presné názvy multipart polí ASP.NET: jedno File, jedno alebo viac opakovaných Operations, voliteľné opakované ScannerFields, voliteľný JSON CheckboxDefinitions a voliteľné DisableObjectSegmentation.
Polia skenera podľa typu dokumentu
V opakovaných hodnotách ScannerFields používajte nižšie uvedené kanonické názvy polí. Porovnávanie nerozlišuje veľké a malé písmená, kanonický zápis však zachováva konzistentnosť integrácie. Každá kategória podporuje aj spoločné polia. Požadované pole môže byť null, ak OCR nemá dostatok podkladov.
| Typ dokumentu | Detegovaná kategória | Ďalšie ScannerFields |
|---|---|---|
| Každý dokument | * | rawTextdocumentType |
| Faktúra | invoice | invoiceNumberissueDatedueDatedeliveryDatepaymentReferencecurrencysupplierNamesupplierAddresssupplierStreetNamesupplierStreetNumbersupplierCitysupplierCityPartsupplierPostalCodesupplierCountryCodesupplierCompanyRegistrationNumbersupplierTaxNumbersupplierVatNumbersupplierIbansupplierBiccustomerNamecustomerAddresscustomerStreetNamecustomerStreetNumbercustomerCitycustomerCityPartcustomerPostalCodecustomerCountryCodecustomerCompanyRegistrationNumbercustomerTaxNumbercustomerVatNumbercustomerIbancustomerBicdeliveryNamedeliveryAddressdeliveryStreetNamedeliveryStreetNumberdeliveryCitydeliveryCityPartdeliveryPostalCodedeliveryCountryCodenetTotalvatTotalvatBreakdowngrossTotallineItemsbankAccounts |
| Cestovný pas | passport | documentNumberdateOfBirthsexnationalitynationalityNamepersonalNumberdateOfIssuedateOfExpiryissuedByplaceOfBirth |
| Občiansky preukaz EÚ, predná strana | euidfront | documentNumberdateOfBirthsexnationalitynationalityNamepersonalNumberdateOfIssuedateOfExpiryissuedByplaceOfBirth |
| Občiansky preukaz EÚ, zadná strana | euidback | addressstreetNamestreetNumbercitycityPartpostalCodecountryCodemaidenNameplaceOfBirthbloodTypepersonalNumbermaritalStatusissuedBydocumentNumbernationalitynationalityNamedateOfBirthsexdateOfExpiry |
| Vodičský preukaz EÚ, predná strana | eudriverlicensefront | dateOfBirthplaceOfBirthdateOfIssuedateOfExpiryissuedBydocumentNumberlicenseAllowedCategories |
| Osvedčenie o evidencii, časť I, predná strana | eutechnicallicensefront | vinlicensePlateaddressownerdocumentNumber |
| Osvedčenie o evidencii, časť I, zadná strana | eutechnicallicenseback | vinmanufacturervariantmodelvalidUntilvehicleCategoryengineVolumeenginePerformancefuelTypenumberOfSeatsmaximumSpeedlargestWeightKg |
| Osvedčenie o evidencii, časť II, predná strana | bigtechnicallicensefront | registrationCertificatePartdocumentNumberlicensePlatedateOfFirstRegistrationvinvehicleKindvehicleCategorymanufacturermodeltypeVariantVersionvehicleManufacturertypeApprovalNumbertypeApprovalDateengineManufacturerengineTypeengineVolumeCm3catalystenginePerformanceKwengineSpeedRpmfuelTypetransmission |
| Osvedčenie o evidencii, časť II, zadná strana | bigtechnicallicenseback | bodyTypecolorproductionNumbernumberOfSeatsnumberOfStandingPlacesnumberOfBedsroofLoadKgfuelTankVolumeLlengthMmwidthMmheightMmoperationalWeightKgmaximumWeightKgmaximumBrakedTrailerWeightKgmaximumUnbrakedTrailerWeightKgnumberOfAxleswheelbaseMmfrontTyresrearTyresfrontRimsrearRimsmaximumSpeedKphstationaryNoiseDbdriveByNoiseDbemissionStandardco2GKmfuelConsumptionL100Km |
| Povolenie na pobyt, predná strana | residencepermitfront | documentNumbersexnationalitynationalityNamedateOfBirthpersonalNumbertypeOfPermitdateOfExpirynotescardAccessNumber |
| Povolenie na pobyt, zadná strana | residencepermitback | documentNumbersexnationalitynationalityNamedateOfBirthdateOfExpirydateOfIssueissuedByplaceOfBirthaddresspersonalNumbercountryCode |
| Preukaz osoby so zdravotným postihnutím | disabilitycard | dateOfBirthdateOfIssuedocumentNumberissuedByaddress |
| Celý obrázok alebo nerozpoznaný dokument | fullimage / other | - |
Podporované dokumenty
Pozrite sa, čo Scanverion dokáže prečítať.
Jasne neplatné AI vzory vychádzajú z odkazovaných verejných rozložení dokladov. Karty odlišujú API kategóriu od implementovaného a testovaného štruktúrovaného výstupu skenera.

Cestovný pas
Univerzálna ICAO TD3 MRZ a vybrané tlačené rozloženia
Príklady polí
Passport
namedocumentNumbernationalityNamedateOfBirthdateOfExpiryplaceOfBirth
Občiansky preukaz
Extrakcia prednej a zadnej strany podľa krajiny
Príklady polí
EUIdFrontEUIdBack
namedocumentNumberpersonalNumbernationalityNameaddressdateOfExpiry
Povolenie na pobyt
Slovenské predné a zadné rozloženie
Príklady polí
ResidencePermitFrontResidencePermitBack
namedocumentNumbertypeOfPermitnationalityNameaddressissuedBy
Vodičský preukaz EÚ
Slovenské predné rozloženie
Príklady polí
EUDriverLicenseFront
namedocumentNumberdateOfIssuedateOfExpiryissuedBylicenseAllowedCategories
Malý technický preukaz · časť I
Slovenská plastová karta časť I spredu a zozadu
Príklady polí
EUTechnicalLicenseFrontEUTechnicalLicenseBack
documentNumbervinlicensePlatemanufacturermodelfuelType
Veľký technický preukaz · časť II
Slovenský skladací papierový doklad časť II spredu a zozadu
Príklady polí
BigTechnicalLicenseFrontBigTechnicalLicenseBackEUTechnicalLicensePartII
documentNumbervinlicensePlatevehicleCategoryenginePerformanceKwmaximumWeightKg
Preukaz ŤZP
Slovenské rozloženia preukazu
Príklady polí
DisabilityCard
namedocumentNumberdateOfBirthdateOfIssueissuedByaddress
Faktúra
Extrakcia faktúr podľa obsahu a rozloženia
Príklady polí
Invoice
invoiceNumbersupplierNamecustomerNamepaymentReferencelineItemsgrossTotalAI ukážky používajú fiktívne údaje, viditeľné označenie VZOR/SPECIMEN a neplatné strojovo čitateľné hodnoty. Nie sú to skutočné ani zákaznícke doklady.

Generické dokumenty
Vizuálne operácie fungujú aj mimo známych typov dokladov.
Checkboxy, čiarové kódy, podpisy, tváre, rozmazanie a otočenie možno analyzovať na formulároch, zmluvách, skenoch aj neznámych dokumentoch. Samostatný profil skenera nie je potrebný.
Detection: Nájde dokumenty a ďalšie objekty.Rotation: Zmeria otočenie dokumentu.Blur: Vyhodnotí ostrosť obrázka.BarcodeReading: Prečíta QR a čiarové kódy.CheckboxDetection: Vyhodnotí oblasti checkboxov z požiadavky.SignatureDetection: Nájde viditeľný podpis.FaceDetection: Nájde viditeľné tváre.FaceExtraction: Vráti výrezy nájdených tvárí.
Príklady polí
CheckboxDetection používa CheckboxDefinitions z požiadavky. Spracovanie celého obrázka môže vrátiť aj vyžiadané ScannerFields.
Predloha rozloženia: Original Scanverion AI application form · Fictional demoPodpora krajín
Pokrytie krajín závisí od typu dokumentu.
Pasy používajú globálny štandard strojovo čitateľnej zóny. Občianske a národné doklady potrebujú rozloženia podľa krajiny a generácie.
Cestovné pasy
Všetky vydávajúce krajiny s čitateľnou ICAO TD3 MRZNárodné občianske preukazy
Samostatná štruktúrovaná extrakcia pre implementované rozloženiaSlovenské národné doklady
Samostatná extrakcia pre slovenské rozloženia05 / AI endpoint
Spracovanie vozidiel
Spustite detekciu alebo kontrolu rozmazania snímky vozidla.
Štruktúra požiadavky zodpovedá spracovaniu dokumentov, ale požiadavky na vozidlá prijímajú iba Detection a Blur. Nepodporované kombinácie vracajú 422 Unprocessable Entity.
06 / Viac súborov
Dávkové spracovanie
Spracujte viac dokumentov alebo snímok vozidiel jednou synchrónnou požiadavkou.
Pole Files zopakujte pre každý súbor. Súbory sa spracúvajú postupne, každý výsledok zostáva identifikovateľný v dávkovej odpovedi a využitie sa sčíta za celú požiadavku.
curl --request POST "$SCANVERION_API_URL/api/v1/ai/document-processing/batches" \
--header "Authorization: Bearer $SCANVERION_API_KEY" \
--header "Idempotency-Key: onboarding-batch-42" \
--form "Files=@front.jpg;type=image/jpeg" \
--form "Files=@back.jpg;type=image/jpeg" \
--form "Operations=Scanner"Adresár endpointov spracovania
| Metóda | Cesta | Pole súboru | Kontrakt |
|---|---|---|---|
POST | /api/v1/ai/document-processing | File | JPEG, PNG, WebP alebo PDF; najviac 10 MB |
POST | /api/v1/ai/vehicle-processing | File | JPEG, PNG alebo WebP; iba Detection a Blur |
POST | /api/v1/ai/document-processing/batches | Files | Viac súborov; výsledky zostávajú zoskupené podľa súboru |
POST | /api/v1/ai/vehicle-processing/batches | Files | Viac snímok vozidiel; iba Detection a Blur |
GET | /api/v1/ai/capabilities | - | Podporované MIME typy, operácie a maximálna veľkosť súboru |
07 / Funkcie
Operácie a závislosti
Vyberte podporované operácie a pochopte automaticky pridané závislosti.
| Operácia | Účel | Závislosť alebo obmedzenie |
|---|---|---|
| Detection | Vyhľadá a klasifikuje objekty dokumentu alebo vozidla. | Pri väčšine dokumentových postupov sa pridá automaticky. |
| Scanner | Extrahuje typované polia z podporovaných dokumentov. | Vyžaduje ho LostOrStolenCardCheck. |
| Rotation | Uvádza orientáciu dokumentu. | Pridá ho FaceExtraction. |
| Blur | Vyhodnotí rozmazanie obrázka. | Podporované pre dokumenty a vozidlá. |
| FaceDetection | Nájde tváre v detegovanom dokumente. | Pridá ho FaceExtraction. |
| FaceExtraction | Vráti extrahované údaje alebo obrázky tvárí. | Pridáva FaceDetection a Rotation. |
| BarcodeReading | Číta podporované jednodimenzionálne a dvojdimenzionálne kódy. | Iba spracovanie dokumentov. |
| CheckboxDetection | Vyhodnocuje nakonfigurované oblasti zaškrtávacích polí. | CheckboxDefinitions musí byť platný JSON. |
| SignatureDetection | Vyhľadá podpisy v dokumente. | Iba detekcia; porovnávanie podpisov nie je vystavené. |
08 / Schéma
Model odpovede
Čítajte výsledky objektov, stavy operácií, časovanie a účtované kredity.
objects zachováva vzťah medzi každým detegovaným objektom a výsledkami jeho operácií. operations uvádza požadovanú a automaticky pridanú prácu. usage je autoritatívna účtovaná hodnota odpovede.
{
"requestId": "7f6a7b7f0ad74729a4c4d13fa7dc6dd4",
"model": "Document",
"processingTimeMs": 412,
"objects": [{
"objectId": "document-1",
"category": "Invoice",
"confidence": 1,
"bounds": { "left": 0, "top": 0, "right": 1, "bottom": 1 },
"results": {
"scanner": {
"fields": {
"invoiceNumber": "2026-0007",
"issueDate": "2026-08-07",
"dueDate": "2026-08-21",
"paymentReference": "26000006",
"supplierIban": "SK5511000000002628210731",
"customerIban": null,
"supplierName": "Scanverion s. r. o.",
"supplierAddress": "Pribinova 10, 811 09 Bratislava",
"supplierStreetName": "Pribinova",
"supplierStreetNumber": "10",
"supplierPostalCode": "81109",
"supplierCity": "Bratislava",
"supplierVatNumber": "SK2120720041",
"customerName": "Example Customer s. r. o.",
"customerAddress": "Main Street 12, 040 01 Kosice",
"customerVatNumber": "SK2020123456",
"netTotal": "19.29",
"vatTotal": "4.44",
"vatBreakdown": "[{"rate":"23","amount":"4.44"}]",
"lineItems": "[{"description":"Monthly subscription","quantity":"1","unit":"pcs","unitPrice":"19.29","netAmount":"19.29","vatRate":"23","vatAmount":"4.44","grossAmount":"23.73"}]",
"grossTotal": "23.73",
"currency": "EUR"
},
"issuingCountry": null,
"detectedLanguages": [{ "code": "sk", "confidence": 0.97 }]
},
"rotation": { "degrees": 0 }
},
"pageNumber": 1
}],
"operations": [
{ "operation": "Detection", "status": "Completed", "message": null },
{ "operation": "Scanner", "status": "Completed", "message": null },
{ "operation": "Rotation", "status": "Completed", "message": null }
],
"usage": {
"units": 3,
"unitsByOperation": { "Detection": 1, "Scanner": 1, "Rotation": 1 }
}
}09 / Vyhradené zdroje
Validačné zdroje
Použite samostatné endpointy pre stratené doklady a poštové smerovacie čísla.
| Metóda | Cesta | Vstup |
|---|---|---|
POST | /api/v1/validation/id-cards/lost-or-stolen | JSON telo: cardNumber a cardType |
GET | /api/v1/validation/postal-codes | Query: address a voliteľný countryCode=SK alebo SVK |
curl --request POST "$SCANVERION_API_URL/api/v1/validation/id-cards/lost-or-stolen" \
--header "Authorization: Bearer $SCANVERION_API_KEY" \
--header "Content-Type: application/json" \
--data '{ "cardNumber": "AA123456", "cardType": "nationalId" }'10 / Účtovanie
Využitie a kredity
Získajte volania, vážené kredity, denné súčty, funkcie a cenový náhľad.
Kredity sú vážené podľa nastaveného násobiteľa produktu, preto sú volania a kredity samostatné metriky. Endpointy využitia prijímajú vrátane dátumy from a to; predvolene obdobie začína prvým dňom aktuálneho kalendárneho mesiaca a končí dnes.
| Metóda | Cesta | Vrátené údaje |
|---|---|---|
GET | /api/v1/usage/summary | Volania a vážené kredity za obdobie |
GET | /api/v1/usage/daily | Denné súčty volaní a kreditov |
GET | /api/v1/usage/by-capability | Súčty zoskupené podľa účtovanej funkcie |
GET | /api/v1/usage/price-preview | Náhľad zahrnutých kreditov, nadlimitnej ceny a celku v EUR |
11 / Obnova
Chyby a stratégia opakovania
Riešte chyby autentifikácie, oprávnení, validácie, duplicít a poskytovateľov.
| Stav | Význam | Akcia klienta |
|---|---|---|
401 Unauthorized | Kľúč chýba, je nesprávny, neaktívny, expirovaný, odvolaný alebo nie je priradený k pracovnému priestoru. | Neopakujte požiadavku, kým neopravíte prihlasovacie údaje. |
402 Payment Required | Oprávnenie pracovného priestoru alebo limit spracovania je vyčerpaný. | Zmeňte plán alebo nastavenie nadlimitného účtovania. |
409 Conflict | Idempotency key už rezervoval túto požiadavku na spracovanie. | Považujte ju za rovnaký pokus; nevytvárajte nový kľúč bez dôvodu. |
422 Unprocessable Entity | Súbor, kombinácia operácií, polia, rozsah dátumov alebo validačný vstup nie sú platné. | Pred opakovaním opravte požiadavku. |
502 Bad Gateway | Nadradený AI alebo validačný poskytovateľ zlyhal alebo vrátil nejednoznačný výsledok. | Ak je operácia bezpečná na opakovanie, skúste ju znova s odstupom. |
503 Service Unavailable | Potrebný poskytovateľ spracovania je dočasne nedostupný. | Opakujte s obmedzeným exponenciálnym odstupom. |
Zaznamenajte requestId odpovede, HTTP stav a idempotency key. Náhodné obmedzené exponenciálne opakovanie používajte iba pri dočasných chybách; validačné chyby a chyby prihlasovacích údajov vyžadujú zmenu požiadavky.
12 / Generovaný kontrakt
Referencia OpenAPI
Otvorte generovaný Scalar explorer alebo stiahnite strojovo čitateľný kontrakt.
Referencia Scanverion API
Spustený kontrakt je zdrojom pravdy pre schémy, hodnoty enumov, požiadavky autentifikácie a deklarované HTTP výsledky.
Integrácia MCP
Lokálne nastavenie stdio pre VS Code a Claude Desktop, vstupy nástrojov, bezpečnosť a diagnostika.
Lokálne stdio / verejný npm balík
Sprístupnite nástroje Scanverion agentovi vo VS Code alebo Claude Desktop. Verejný npm balík beží lokálne cez stdio a nahráva schválené vstupy do API; OCR neprebieha lokálne. Hostované HTTP MCP je obmedzená vývojárska ukážka s API kľúčom, nie všeobecne dostupná služba ani MCP OAuth. Tento návod opisuje lokálne stdio.
1. Inštalácia balíka
Použite Node.js 22 alebo novší a npm. Verejný balík nainštalujte do samostatného inštalačného adresára pomocou uvedeného príkazu. npm nainštaluje aj závislosť Scanverion SDK. Prístup k repozitáru nie je potrebný.
Otvoriť MCP balíknpm install @scanverion/mcp-server@0.1.12. Nastavenie klienta
Zlúčte konfiguráciu so súborom .vscode/mcp.json alebo s používateľskou konfiguráciou MCP. VS Code si vyžiada kľúč v maskovanom poli. Kľúč nevkladajte do chatu.
Na tejto stránke sa kľúč nezadáva ani neukladá. Prázdny adresár vypne prístup k lokálnym súborom; aj nahratie cez base64 vyžaduje výslovný súhlas.
{
"inputs": [
{
"id": "scanverion-api-key",
"type": "promptString",
"description": "API kľúč Scanverion",
"password": true
}
],
"servers": {
"scanverion": {
"type": "stdio",
"command": "node",
"args": [
"C:/path/to/mcp/node_modules/@scanverion/mcp-server/dist/index.js"
],
"env": {
"SCANVERION_API_URL": "https://api.scanverion.com",
"SCANVERION_ALLOWED_DIRECTORIES": "[]",
"SCANVERION_TIMEOUT_MS": "120000",
"SCANVERION_API_KEY": "${input:scanverion-api-key}"
}
}
}
}3. Overenie bez spracovania
Po nastavení kľúča v prostredí terminálu spustite príkaz doctor. Skontroluje adresáre a funkcie dostupné po autentifikácii, ale nenahráva súbory ani nepotvrdzuje oprávnenie na spracovanie.
node ./node_modules/@scanverion/mcp-server/dist/index.js --doctorV klientovi MCP zavolajte list_capabilities a načítajte scanverion://guide. Tento samostatný návod pribalený k serveru je v angličtine a obsahuje postup pre MCP Inspector aj ukážku so syntetickou vzorkou.
Nástroje a účtovanie
- analyze_document
- Spoplatnené. Predvolene iba Detection; pre OCR a extrakciu polí výslovne zvoľte Scanner.
- analyze_vehicle
- Spoplatnené. Podporuje Detection a Blur.
- list_capabilities
- Katalóg modelov AI a limitov bez poplatku za spracovanie; nejde o kontrolu oprávnení.
- list_api_capabilities
- Verejný katalóg API bez poplatku za spracovanie; neoveruje prístup konkrétneho účtu.
- get_usage_summary
- Volania a kredity bez poplatku za spracovanie, pre dátumy YYYY-MM-DD vrátane oboch hraníc. Odhad ceny nie je dostupný, nie je nulový.
Prvé spracovanie dokumentu
Použite syntetickú alebo schválenú vzorku v povolenom adresári. Toto volanie nahrá súbor a môže spotrebovať kredity.
{
"filePath": "C:/approved-samples/sample.png",
"operations": [
"Scanner"
],
"scannerFields": [
"documentNumber"
],
"idempotencyKey": "sample-document-001"
}Zadajte práve jeden vstup: filePath alebo imageBase64. Base64 vyžaduje podporovaný názov súboru alebo typ MIME. Vstupy JPEG, PNG, WebP a PDF nesmú byť prázdne ani väčšie ako 10 MiB. Výsledky zachovávajú text JSON a pridávajú structuredContent.data.
Riešenie problémov a bezpečné opakovanie
CONFIGURATION_ERROR: Skontrolujte kľúč, pole absolútnych ciest adresárov, HTTPS adresu API a časový limit (1 000 až 300 000 ms).INVALID_INPUT: Skontrolujte prístup k súboru, formát, base64, operácie a rozsah dátumov.401 / 403: Skontrolujte platnosť kľúča, prístup k pracovnému priestoru a rozsah process:write.402 / 429: Skontrolujte kredity alebo limity volaní. Pozrite kód chyby, ID požiadavky a možnosť opakovania.- Časový limit ani zrušenie nezaručujú vrátenie poplatku alebo zastavenie práce na serveri. Automatické opakovanie je vypnuté. Rovnaký idempotency key použite iba pre rovnakú logickú požiadavku; duplicita môže vrátiť 409.
Nepovoľujte celé domovské adresáre. Kontrola vyriešených ciest blokuje prechod mimo adresára aj únik cez symbolické odkazy, ale nie je izoláciou na úrovni OS. Proces nesprístupňujte nedôveryhodným klientom a nedovoľte iným používateľom meniť povolené adresáre. Extrahovaný text považujte za nedôveryhodné údaje, nie za pokyny.