Document Scanner API

PresentID Document scanner API localizes document images with various distortion types from a single input image.

PresentID Document scanner API localizes document images with various distortion types from a single input image.

**Input:**
- Image file
- Image URL link
- Base64 image

**Output:**
- Base64 image
- Status message

**Features:**
- Less than 1.5 seconds on CPU core i7.
- Perfect detection on a salient document in the image.
- Support IOS, Android, Windows, and Mac devices.
- Easy integration with your app.

**Use Cases:**
- To create PDF files and notes and books.
- Ease of separating text in images.

**Rules & Restrictions:**
- Send data via Base64 or an image URL or an image file.
- Image size should not exceed 8 MB.
- Also, the images should not be larger than 5000 pixels and smaller than 50 pixels.

API Documentation

Endpoints


PresentID Document scanner API localizes document images with various distortion types from a single input image.



                                                                            
POST https://zylalabs.com/api/3977/document+scanner+api/4732/document+scanner
                                                                            
                                                                        

Document Scanner - Endpoint Features

Object Description
Request Body [Required] File Binary
Test Endpoint

API EXAMPLE RESPONSE

       
                                                                                                        
                                                                                                                                                                                                                            {"statusCode":200,"statusMessage":"success","hasError":false,"data":{"base64Image":"data:image/png;base64,/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAIBAQEBAQIBAQECAgICAgQDAgICAgUEBAMEBgUGBgYFBgYGBwkIBgcJBwYGCAsICQoKCgoKBggLDAsKDAkKCgr/2wBDAQICAgICAgUDAwUKBwYHCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgr/wAARCAeOCFsDASIAAhEBAxEB/8QAHwAAAQUBAQEBAQEAAAAAAAAAAAECAwQFBgcICQoL/8QAtRAAAgEDAwIEAwUFBAQAAAF9AQIDAAQRBRIhMUEGE1FhByJxFDKBkaEII0KxwRVS0fAkM2JyggkKFhcYGRolJicoKSo0NTY3ODk6Q0RFRkdISUpTVFVWV1hZWmNkZWZnaGlqc3R1dnd4eXqDhIWGh4iJipKTlJWWl5iZmqKjpKWmp6ipqrKztLW2t7i5usLDxMXGx8jJytLT1NXW19jZ2uHi4+Tl5ufo6erx8vP09fb3+Pn6/8QAHwEAAwEBAQEBAQEBAQAAAAAAAAECAwQFBgcICQoL/8QAtREAAgECBAQDBAcFBAQAAQJ3AAECAxEEBSExBhJBUQdhcRMiMoEIFEKRobHBCSMzUvAVYnLRChYkNOEl8RcYGRomJygpKjU2Nzg5OkNERUZHSElKU1RVVldYWVpjZGVmZ2hpanN0dXZ3eHl6goOEhYaHiImKkpOUlZaXmJmaoqOkpaanqKmqsrO0tba3uLm6wsPExcbHyMnK0tPU1dbX2Nna4uPk5ebn6Onq8vP09fb3+Pn6/9oADAMBAAIRAxEAPwD9/KKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiikLKBksB9TRsAtFZmp+M/COignVfE1hb46iW7QH8s5rntS/aD+EemEiTxhDKR1ECM38hXg5hxVwzlN1jcbSpf4qkIv7m7nVRwONxH8OlKXomztKK8t1L9rr4WWSk2qX9yw6CO3AB/M1zmp/tr2C5TR/BEj+j3F4B+gX+tfEZj43+FeWfxc0pyfaClU/9IjJHp0eGc9rfDQa9bL82j3WivmvUP2zfHM7EWGg6dAO2Qzn9TWLfftW/Fy7z5OqwQenlWqcfmDXxWN+lB4YYW/snWq/4adv/AEuUT0qfBOdz+Llj6v8AyTPq6jI9a+N7/wCPnxd1EETeOb5M9RBL5f8A6DisS+8ceL9Sz/aHia/mz1827dv618ljfpb8NU/90y6rP/FKEPy5zvp8A41/xK0V6Jv/ACPtufVtLtsm51KCPHXfMo/maoXPj7wRZ5+1eLdOjx13Xqf418SPf3sn+su5D65c1GZZT1kP518xifpeY1/7vlMV/iqt/lBHbDw/p/brv5R/4J9nXXxq+FNnkT+PNO4/55zb/wD0HNZl5+0r8F7TI/4TFZCO0VrKf/Za+Qsn1oyfWvn8T9LTjad/YYLDx9VUl/7fH8jrhwFlq+KrN/cv0Z9WXP7Wnwitx+7ur+b/AK5Wf/xRFZ8/7ZHw4XIt9H1R/rEg/wDZq+YySeporwcR9KLxPrP3HRh6U/8A5KTOuHBGSR35n8/8kj6Rn/bS8HJ/qPCd+/pulQVUk/bX0b/lh4JuP+B3Sj+lfPNFeXV+kl4s1NsXCPpSp/rFm8eDsgX/AC7b/wC3n/me/wAv7bMI/wBV4FJ/3r3/AOxqvL+21e8+T4CiHpuvT/8AE14RRXBU+kL4uVP+Zjb0pUv/AJA0XCWQL/lz/wCTS/zPcW/bY1052eCLMem65c/0qNv21vE5Hy+DtPB95ZD/AFrxKiuWXj14tS3zSX/gFNf+2Gi4WyBf8uF97/zPaz+2t4s7eD9O/wC+5P8AGm/8NqeMv+hV0v8A8if/ABVeLUVm/HXxYf8AzNJ/+Aw/+RGuF8hX/Lhfe/8AM9rX9tXxaBhvCGnE+oeQf+zU5f21vFOfn8Haf+Ekn+NeJUU147+LK/5mk/8AwGn/APIB/qvkP/Phfe/8z3Bf22NfA+fwTZn/AHbhxU0f7bWo5/e+A4Ov8N43/wATXhNFbQ8fvFuG2Zy+dOk//bCXwpkD/wCXC++X+Z79F+2ypA83wJg98Xv/ANjU8f7a2lf8tfBMw/3bsf8AxNfPVFdtP6RXi5D/AJj0/WlS/wDkDN8IZA/+XX/k0v8AM+j4P20/CT8T+Er5P92ZTVyH9sf4et/r9F1JPoiH/wBmr5kor0KX0mPFan8VenL1pQ/RIxlwXkT2g1/28z6ptf2uPhNP/rW1GH132gP8mNaNn+038GbrAfxUYSf+etpIP5Ka+RaMn1r2MN9KrxHo/wASlh5+sJr/ANJqI558C5PLaU181+qPs21+OPwlvDiDx1Zc/wB9mT/0ICtK3+IvgO7x9m8Yaa+em28T/GviHccYzSrLIowrkfQ19DhvpccSx/3jLqMv8Mpx/NyOSfAOCfwVpL1Sf+R91wa9ol0N1trFrIP9i4U/yNWkkSRdyOCPUGvg6O/vYv8AV3Ui/RzVqz8WeJbBt9lr13EexjuGFfQYX6XlK6WJyl/9u1v0dP8AU5J+H8vsYj74/wDBPuiivjHTvjb8VNLAW18cajtHRXuCw/I1t2H7Ufxeshtk11JwOnnW6n9cV9XgvpYcDVrLE4SvTfkoSX/pSf4HBU4DzOPwVIv71+h9Z0V8y2P7Y3xCgA+26bYz465jK5/Kt3Tf215Rgat4KRvU29zj+ea+twP0kfCnGNKeKnT/AMdOf/tqkcFXg7Pqe0FL0kv1se+0V5Hpn7Ynw7usDUdLvrUn/ZDgfliug079pP4R6jx/wknkn0miIr7fAeK3hvmaX1fNaLv3mov7pWZ5lXIc5ofHQl91/wArneUVhab8TPh/q+P7P8X2Dk9AbgL/ADxWzBd2t0nmW1zHIv8AejcEfpX2eDzPLcwhzYWvCou8ZKX5NnnVKFak7Ti16pokoooruMgooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooqrqGuaLpMRm1TVra3UDkzTKv8zWdWtRoQc6slFLq3ZfexxjKbtFXZaorhdd/aO+Euhs0Z8SLcuvVLWMtz9elcZ4g/bQ0C3DReG/C09w3aS5lCL+Q5/WvzvOfF7w1yFP61mdK66QftH6WhzHr4bh/OcV/DoS+en52PbaMgDJNfLmt/tdfE3USRp62lkp6CKLJH4muO1/4u/EfxMCmseLb2RD/wAsxMVX8hX5NnH0rOBcGmsBh61d9NFTi/m23/5Ke/h+BM0qfxZxivm3/l+J9hal4x8KaOCdT8R2UGOokuVBH4Zrl9e/aQ+EWggh/EwunHWOziLn9cD9a+RZbq5nYtNO7E9SzE1GST1Nflua/S14mrpxy7AUqXnOUqjX3ci/A9yhwDgo61qspeiS/wAz6P1b9s/wtCSuj+F7ub0aeRU/QZrl9Z/bO8YXIKaL4dsrYHo8m52H64rxiivzPM/pB+K+Z3X1/wBmn0pwhH8bc34ns0OE8hof8ur+rb/Wx3esftIfF7WCwk8WSQq38NtGsY/QVzepePvGersW1HxNey5677hj/WsiivznMeMOK83beNx9apf+apN/mz2KOX4DDr91SjH0SHy3NxMczTu59WbNN3H1pKK+dcpSd2zsSSCiiikAUUUUAFFFFABRRRQAUUUUAFFFFABRRRQAUUUUAFFFFABRRRQAUUUUAFFFFABRRRQAUUUUAFFFFABRRRQAUUUUAFFFFABRRRQAUoYjoaSigBRIyncDz2NX7HxX4l0xt2n69dw46BLhgPyzWfRW9DFYrCz56M3F902n+BM4QmrSV/U6/S/jt8U9JK/ZvF1yQvaU7h+tdRon7X3xL04hNTgsr1B/fi2N+Yryiivssr8TPEHJmnhMzrRt0dSUl90m1+B51fJcpxH8ShF/JL8j6C0n9tSzkwus+EHT1a3mz/Oun0b9rP4Vamyx3txdWbN/z2gJA/EcV8rUZPrX6Plf0l/FLL2va1qdZf36a/OHIzx6/BeR1fhi4+j/AM7n21o3xQ+H2voH0nxdYy7h90XAz+VbUF3a3Khra5jkB6FHBr4MVmU7lJB9Qa0NM8W+J9GcSaV4hvbcr08m6dR+QNfpuVfS6xKssyytPu6dRr7oyi//AEo8WvwBB60a/wB6/VP9D7nor5H0P9pz4v6KFjbxCt2i9Fu4Fb9Rg12Ghftp67CQniDwhb3C/wAT21wUP1wQf51+pZR9J7wyzGyxMquHb/np3X303P8AI8PEcE51R+BRn6O352PoiivLdB/a5+Feq7Y9Sa906Q9RcW+5c/VCa7LQfip8OvExVNF8ZafM7fdiNyquf+Atg1+s5N4g8D8QWWX5jRqN7JVIqX/gLal+B4OIynM8J/FoyXydvv2OgooBBGQeD0or7A84KKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKjuLq1tIzLdXMcSjq0jgD9amUowjzSdkNJt2RJRXF+Kvj/APC7wmzQXfiSO4mXrDafOfzHFed+Kf2z4EQw+EvDBLdprx+PyFfm/EXi/wCHPDHNHG5jBzj9mD9pK/a0L2frY9jB8P5xjbOnRdn1ei/E94qhrHijw54fjMuta3a2wHUTTAH8utfKXiT9pD4q+Ig0beIWtY2/gtF2cfWuLvdV1LUpTPqF9LO5OS0shY/rX4ZxD9LTJaF4ZNgJ1X/NUkoL/wABjzN/ej6fCcBYmeuJqqPlFXf3u36n1V4l/ai+FXh8Mlvqct/KOiWseRn6muC8Q/to6i+6Pw14Wijz0e6kLEfgK8Kor8Sz76SnidnDcaFaGGi+lOCv/wCBS5n91j6XC8G5Jh9Zxc3/AHn+isdx4k/aJ+K3iVmFx4lkt4z0itAIxj8K5G/1vV9UffqOpzzk9TLKW/nVWivx3NuJ+Is+qOeY4upWb/nnKX4N2PosPgsHhI2o01H0SQuTjGaSiivDOkKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKUOy/dYikoou0BuaD8SfHfhnA0TxVfQKOiJcHb+XSu38N/tb/E7RiE1RrXUYx2uIdrfmuP1ryyivr8k4/414ca/s3MKtNLoptx/wDAW3F/NHn4nKstxi/fUov5a/fufSGgftmeF7vaniDw5cWx/ieBw4/I4ru/Dnxx+F/ihQNO8V26SH/llcHy2H58frXxpSh2U5ViPTFfs2Q/Sk8Qstajj4UsTHrzR5JffCy++LPncVwPlFZXpOUH5O6/H/M+8rW9s71PNs7qOVf70bhh+lS18O6H468XeHJRNoviK7t2Xp5cxx+Vd94a/a1+JOkhYtWNvqCL3lTax/EV+1cP/St4Px1oZrhamHl3japH8OWX/krPmsXwJmFLWhNTXno/1X4n1JRXjnhX9sXwdqJWDxPpFxYP3kQeYn6c16F4c+K/w+8V4XRfFNrI7DiNpArfka/ceH/ErgTihL+zcwpzk/suXLP/AMAlaX4HzOLybNMC/wB9Skl3tdfetDoaKRXR13IwIPQg0tfcJpnmBRRRQAUUUUAFFFFABRRRQAUUUUAFFFFABRRRQAUUUUAFFFFABRRRQAUUUUAFFFFABRRRQAUUUUAFFFFABRRRQAUUUUAFFFFABRRRQAUUUUAFFFFABRRRQAUUUUAFFFFABRRRQAUUUUAFFFFABRRRQAUUUUAFFFFABRRRQAUUUUAFFFFABRRRQAUUUUAFFFFABRRRQAUUUUAFFFFABRRRQAUUUUAFFFFABRRRQAUUUUAFFFFABRRRQAUUUUAFFFFABRRRQAUUUUAFFFFABRRRQAUUUUAFFFFABRRRQAUUUUAFFFFABRRRQAUUUUAFFFFABRRRQAUUUUAFFFFABRRRQAUUUUAFFFFABRRRQAUUUUAFFFFABRRRQAUUUUAFFFFABRRRQAUUUUAFFFFABRRRQAUUUUAFFFFABRRRQAUUUUAFFFFABRRRQAUUUUAFFFFABRRRQAUUUUAFFFFABRRRQAUUUUAFFFUtY8RaF4fgNzrWr29qijJM0oFY18RQwtJ1a01GK3baSXq3oVGE5y5Yq7LtFeU+Lv2tfh9obPb6FFNqUq/xRjamfqa8t8XftX/EnxBI8WkyxaZAeAluuWx/vGvxnij6QPhpwzzQWK+sVF9miuf/AMm0h/5M/Q+jwPCedY2z5ORd5afhv+B9N6z4i0Lw9AbnW9Wt7VAM5mlC5rz/AMXftV/DXw7G8elSTanOvRLdcL/30a+YdZ8Ra54guDdazq1xcuTy00paqRJPWv524n+lfxJjXKnkeEhQj0lP95P1tpFP1Uj67BcB4OnZ4mo5PstF/n+R6/4m/bC8dakHh8P6dbWCNwHI3uPz4rzjXviB4z8TStLrviS7uSx5DzHH5Cseiv5/4i8RONuK5XzTH1Ki/l5rR/8AAY2j+B9Zg8oy3AL9xSS87Xf3vUUsxOSTmkoor4w9EKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigABI6U5JHRg6Ngg5BHam0U02tgOp8N/Gn4meFdqaV4suti9Ip38xfphq9H8Jftn61aqLfxl4aiugOPtFk+xv8Avlsg/mK8Por9A4c8VfEHhWS/s/MKiivsyfPC3blnzJfJJnk4zIspxyftaKv3Wj+9WPrnwl+0v8KPFTrbNrh0+dukWoJ5Y/775X9a7qzv7HUIhPYXkU6EZDwyBgfxFfBu4gYBrS0Hxl4p8MXC3Og6/d2rKcjyZiBX79w19LPOMOlTz3Axqr+ek3CXzjLmi36OKPlMbwFh53eFquPlLVferP8AM+5aK+ZPCf7X3j3SVSDxFaW+pIvBdl2OR9Rwa9O8H/tU/DfxGixarLLplweqXAyn4MP8K/obhnx58M+J3GFPGexqP7NZcj9ObWD/APAj5LG8LZ1grt0+Zd46/hv+B6bRVTSdd0bXbcXWj6nBcoR96GQN/Krdfr1GvRxFJVKUlKL2ad0/Ro+flGUJWkrMKKKK1JCiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAoooJCjJOAOpNABRXKeMvjT8OvA8DPq/iGJ5V6W1sd7sfoK8i8b/tj6xeI9p4I0dLUHgXNz8z/gOgr8z4t8X/AA/4LUoY/GRlVX/Lun78/RpaR/7eaPay/h/Nsys6VNqPd6L8d/kfQV9qNhplu13qN7FBEoy0k0gUD8TXnnjL9qT4a+GA8On3T6lcLkBLYfLn/eNfNHibx94v8XzNN4g1+5udxyVeQ7fy6Vjkk9TX8wcWfSvznFc1Lh/CRox/nqe/P1UVaK+fMfbYDgPDU7SxdRyfaOi+/f8AI9W8YftafELXt8GhrFpkLZAMI3Pj6mvNtX8Ra5r07XOsarPcuxyWmlLVSor+bOI+N+LeLavtM2xlSr5OT5V6RVor5I+yweWYDARth6aj8tfv3CiiivlTuCiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKUEjpSUUAaGh+KvEPhu4F1oWr3Fq4OcwykD8uhr0nwf+1v490MpDr8EOpQjgl/kf8xXk1FfW8Ocd8X8JVFLKcbUpL+VSvF+sHeL+aODGZXl+PVsRTUvO2v37n1b4Q/an+GfiRkt9Qu302ZsZF2MJn/eHFeiWGpafqlut1p17FPG4yrxOGB/Kvg7Nanh3xr4s8JzCfw54gurNgcgQynbn3XofxFf0bwp9K/O8Jaln+EjWj/PT9yfzi7xfycT4/HcB4ap72EqOL7PVffuvxPuSivm/wb+2P4q09Y7Xxjo8GoIvDXEH7uQ+5A+U/k...
                                                                                                                                                                                                                    
                                                                                                    

Document Scanner - CODE SNIPPETS


    curl --location 'https://zylalabs.com/api/3977/document+scanner+api/4732/document+scanner' \
    --header 'Content-Type: application/json' \ 
    --form 'image=@"FILE_PATH"'


API Access Key & Authentication

After signing up, every developer is assigned a personal API access key, a unique combination of letters and digits provided to access to our API endpoint. To authenticate with the Document Scanner API REST API, simply include your bearer token in the Authorization header.
Headers
Header Description
Authorization [Required] Should be Bearer access_key. See "Your API Access Key" above when you are subscribed.

Simple Transparent Pricing

No long-term commitment. Upgrade, downgrade, or cancel anytime. Free Trial includes up to 50 requests.

πŸš€ Enterprise

Starts at
$ 10,000/Year


  • Custom Volume
  • Specialized Customer Support
  • Real-Time API Monitoring

Customer favorite features

  • βœ”οΈŽ Only Pay for Successful Requests
  • βœ”οΈŽ Free 7-Day Trial
  • βœ”οΈŽ Multi-Language Support
  • βœ”οΈŽ One API Key, All APIs.
  • βœ”οΈŽ Intuitive Dashboard
  • βœ”οΈŽ Comprehensive Error Handling
  • βœ”οΈŽ Developer-Friendly Docs
  • βœ”οΈŽ Postman Integration
  • βœ”οΈŽ Secure HTTPS Connections
  • βœ”οΈŽ Reliable Uptime

Document Scanner API FAQs

Document Scanner is a robust API provided by PresentID that specializes in scanning and extracting data from various types of documents. It leverages advanced optical character recognition technology to interpret and digitize textual content from documents such as passports, visas, and ID cards.

Our Document Scanner API offers the following features: Fast and accurate data extraction: Utilizes cutting-edge technology to quickly scan and extract data from documents. Support for multiple document types: Capable of processing passports, visas, ID cards, and more. Seamless integration: Easily integrates with existing systems to enhance document verification processes.

The API primarily employs the POST method, enabling users to upload images of documents. It then processes these images and returns the extracted data in a structured format.

Yes, the usage limits depend on the subscription plan you choose. For detailed information on the limits associated with each plan, please visit our pricing page or consult your user dashboard.

Some of the common errors you may encounter include: 400 Bad Request: This error indicates a problem with the input data, such as corrupted or unclear images. 401 Unauthorized: This error occurs if your API key is incorrect or missing.

The Document Scanner API returns a Base64 encoded image of the localized document along with a status message indicating the success or failure of the operation.

The key fields in the response data include `statusCode`, `statusMessage`, `hasError`, and `data`, where `data` contains the `base64Image` of the processed document.

The returned data is structured in JSON format. It includes a status code (e.g., 200 for success), a status message, an error flag, and a data object containing the Base64 image string.

The Document Scanner endpoint accepts parameters such as an image file, an image URL, or a Base64 encoded image. Ensure the image size does not exceed 8 MB and dimensions are within 50 to 5000 pixels.

The response data is organized in a JSON object. It includes a top-level status code and message, followed by a nested data object that contains the Base64 image string.

Typical use cases include creating PDF files from scanned documents, extracting text for note-taking, and digitizing books or other printed materials for easier access and editing.

Data accuracy is maintained through advanced image processing algorithms that correct for distortions and enhance document features, ensuring reliable localization and extraction of text.

Users can decode the Base64 image string to display the localized document in applications, or save it as an image file for further processing, such as creating PDFs or integrating into document management systems.

General FAQs

Zyla API Hub is like a big store for APIs, where you can find thousands of them all in one place. We also offer dedicated support and real-time monitoring of all APIs. Once you sign up, you can pick and choose which APIs you want to use. Just remember, each API needs its own subscription. But if you subscribe to multiple ones, you'll use the same key for all of them, making things easier for you.

Prices are listed in USD (United States Dollar), EUR (Euro), CAD (Canadian Dollar), AUD (Australian Dollar), and GBP (British Pound). We accept all major debit and credit cards. Our payment system uses the latest security technology and is powered by Stripe, one of the world’s most reliable payment companies. If you have any trouble paying by card, just contact us at [email protected]

Additionally, if you already have an active subscription in any of these currencies (USD, EUR, CAD, AUD, GBP), that currency will remain for subsequent subscriptions. You can change the currency at any time as long as you don't have any active subscriptions.

The local currency shown on the pricing page is based on the country of your IP address and is provided for reference only. The actual prices are in USD (United States Dollar). When you make a payment, the charge will appear on your card statement in USD, even if you see the equivalent amount in your local currency on our website. This means you cannot pay directly with your local currency.

Occasionally, a bank may decline the charge due to its fraud protection settings. We suggest reaching out to your bank initially to check if they are blocking our charges. Also, you can access the Billing Portal and change the card associated to make the payment. If these does not work and you need further assistance, please contact our team at [email protected]

Prices are determined by a recurring monthly or yearly subscription, depending on the chosen plan.

API calls are deducted from your plan based on successful requests. Each plan comes with a specific number of calls that you can make per month. Only successful calls, indicated by a Status 200 response, will be counted against your total. This ensures that failed or incomplete requests do not impact your monthly quota.

Zyla API Hub works on a recurring monthly subscription system. Your billing cycle will start the day you purchase one of the paid plans, and it will renew the same day of the next month. So be aware to cancel your subscription beforehand if you want to avoid future charges.

To upgrade your current subscription plan, simply go to the pricing page of the API and select the plan you want to upgrade to. The upgrade will be instant, allowing you to immediately enjoy the features of the new plan. Please note that any remaining calls from your previous plan will not be carried over to the new plan, so be aware of this when upgrading. You will be charged the full amount of the new plan.

To check how many API calls you have left for the current month, refer to the β€˜X-Zyla-API-Calls-Monthly-Remaining’ field in the response header. For example, if your plan allows 1,000 requests per month and you've used 100, this field in the response header will indicate 900 remaining calls.

To see the maximum number of API requests your plan allows, check the β€˜X-Zyla-RateLimit-Limit’ response header. For instance, if your plan includes 1,000 requests per month, this header will display 1,000.

The β€˜X-Zyla-RateLimit-Reset’ header shows the number of seconds until your rate limit resets. This tells you when your request count will start fresh. For example, if it displays 3,600, it means 3,600 seconds are left until the limit resets.

Yes, you can cancel your plan anytime by going to your account and selecting the cancellation option on the Billing page. Please note that upgrades, downgrades, and cancellations take effect immediately. Additionally, upon cancellation, you will no longer have access to the service, even if you have remaining calls left in your quota.

You can contact us through our chat channel to receive immediate assistance. We are always online from 8 am to 5 pm (EST). If you reach us after that time, we will get back to you as soon as possible. Additionally, you can contact us via email at [email protected]

To give you the opportunity to experience our APIs without any commitment, we offer a 7-day free trial that allows you to make up to 50 API calls at no cost. This trial can be used only once, so we recommend applying it to the API that interests you the most. While most of our APIs offer a free trial, some may not. The trial concludes after 7 days or once you've made 50 requests, whichever occurs first. If you reach the 50 request limit during the trial, you will need to "Start Your Paid Plan" to continue making requests. You can find the "Start Your Paid Plan" button in your profile under Subscription -> Choose the API you are subscribed to -> Pricing tab. Alternatively, if you don't cancel your subscription before the 7th day, your free trial will end, and your plan will automatically be billed, granting you access to all the API calls specified in your plan. Please keep this in mind to avoid unwanted charges.

After 7 days, you will be charged the full amount for the plan you were subscribed to during the trial. Therefore, it’s important to cancel before the trial period ends. Refund requests for forgetting to cancel on time are not accepted.

When you subscribe to an API free trial, you can make up to 50 API calls. If you wish to make additional API calls beyond this limit, the API will prompt you to perform an "Start Your Paid Plan." You can find the "Start Your Paid Plan" button in your profile under Subscription -> Choose the API you are subscribed to -> Pricing tab.

Payout Orders are processed between the 20th and the 30th of each month. If you submit your request before the 20th, your payment will be processed within this timeframe.


Related APIs


You might also like