> For the complete documentation index, see [llms.txt](https://docs.apryse.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.apryse.com/apis/api-reference.md).

# API Reference

Select your product and preferred language to access full API documentation.

### WebViewer SDK API

<table data-column-title-hidden data-view="cards"><thead><tr><th>Framework</th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><picture><source srcset="https://4131553220-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYzVip1lJUXn2YJNwrDVI%2Fuploads%2FU249EYCGbjNair1LWMGX%2Fwebdarkfinal.png?alt=media&amp;token=ec3f6d2b-633b-46d0-967d-b0bca480fb88" media="(prefers-color-scheme: dark)"><img src="https://4131553220-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYzVip1lJUXn2YJNwrDVI%2Fuploads%2FBV5nw8ogWAhZBc52xQcN%2Fwwwlight.svg?alt=media&amp;token=3b266292-ea10-40ed-a8a1-6940b4a7ba23" alt="" data-size="line"></picture> <strong>WebViewer (JavaScript)</strong></td><td><a href="https://sdk.apryse.com/api/web/Core.PDFNet.html?pk_vid=6e51d2f3581309fb17883731159d33ec">https://sdk.apryse.com/api/web/Core.PDFNet.html?pk_vid=6e51d2f3581309fb17883731159d33ec</a></td></tr></tbody></table>

### Server SDK APIs

<table data-column-title-hidden data-view="cards"><thead><tr><th>Framework</th><th data-type="content-ref"></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><picture><source srcset="https://4131553220-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYzVip1lJUXn2YJNwrDVI%2Fuploads%2FOlzZad1ksG69oICXaLHw%2Fcplusplusdark.svg?alt=media&amp;token=a4c6f936-4d29-4d0d-968f-b97afbf0e4e2" media="(prefers-color-scheme: dark)"><img src="https://4131553220-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYzVip1lJUXn2YJNwrDVI%2Fuploads%2FNqGXCqN9U5IW37GKjtv8%2Fcpluspluslight.svg?alt=media&amp;token=afc3a920-f094-4d86-b05c-28f1905d1a8e" alt="" data-size="line"></picture> <strong>C++</strong></td><td></td><td><a href="https://sdk.apryse.com/api/PDFTronSDK/cpp/index.html?pk_vid=6e51d2f3581309fb17883736929d33ec">https://sdk.apryse.com/api/PDFTronSDK/cpp/index.html?pk_vid=6e51d2f3581309fb17883736929d33ec</a></td></tr><tr><td><picture><source srcset="https://4131553220-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYzVip1lJUXn2YJNwrDVI%2Fuploads%2FtMiSOhBRy42vSus0hc41%2Fjavadark.svg?alt=media&amp;token=c3ec1a0c-6e52-4f60-ac0f-e15879ea5473" media="(prefers-color-scheme: dark)"><img src="https://4131553220-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYzVip1lJUXn2YJNwrDVI%2Fuploads%2FUDjCR5P7C6qEbMUQpnA4%2Fjavalight.svg?alt=media&amp;token=f1a23623-925f-4f59-aa90-bcc91d528270" alt=""></picture> <strong>Java</strong></td><td></td><td><a href="https://sdk.apryse.com/api/PDFTronSDK/java/packages.html?pk_vid=6e51d2f3581309fb17883737059d33ec">https://sdk.apryse.com/api/PDFTronSDK/java/packages.html?pk_vid=6e51d2f3581309fb17883737059d33ec</a></td></tr><tr><td><picture><source srcset="https://4131553220-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYzVip1lJUXn2YJNwrDVI%2Fuploads%2FXKA5tDYK2CB5poEuxU8m%2Fpythondarkfinal.png?alt=media&amp;token=cf6a4c5f-969a-4c49-b533-a06e91c7c043" media="(prefers-color-scheme: dark)"><img src="https://4131553220-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYzVip1lJUXn2YJNwrDVI%2Fuploads%2FhcHldk2BGrAjfZdrf9o5%2Fpythonlight.svg?alt=media&amp;token=d000e819-fac2-4c9d-b8e7-932acd90026e" alt="" data-size="line"></picture> <strong>Python</strong></td><td></td><td><a href="https://sdk.apryse.com/api/PDFTronSDK/python/apryse_sdk.html?pk_vid=6e51d2f3581309fb17883737179d33ec">https://sdk.apryse.com/api/PDFTronSDK/python/apryse_sdk.html?pk_vid=6e51d2f3581309fb17883737179d33ec</a></td></tr><tr><td><picture><source srcset="https://4131553220-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYzVip1lJUXn2YJNwrDVI%2Fuploads%2FVykhjqLUoo2dqjE0p1PX%2Fgodarkfinal.png?alt=media&amp;token=9271b766-e96a-4838-8ade-e45302903883" media="(prefers-color-scheme: dark)"><img src="https://4131553220-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYzVip1lJUXn2YJNwrDVI%2Fuploads%2FlMp5NmcoWsbBs8rYwBNa%2Fgolight.svg?alt=media&amp;token=5c6d26dc-1479-4c27-b0ec-c401924b763d" alt="" data-size="line"></picture> <strong>Go</strong></td><td></td><td><a href="https://pkg.go.dev/github.com/ApryseSDK/pdftron-go/v2#section-documentation">https://pkg.go.dev/github.com/ApryseSDK/pdftron-go/v2#section-documentation</a></td></tr><tr><td><picture><source srcset="https://4131553220-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYzVip1lJUXn2YJNwrDVI%2Fuploads%2Fbq74cCj7PYddIjtUJPtg%2FNWRdark.svg?alt=media&amp;token=c3b19be4-e1f3-4326-9238-577aa53ea0be" media="(prefers-color-scheme: dark)"><img src="https://4131553220-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYzVip1lJUXn2YJNwrDVI%2Fuploads%2F8eVVKFN9To4srVwh6isU%2FNETlight.svg?alt=media&amp;token=4e42ca06-4502-4f6d-a279-e8af5cf1fb9c" alt=""></picture> .<strong>NET</strong></td><td></td><td><a href="https://sdk.apryse.com/api/PDFTronSDK/dotnet/index.html?pk_vid=6e51d2f3581309fb17883737419d33ec">https://sdk.apryse.com/api/PDFTronSDK/dotnet/index.html?pk_vid=6e51d2f3581309fb17883737419d33ec</a></td></tr><tr><td><picture><source srcset="https://4131553220-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYzVip1lJUXn2YJNwrDVI%2Fuploads%2FafibtslbEfAyVqcWRbi9%2Fasp-net-core-light.svg?alt=media&amp;token=5f7542a4-985c-4631-a49e-c5cbc0c1444a" media="(prefers-color-scheme: dark)"><img src="https://4131553220-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYzVip1lJUXn2YJNwrDVI%2Fuploads%2FuZyPcNfS8SBXnKPeb5VJ%2Fnetcorelight.svg?alt=media&amp;token=352fe3d7-e523-44fc-baf7-6a85e4ec7753" alt="" data-size="line"></picture> <strong>.NET core</strong></td><td></td><td><a href="https://sdk.apryse.com/api/PDFTronSDK/dotnetcore/index.html?pk_vid=6e51d2f3581309fb17883737539d33ec">https://sdk.apryse.com/api/PDFTronSDK/dotnetcore/index.html?pk_vid=6e51d2f3581309fb17883737539d33ec</a></td></tr><tr><td><picture><source srcset="https://4131553220-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYzVip1lJUXn2YJNwrDVI%2Fuploads%2Fj6ZB2BHHMUdQhKeF7KOk%2Fnodejsdark.svg?alt=media&amp;token=551023cc-353d-4757-b508-78df0360851b" media="(prefers-color-scheme: dark)"><img src="https://4131553220-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYzVip1lJUXn2YJNwrDVI%2Fuploads%2FB8A1m0XekdWqBNahLUPI%2Fnodejslight.svg?alt=media&amp;token=7ea5a8e4-89ae-44ca-b5dc-f4eb78d0c594" alt=""></picture> <strong>Node.js</strong></td><td></td><td><a href="https://sdk.apryse.com/api/pdfnet-node/PDFNet.html?pk_vid=6e51d2f3581309fb17883737709d33ec">https://sdk.apryse.com/api/pdfnet-node/PDFNet.html?pk_vid=6e51d2f3581309fb17883737709d33ec</a></td></tr></tbody></table>

### Mobile SDK APIs

<table data-column-title-hidden data-view="cards"><thead><tr><th>Framework</th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><picture><source srcset="https://4131553220-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYzVip1lJUXn2YJNwrDVI%2Fuploads%2FBeoMAW813Mwwur3DZ3HO%2Fandroiddark.svg?alt=media&amp;token=8a715c17-4134-47b0-9a57-e743745475bd" media="(prefers-color-scheme: dark)"><img src="https://4131553220-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYzVip1lJUXn2YJNwrDVI%2Fuploads%2FTkwDUsPYBZUrNzKqeDr9%2Fandroidlight.svg?alt=media&amp;token=1d639290-d716-4272-bd3f-b3fa14a23154" alt=""></picture> <strong>Android (Java/Kotlin)</strong></td><td><a href="https://sdk.apryse.com/api/android/javadoc/reference/packages.html?pk_vid=6e51d2f3581309fb17883738259d33ec">https://sdk.apryse.com/api/android/javadoc/reference/packages.html?pk_vid=6e51d2f3581309fb17883738259d33ec</a></td></tr><tr><td><picture><source srcset="https://4131553220-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYzVip1lJUXn2YJNwrDVI%2Fuploads%2FibSvToFNIXyDunvZ97m7%2Fiosdark.svg?alt=media&amp;token=2d64aa5e-c669-47fd-8bdb-70ab46e26f01" media="(prefers-color-scheme: dark)"><img src="https://4131553220-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYzVip1lJUXn2YJNwrDVI%2Fuploads%2FOEZyec298BKHkuwldqgt%2Fioslight.svg?alt=media&amp;token=1ed46877-2fb9-45f8-88d2-f125e3c78708" alt=""></picture> <strong>iOS (obj-C/Swift</strong></td><td><a href="https://sdk.apryse.com/api/ios/index.html?pk_vid=6e51d2f3581309fb17883738399d33ec">https://sdk.apryse.com/api/ios/index.html?pk_vid=6e51d2f3581309fb17883738399d33ec</a></td></tr><tr><td><picture><source srcset="https://4131553220-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYzVip1lJUXn2YJNwrDVI%2Fuploads%2FIOWe6PKo06IlxJtqslok%2Fuwpdark.svg?alt=media&amp;token=7e9c7a62-15cd-4c1e-bfab-028ccc008d36" media="(prefers-color-scheme: dark)"><img src="https://4131553220-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYzVip1lJUXn2YJNwrDVI%2Fuploads%2FVz6vNHTdoO7DZAlMBAT3%2Fuwplight.svg?alt=media&amp;token=008636e4-9809-4cb4-acbe-adf6c4f48316" alt=""></picture> <strong>UWP (C#/VB/JS)</strong></td><td><a href="https://sdk.apryse.com/api/uwp/guides/html/edce5f3e-add3-4c1e-90c8-3d9dc00e8e9e.htm?pk_vid=6e51d2f3581309fb17883738529d33ec">https://sdk.apryse.com/api/uwp/guides/html/edce5f3e-add3-4c1e-90c8-3d9dc00e8e9e.htm?pk_vid=6e51d2f3581309fb17883738529d33ec</a></td></tr><tr><td><picture><source srcset="https://4131553220-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYzVip1lJUXn2YJNwrDVI%2Fuploads%2FzImnnympnPkq7BoyfGhq%2Fxamarindark.svg?alt=media&amp;token=f3e1c10c-c5f9-43a5-aadc-e2c3e06c7ba8" media="(prefers-color-scheme: dark)"><img src="https://4131553220-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYzVip1lJUXn2YJNwrDVI%2Fuploads%2FeYwevYNKIIUBN054MZCj%2Fxamarinlight.svg?alt=media&amp;token=bc28797b-73b1-4b18-8998-b40c14264ce8" alt=""></picture> <strong>Xamarin Android (C#)</strong></td><td><a href="https://sdk.apryse.com/api/xamarinandroid/pdfnet/api/index.html?pk_vid=6e51d2f3581309fb17883738669d33ec">https://sdk.apryse.com/api/xamarinandroid/pdfnet/api/index.html?pk_vid=6e51d2f3581309fb17883738669d33ec</a></td></tr><tr><td><picture><source srcset="https://4131553220-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYzVip1lJUXn2YJNwrDVI%2Fuploads%2FzImnnympnPkq7BoyfGhq%2Fxamarindark.svg?alt=media&amp;token=f3e1c10c-c5f9-43a5-aadc-e2c3e06c7ba8" media="(prefers-color-scheme: dark)"><img src="https://4131553220-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYzVip1lJUXn2YJNwrDVI%2Fuploads%2FeYwevYNKIIUBN054MZCj%2Fxamarinlight.svg?alt=media&amp;token=bc28797b-73b1-4b18-8998-b40c14264ce8" alt=""></picture> <strong>Xamarin iOS (C#)</strong></td><td><a href="https://sdk.apryse.com/api/xamarinios/pdfnet/api/index.html?pk_vid=6e51d2f3581309fb17883738799d33ec">https://sdk.apryse.com/api/xamarinios/pdfnet/api/index.html?pk_vid=6e51d2f3581309fb17883738799d33ec</a></td></tr></tbody></table>

### Scanbot SDK APIs

<table data-column-title-hidden data-view="cards"><thead><tr><th>Framework</th><th data-type="content-ref"></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><picture><source srcset="https://4131553220-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYzVip1lJUXn2YJNwrDVI%2Fuploads%2FBeoMAW813Mwwur3DZ3HO%2Fandroiddark.svg?alt=media&amp;token=8a715c17-4134-47b0-9a57-e743745475bd" media="(prefers-color-scheme: dark)"><img src="https://4131553220-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYzVip1lJUXn2YJNwrDVI%2Fuploads%2FTkwDUsPYBZUrNzKqeDr9%2Fandroidlight.svg?alt=media&amp;token=1d639290-d716-4272-bd3f-b3fa14a23154" alt=""></picture> <strong>Android (Barcode)</strong></td><td></td><td><a href="https://docs.scanbot.io/android/barcode-scanner-sdk/api-references/">https://docs.scanbot.io/android/barcode-scanner-sdk/api-references/</a></td></tr><tr><td><picture><source srcset="https://4131553220-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYzVip1lJUXn2YJNwrDVI%2Fuploads%2FBeoMAW813Mwwur3DZ3HO%2Fandroiddark.svg?alt=media&amp;token=8a715c17-4134-47b0-9a57-e743745475bd" media="(prefers-color-scheme: dark)"><img src="https://4131553220-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYzVip1lJUXn2YJNwrDVI%2Fuploads%2FTkwDUsPYBZUrNzKqeDr9%2Fandroidlight.svg?alt=media&amp;token=1d639290-d716-4272-bd3f-b3fa14a23154" alt=""></picture> <strong>Android (Doc)</strong></td><td></td><td><a href="https://docs.scanbot.io/android/document-scanner-sdk/api-references/">https://docs.scanbot.io/android/document-scanner-sdk/api-references/</a></td></tr><tr><td><picture><source srcset="https://4131553220-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYzVip1lJUXn2YJNwrDVI%2Fuploads%2FBeoMAW813Mwwur3DZ3HO%2Fandroiddark.svg?alt=media&amp;token=8a715c17-4134-47b0-9a57-e743745475bd" media="(prefers-color-scheme: dark)"><img src="https://4131553220-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYzVip1lJUXn2YJNwrDVI%2Fuploads%2FTkwDUsPYBZUrNzKqeDr9%2Fandroidlight.svg?alt=media&amp;token=1d639290-d716-4272-bd3f-b3fa14a23154" alt=""></picture> <strong>Android (Data Cap)</strong></td><td></td><td><a href="https://docs.scanbot.io/android/data-capture-modules/api-references/">https://docs.scanbot.io/android/data-capture-modules/api-references/</a></td></tr><tr><td><picture><source srcset="https://4131553220-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYzVip1lJUXn2YJNwrDVI%2Fuploads%2FibSvToFNIXyDunvZ97m7%2Fiosdark.svg?alt=media&amp;token=2d64aa5e-c669-47fd-8bdb-70ab46e26f01" media="(prefers-color-scheme: dark)"><img src="https://4131553220-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYzVip1lJUXn2YJNwrDVI%2Fuploads%2FOEZyec298BKHkuwldqgt%2Fioslight.svg?alt=media&amp;token=1ed46877-2fb9-45f8-88d2-f125e3c78708" alt=""></picture> <strong>iOS (Barcode)</strong></td><td></td><td><a href="https://docs.scanbot.io/ios/barcode-scanner-sdk/api-references/">https://docs.scanbot.io/ios/barcode-scanner-sdk/api-references/</a></td></tr><tr><td><picture><source srcset="https://4131553220-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYzVip1lJUXn2YJNwrDVI%2Fuploads%2FibSvToFNIXyDunvZ97m7%2Fiosdark.svg?alt=media&amp;token=2d64aa5e-c669-47fd-8bdb-70ab46e26f01" media="(prefers-color-scheme: dark)"><img src="https://4131553220-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYzVip1lJUXn2YJNwrDVI%2Fuploads%2FOEZyec298BKHkuwldqgt%2Fioslight.svg?alt=media&amp;token=1ed46877-2fb9-45f8-88d2-f125e3c78708" alt=""></picture> <strong>iOS (Doc)</strong></td><td></td><td><a href="https://docs.scanbot.io/ios/document-scanner-sdk/api-references/">https://docs.scanbot.io/ios/document-scanner-sdk/api-references/</a></td></tr><tr><td><picture><source srcset="https://4131553220-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYzVip1lJUXn2YJNwrDVI%2Fuploads%2FibSvToFNIXyDunvZ97m7%2Fiosdark.svg?alt=media&amp;token=2d64aa5e-c669-47fd-8bdb-70ab46e26f01" media="(prefers-color-scheme: dark)"><img src="https://4131553220-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYzVip1lJUXn2YJNwrDVI%2Fuploads%2FOEZyec298BKHkuwldqgt%2Fioslight.svg?alt=media&amp;token=1ed46877-2fb9-45f8-88d2-f125e3c78708" alt=""></picture> <strong>iOS (Data Cap)</strong></td><td></td><td><a href="https://docs.scanbot.io/ios/data-capture-modules/api-references/">https://docs.scanbot.io/ios/data-capture-modules/api-references/</a></td></tr><tr><td><picture><source srcset="https://4131553220-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYzVip1lJUXn2YJNwrDVI%2Fuploads%2FU249EYCGbjNair1LWMGX%2Fwebdarkfinal.png?alt=media&amp;token=ec3f6d2b-633b-46d0-967d-b0bca480fb88" media="(prefers-color-scheme: dark)"><img src="https://4131553220-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYzVip1lJUXn2YJNwrDVI%2Fuploads%2FME1XxYf7wfxgw0rABiSb%2Fwwwlight.svg?alt=media&amp;token=c727d3c2-b62f-4696-849c-cc3e9a2e7926" alt="" data-size="line"></picture> <strong>Web (Barcode)</strong></td><td></td><td><a href="https://docs.scanbot.io/web/barcode-scanner-sdk/api-references/">https://docs.scanbot.io/web/barcode-scanner-sdk/api-references/</a></td></tr><tr><td><picture><source srcset="https://4131553220-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYzVip1lJUXn2YJNwrDVI%2Fuploads%2FU249EYCGbjNair1LWMGX%2Fwebdarkfinal.png?alt=media&amp;token=ec3f6d2b-633b-46d0-967d-b0bca480fb88" media="(prefers-color-scheme: dark)"><img src="https://4131553220-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYzVip1lJUXn2YJNwrDVI%2Fuploads%2FME1XxYf7wfxgw0rABiSb%2Fwwwlight.svg?alt=media&amp;token=c727d3c2-b62f-4696-849c-cc3e9a2e7926" alt="" data-size="line"></picture> <strong>Web (Doc)</strong></td><td></td><td><a href="https://docs.scanbot.io/web/document-scanner-sdk/api-references/">https://docs.scanbot.io/web/document-scanner-sdk/api-references/</a></td></tr><tr><td><picture><source srcset="https://4131553220-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYzVip1lJUXn2YJNwrDVI%2Fuploads%2FU249EYCGbjNair1LWMGX%2Fwebdarkfinal.png?alt=media&amp;token=ec3f6d2b-633b-46d0-967d-b0bca480fb88" media="(prefers-color-scheme: dark)"><img src="https://4131553220-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYzVip1lJUXn2YJNwrDVI%2Fuploads%2FME1XxYf7wfxgw0rABiSb%2Fwwwlight.svg?alt=media&amp;token=c727d3c2-b62f-4696-849c-cc3e9a2e7926" alt="" data-size="line"></picture> <strong>Web(Data Cap)</strong></td><td></td><td><a href="https://docs.scanbot.io/web/data-capture-modules/api-references/">https://docs.scanbot.io/web/data-capture-modules/api-references/</a></td></tr><tr><td><picture><source srcset="https://4131553220-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYzVip1lJUXn2YJNwrDVI%2Fuploads%2FIPkzgwsiSamsrR7z9Bx0%2Freactdark.svg?alt=media&amp;token=f6191ec2-9376-4f5f-907d-c066b982bff3" media="(prefers-color-scheme: dark)"><img src="https://4131553220-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYzVip1lJUXn2YJNwrDVI%2Fuploads%2Fm17sgqxsHbDbWH7i2MaU%2Freactlight.svg?alt=media&amp;token=6fecf237-3820-40e1-9502-340c1dbb3f64" alt=""></picture> <strong>React Native (Barcode)</strong></td><td></td><td><a href="https://docs.scanbot.io/react-native/barcode-scanner-sdk/api-references/">https://docs.scanbot.io/react-native/barcode-scanner-sdk/api-references/</a></td></tr><tr><td><picture><source srcset="https://4131553220-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYzVip1lJUXn2YJNwrDVI%2Fuploads%2FIPkzgwsiSamsrR7z9Bx0%2Freactdark.svg?alt=media&amp;token=f6191ec2-9376-4f5f-907d-c066b982bff3" media="(prefers-color-scheme: dark)"><img src="https://4131553220-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYzVip1lJUXn2YJNwrDVI%2Fuploads%2Fm17sgqxsHbDbWH7i2MaU%2Freactlight.svg?alt=media&amp;token=6fecf237-3820-40e1-9502-340c1dbb3f64" alt=""></picture> <strong>React Native (Doc)</strong></td><td></td><td><a href="https://docs.scanbot.io/react-native/document-scanner-sdk/api-references/">https://docs.scanbot.io/react-native/document-scanner-sdk/api-references/</a></td></tr><tr><td><picture><source srcset="https://4131553220-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYzVip1lJUXn2YJNwrDVI%2Fuploads%2FIPkzgwsiSamsrR7z9Bx0%2Freactdark.svg?alt=media&amp;token=f6191ec2-9376-4f5f-907d-c066b982bff3" media="(prefers-color-scheme: dark)"><img src="https://4131553220-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYzVip1lJUXn2YJNwrDVI%2Fuploads%2Fm17sgqxsHbDbWH7i2MaU%2Freactlight.svg?alt=media&amp;token=6fecf237-3820-40e1-9502-340c1dbb3f64" alt=""></picture> <strong>React Native (Data Cap)</strong></td><td></td><td><a href="https://docs.scanbot.io/react-native/data-capture-modules/api-references/">https://docs.scanbot.io/react-native/data-capture-modules/api-references/</a></td></tr><tr><td><picture><source srcset="https://4131553220-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYzVip1lJUXn2YJNwrDVI%2Fuploads%2FuMB5GUG3U2Hxq4Ws8FHx%2Fflutterdark.svg?alt=media&amp;token=839d1355-4a26-477e-9897-65a7234222f9" media="(prefers-color-scheme: dark)"><img src="https://4131553220-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYzVip1lJUXn2YJNwrDVI%2Fuploads%2FJwAAxl6HyhdiB66l8ys1%2Fflutterlight.svg?alt=media&amp;token=bb3d3aa4-4145-4480-a246-d2d471aa543c" alt=""></picture> <strong>Flutter (Barcode)</strong></td><td></td><td><a href="https://docs.scanbot.io/flutter/barcode-scanner-sdk/api-references/">https://docs.scanbot.io/flutter/barcode-scanner-sdk/api-references/</a></td></tr><tr><td><picture><source srcset="https://4131553220-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYzVip1lJUXn2YJNwrDVI%2Fuploads%2FuMB5GUG3U2Hxq4Ws8FHx%2Fflutterdark.svg?alt=media&amp;token=839d1355-4a26-477e-9897-65a7234222f9" media="(prefers-color-scheme: dark)"><img src="https://4131553220-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYzVip1lJUXn2YJNwrDVI%2Fuploads%2FJwAAxl6HyhdiB66l8ys1%2Fflutterlight.svg?alt=media&amp;token=bb3d3aa4-4145-4480-a246-d2d471aa543c" alt=""></picture> <strong>Flutter (Doc)</strong></td><td></td><td><a href="https://docs.scanbot.io/flutter/document-scanner-sdk/api-references/">https://docs.scanbot.io/flutter/document-scanner-sdk/api-references/</a></td></tr><tr><td><picture><source srcset="https://4131553220-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYzVip1lJUXn2YJNwrDVI%2Fuploads%2FuMB5GUG3U2Hxq4Ws8FHx%2Fflutterdark.svg?alt=media&amp;token=839d1355-4a26-477e-9897-65a7234222f9" media="(prefers-color-scheme: dark)"><img src="https://4131553220-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYzVip1lJUXn2YJNwrDVI%2Fuploads%2FJwAAxl6HyhdiB66l8ys1%2Fflutterlight.svg?alt=media&amp;token=bb3d3aa4-4145-4480-a246-d2d471aa543c" alt=""></picture> <strong>Flutter (Data Cap)</strong></td><td></td><td><a href="https://docs.scanbot.io/flutter/data-capture-modules/api-references/">https://docs.scanbot.io/flutter/data-capture-modules/api-references/</a></td></tr><tr><td><picture><source srcset="https://4131553220-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYzVip1lJUXn2YJNwrDVI%2Fuploads%2FkSSpVK7PTIkkZwORTDXr%2FCapacitor_Apryse.svg?alt=media&amp;token=9a732116-0a12-466a-ab0f-fe336f03c6e9" media="(prefers-color-scheme: dark)"><img src="https://4131553220-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYzVip1lJUXn2YJNwrDVI%2Fuploads%2FDAFlmgp320NaVeDcaDuf%2Fcapacitorlight.svg?alt=media&amp;token=073910a8-88fe-478d-a433-edd52ebdb0d5" alt="" data-size="line"></picture> <strong>Capacitor (Barcode)</strong></td><td></td><td><a href="https://docs.scanbot.io/capacitor/barcode-scanner-sdk/api-references/">https://docs.scanbot.io/capacitor/barcode-scanner-sdk/api-references/</a></td></tr><tr><td><picture><source srcset="https://4131553220-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYzVip1lJUXn2YJNwrDVI%2Fuploads%2FkSSpVK7PTIkkZwORTDXr%2FCapacitor_Apryse.svg?alt=media&amp;token=9a732116-0a12-466a-ab0f-fe336f03c6e9" media="(prefers-color-scheme: dark)"><img src="https://4131553220-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYzVip1lJUXn2YJNwrDVI%2Fuploads%2FDAFlmgp320NaVeDcaDuf%2Fcapacitorlight.svg?alt=media&amp;token=073910a8-88fe-478d-a433-edd52ebdb0d5" alt="" data-size="line"></picture> <strong>Capacitor (Doc)</strong></td><td></td><td><a href="https://docs.scanbot.io/capacitor/document-scanner-sdk/api-references/">https://docs.scanbot.io/capacitor/document-scanner-sdk/api-references/</a></td></tr><tr><td><picture><source srcset="https://4131553220-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYzVip1lJUXn2YJNwrDVI%2Fuploads%2FkSSpVK7PTIkkZwORTDXr%2FCapacitor_Apryse.svg?alt=media&amp;token=9a732116-0a12-466a-ab0f-fe336f03c6e9" media="(prefers-color-scheme: dark)"><img src="https://4131553220-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYzVip1lJUXn2YJNwrDVI%2Fuploads%2FDAFlmgp320NaVeDcaDuf%2Fcapacitorlight.svg?alt=media&amp;token=073910a8-88fe-478d-a433-edd52ebdb0d5" alt="" data-size="line"></picture> <strong>Capacitor (Data Cap)</strong></td><td></td><td><a href="https://docs.scanbot.io/capacitor/data-capture-modules/api-references/">https://docs.scanbot.io/capacitor/data-capture-modules/api-references/</a></td></tr><tr><td><picture><source srcset="https://4131553220-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYzVip1lJUXn2YJNwrDVI%2Fuploads%2Fbq74cCj7PYddIjtUJPtg%2FNWRdark.svg?alt=media&amp;token=c3b19be4-e1f3-4326-9238-577aa53ea0be" media="(prefers-color-scheme: dark)"><img src="https://4131553220-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYzVip1lJUXn2YJNwrDVI%2Fuploads%2F8eVVKFN9To4srVwh6isU%2FNETlight.svg?alt=media&amp;token=4e42ca06-4502-4f6d-a279-e8af5cf1fb9c" alt=""></picture> <strong>.NET MAUI (Barcode)</strong></td><td></td><td><a href="https://docs.scanbot.io/maui/barcode-scanner-sdk/api-references/">https://docs.scanbot.io/maui/barcode-scanner-sdk/api-references/</a></td></tr><tr><td><picture><source srcset="https://4131553220-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYzVip1lJUXn2YJNwrDVI%2Fuploads%2Fbq74cCj7PYddIjtUJPtg%2FNWRdark.svg?alt=media&amp;token=c3b19be4-e1f3-4326-9238-577aa53ea0be" media="(prefers-color-scheme: dark)"><img src="https://4131553220-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYzVip1lJUXn2YJNwrDVI%2Fuploads%2F8eVVKFN9To4srVwh6isU%2FNETlight.svg?alt=media&amp;token=4e42ca06-4502-4f6d-a279-e8af5cf1fb9c" alt=""></picture> <strong>.NET MAUI (Doc)</strong></td><td></td><td><a href="https://docs.scanbot.io/maui/document-scanner-sdk/api-references/">https://docs.scanbot.io/maui/document-scanner-sdk/api-references/</a></td></tr><tr><td><picture><source srcset="https://4131553220-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYzVip1lJUXn2YJNwrDVI%2Fuploads%2Fbq74cCj7PYddIjtUJPtg%2FNWRdark.svg?alt=media&amp;token=c3b19be4-e1f3-4326-9238-577aa53ea0be" media="(prefers-color-scheme: dark)"><img src="https://4131553220-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYzVip1lJUXn2YJNwrDVI%2Fuploads%2F8eVVKFN9To4srVwh6isU%2FNETlight.svg?alt=media&amp;token=4e42ca06-4502-4f6d-a279-e8af5cf1fb9c" alt=""></picture> <strong>.NET MAUI (Data Cap)</strong></td><td></td><td><a href="https://docs.scanbot.io/maui/data-capture-modules/api-references/">https://docs.scanbot.io/maui/data-capture-modules/api-references/</a></td></tr><tr><td><picture><source srcset="https://4131553220-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYzVip1lJUXn2YJNwrDVI%2Fuploads%2FPcy05NStciVKKZASoOUW%2Flinuxdarkfinal.png?alt=media&amp;token=054578eb-114f-4f89-ac2e-a2dd15bf8990" media="(prefers-color-scheme: dark)"><img src="https://4131553220-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYzVip1lJUXn2YJNwrDVI%2Fuploads%2FpFTPVSF8XUPXstWCX8w5%2Flinuxlight.svg?alt=media&amp;token=f749a980-4fcb-441b-81fb-8b274c075091" alt="" data-size="line"></picture> <strong>Linux (Barcode)</strong></td><td></td><td><a href="https://docs.scanbot.io/linux/barcode-scanner-sdk/api-reference/">https://docs.scanbot.io/linux/barcode-scanner-sdk/api-reference/</a></td></tr><tr><td><picture><source srcset="https://4131553220-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYzVip1lJUXn2YJNwrDVI%2Fuploads%2FPcy05NStciVKKZASoOUW%2Flinuxdarkfinal.png?alt=media&amp;token=054578eb-114f-4f89-ac2e-a2dd15bf8990" media="(prefers-color-scheme: dark)"><img src="https://4131553220-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYzVip1lJUXn2YJNwrDVI%2Fuploads%2FpFTPVSF8XUPXstWCX8w5%2Flinuxlight.svg?alt=media&amp;token=f749a980-4fcb-441b-81fb-8b274c075091" alt="" data-size="line"></picture> <strong>Linux (Doc)</strong></td><td></td><td><a href="https://docs.scanbot.io/linux/document-scanner-sdk/api-reference/">https://docs.scanbot.io/linux/document-scanner-sdk/api-reference/</a></td></tr><tr><td><picture><source srcset="https://4131553220-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYzVip1lJUXn2YJNwrDVI%2Fuploads%2FPcy05NStciVKKZASoOUW%2Flinuxdarkfinal.png?alt=media&amp;token=054578eb-114f-4f89-ac2e-a2dd15bf8990" media="(prefers-color-scheme: dark)"><img src="https://4131553220-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYzVip1lJUXn2YJNwrDVI%2Fuploads%2FpFTPVSF8XUPXstWCX8w5%2Flinuxlight.svg?alt=media&amp;token=f749a980-4fcb-441b-81fb-8b274c075091" alt="" data-size="line"></picture> <strong>Linux (Data Cap)</strong></td><td></td><td><a href="https://docs.scanbot.io/linux/data-capture-modules/api-reference/">https://docs.scanbot.io/linux/data-capture-modules/api-reference/</a></td></tr><tr><td><picture><source srcset="https://4131553220-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYzVip1lJUXn2YJNwrDVI%2Fuploads%2Fn8m1yM8M0uDnCbbZFSk5%2Fcordovadarkfinal.png?alt=media&amp;token=15a3cb77-9c52-416c-9c9b-a0c9bcbc0fd4" media="(prefers-color-scheme: dark)"><img src="https://4131553220-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYzVip1lJUXn2YJNwrDVI%2Fuploads%2FJ1AQq3iWNQyhLdsI0C5V%2Fcordovalight.svg?alt=media&amp;token=92e616db-0527-4835-ba90-0c2d9b3c2403" alt="" data-size="line"></picture> <strong>Cordova (Barcode)</strong></td><td></td><td><a href="https://docs.scanbot.io/cordova/barcode-scanner-sdk/api-reference/">https://docs.scanbot.io/cordova/barcode-scanner-sdk/api-reference/</a></td></tr><tr><td><picture><source srcset="https://4131553220-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYzVip1lJUXn2YJNwrDVI%2Fuploads%2Fn8m1yM8M0uDnCbbZFSk5%2Fcordovadarkfinal.png?alt=media&amp;token=15a3cb77-9c52-416c-9c9b-a0c9bcbc0fd4" media="(prefers-color-scheme: dark)"><img src="https://4131553220-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYzVip1lJUXn2YJNwrDVI%2Fuploads%2FJ1AQq3iWNQyhLdsI0C5V%2Fcordovalight.svg?alt=media&amp;token=92e616db-0527-4835-ba90-0c2d9b3c2403" alt="" data-size="line"></picture> <strong>Cordova (Doc and Data Cap)</strong></td><td></td><td><a href="https://docs.scanbot.io/cordova/document-scanner-sdk/api-reference/">https://docs.scanbot.io/cordova/document-scanner-sdk/api-reference/</a></td></tr><tr><td><picture><source srcset="https://4131553220-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYzVip1lJUXn2YJNwrDVI%2Fuploads%2FzImnnympnPkq7BoyfGhq%2Fxamarindark.svg?alt=media&amp;token=f3e1c10c-c5f9-43a5-aadc-e2c3e06c7ba8" media="(prefers-color-scheme: dark)"><img src="https://4131553220-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYzVip1lJUXn2YJNwrDVI%2Fuploads%2FeYwevYNKIIUBN054MZCj%2Fxamarinlight.svg?alt=media&amp;token=bc28797b-73b1-4b18-8998-b40c14264ce8" alt=""></picture> <strong>Xamarin (Barcode)</strong></td><td></td><td><a href="https://docs.scanbot.io/xamarin/barcode-scanner-sdk/introduction/">https://docs.scanbot.io/xamarin/barcode-scanner-sdk/introduction/</a></td></tr><tr><td><picture><source srcset="https://4131553220-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYzVip1lJUXn2YJNwrDVI%2Fuploads%2FzImnnympnPkq7BoyfGhq%2Fxamarindark.svg?alt=media&amp;token=f3e1c10c-c5f9-43a5-aadc-e2c3e06c7ba8" media="(prefers-color-scheme: dark)"><img src="https://4131553220-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYzVip1lJUXn2YJNwrDVI%2Fuploads%2FeYwevYNKIIUBN054MZCj%2Fxamarinlight.svg?alt=media&amp;token=bc28797b-73b1-4b18-8998-b40c14264ce8" alt=""></picture> <strong>Xamarin (Doc and Data Cap)</strong></td><td></td><td><a href="https://docs.scanbot.io/xamarin/document-scanner-sdk/introduction/">https://docs.scanbot.io/xamarin/document-scanner-sdk/introduction/</a></td></tr><tr><td><picture><source srcset="https://4131553220-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYzVip1lJUXn2YJNwrDVI%2Fuploads%2FlC76iZ8NzNq3eUXTwzoq%2Fkotlindarkfinal2.png?alt=media&amp;token=788f7194-0e75-480c-a7ff-271a78d1234c" media="(prefers-color-scheme: dark)"><img src="https://4131553220-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYzVip1lJUXn2YJNwrDVI%2Fuploads%2FlBiCOWd0JjqHF1ptlZfl%2Fkotlinlight.svg?alt=media&amp;token=073c7d77-2d66-435d-a779-d4fd8efe6081" alt="" data-size="line"></picture> <strong>Kotlin Multiplatform (Barcode)</strong></td><td></td><td><a href="https://docs.scanbot.io/kmp/barcode-scanner-sdk/api-references/">https://docs.scanbot.io/kmp/barcode-scanner-sdk/api-references/</a></td></tr><tr><td><picture><source srcset="https://4131553220-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYzVip1lJUXn2YJNwrDVI%2Fuploads%2FlC76iZ8NzNq3eUXTwzoq%2Fkotlindarkfinal2.png?alt=media&amp;token=788f7194-0e75-480c-a7ff-271a78d1234c" media="(prefers-color-scheme: dark)"><img src="https://4131553220-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYzVip1lJUXn2YJNwrDVI%2Fuploads%2FlBiCOWd0JjqHF1ptlZfl%2Fkotlinlight.svg?alt=media&amp;token=073c7d77-2d66-435d-a779-d4fd8efe6081" alt="" data-size="line"></picture> <strong>Kotlin Multiplatform (Doc)</strong></td><td></td><td><a href="https://docs.scanbot.io/kmp/document-scanner-sdk/api-references/">https://docs.scanbot.io/kmp/document-scanner-sdk/api-references/</a></td></tr></tbody></table>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.apryse.com/apis/api-reference.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
