About the API:
This API will extract all the data contained in any ID you pass to it into a structured JSON response. This API uses Object Character Recognition to provide the response.
Just pass the URL of the document you want to analyze. Receive a JSON response with all the information contained in a structured way.
Get the image of the signature and the profile picture.
Get name, surname, address, date of birth, expiration date, issuing date, document number, sex and all other data that is contained in the ID.
Standardize your information: Receive standardized data to store it in your databases.
Data validation: Be able to extract relevant information about the ID. Be able to verify if the person is old enough, be able to verify if the name of the person matches the information you have stored, corroborate that the ID is not expired, and more.
This API is ideal to make security validations.
Besides API call limitations per month, there are no other limitations.
Extract structured text, portrait and signature from ID documents, such as driver’s licenses, passports, ID cards, permanent residence cards, etc. Multiple national ID documents are supported.
ID OCR - Endpoint Features
| Object | Description |
|---|---|
inputurl |
[Required] "inputurl" is the priority parameter,ensure images can be viewed properly.The speed of returning the result depends on the speed of the URL. |
{"code":"200","status":"SUCCESS","data":{"position":{"left":7,"bottom":6,"right":527,"top":333},"countryName":"United States","documentName":"Enhanced Driving License","errorCode":0,"nation":{"authority":"","givenNames":"SAMPLE, LICENSE","name":"DOCUMENT SAMPLE, LICENSE","nationality":"","placeOfBirth":"","sex":"F","surname":"DOCUMENT","surnameOfSpouse":""},"ocr":{"height":"?-0","dateOfExpiry":"2016-10-1","eyesColor":"BROWN","name":"DOCUMENT SAMPLE, LICENSE","addressState":"NEW YORK","issuingStateCode":"USA","dateOfBirth":"1985-6-9","dateOfIssue":"2008-9-30","sex":"F","dLClass":"D","dLRestrictionCode":"NONE","dLEndorsed":"NONE","surname":"DOCUMENT","addressPostalCode":"12345","addressJurisdictionCode":"NY","addressCity":"ANYTOWN","addressStreet":"2345 ANYPLACE AVE","address":"2345 ANYPLACE AVE^ANYTOWN NY 12345","givenNames":"SAMPLE, LICENSE","documentNumber":"012345678"},"portrait_rect":{"bottom":351,"left":21,"right":223,"top":104},"image":{"portrait":"/9j/4AAQSkZJRgABAQEAxwDHAAD/2wBDAAUDBAQEAwUEBAQFBQUGBwwIBwcHBw8LCwkMEQ8SEhEPERETFhwXExQaFRERGCEYGh0dHx8fExciJCIeJBweHx7/2wBDAQUFBQcGBw4ICA4eFBEUHh4eHh4eHh4eHh4eHh4eHh4eHh4eHh4eHh4eHh4eHh4eHh4eHh4eHh4eHh4eHh4eHh7/wAARCAD3AMoDASIAAhEBAxEB/8QAHwAAAQUBAQEBAQEAAAAAAAAAAAECAwQFBgcICQoL/8QAtRAAAgEDAwIEAwUFBAQAAAF9AQIDAAQRBRIhMUEGE1FhByJxFDKBkaEII0KxwRVS0fAkM2JyggkKFhcYGRolJicoKSo0NTY3ODk6Q0RFRkdISUpTVFVWV1hZWmNkZWZnaGlqc3R1dnd4eXqDhIWGh4iJipKTlJWWl5iZmqKjpKWmp6ipqrKztLW2t7i5usLDxMXGx8jJytLT1NXW19jZ2uHi4+Tl5ufo6erx8vP09fb3+Pn6/8QAHwEAAwEBAQEBAQEBAQAAAAAAAAECAwQFBgcICQoL/8QAtREAAgECBAQDBAcFBAQAAQJ3AAECAxEEBSExBhJBUQdhcRMiMoEIFEKRobHBCSMzUvAVYnLRChYkNOEl8RcYGRomJygpKjU2Nzg5OkNERUZHSElKU1RVVldYWVpjZGVmZ2hpanN0dXZ3eHl6goOEhYaHiImKkpOUlZaXmJmaoqOkpaanqKmqsrO0tba3uLm6wsPExcbHyMnK0tPU1dbX2Nna4uPk5ebn6Onq8vP09fb3+Pn6/9oADAMBAAIRAxEAPwD3z+0L8jm9lI/Ck+23va7l/EioOB0FIa1Miyb6+PW8k/MUn26+/wCfyT8xVeikBY+23v8Az+SfnQb29IwbyTjnrVeg8UwJ/tt5jm7lP/AqDe3jfeupf++qhwe3J9KFDHIAJP8AKgZMLu6U5FxKDSi/vhwLyYjqeapapd2mlWjXep3UVnAgyXmYKP1ryvxT8ePCFjHJFory6pdqcAquEH+NRKcVuUoN7HsS399/z9zc9s0v2zUGAxdzZPAGa+UfEHxq8cX87Npd7DYwbsAJHlse/NY138R/iFeQhZfEl5sHJMKbT+fNY+3ia+wkfY5utRxlrqfjnNMF3dg4F1J653V8WR/Evx/YuHj8QakMcYkIIP6V0mi/tB+NNPlB1K1tdUhxgq0ZRv8AvrJ/lVKvHYToS6H1g99fHrdy4+tIt5dJwl1Jz1+avGfCv7QXg7U2SHWre70WXozuPMiz9eMV6po2qaZrVl9s0e/t763IyHhbdirUovYzcJI0TeXZOTdTf99U5by8XgXU3/fVV+NuaPwqySwby9/5+Zf++qPtl5kE3MvH+1UGaM0hE32u7DFhdSgn/aprXVy5BN1ISP8AaqKg00BObu6IwbiXHpu4pnnTnpO//fVR/jS5NA2Sm8u9pUXcvH+1W9bSTtbxkyyklAc7vaubPQ1u28zi3jATOEHf2osCZhUUUUCCiiikAGlGegGT2FA68V5H8fPiwPBsJ0TRtratMuWkLf6kEdh60Skoq7KjHmdjp/iT8TfDHga3ZdQmF1qJXK2kTfN/wL0r5r8W/HPx94iu3On3o0WzzhIoT82P97/61ecarqd3qt7LqF/O01xIxLvI2ST9aNORp5B8ue1YSk2bqMUbWoXuua64m1TU7u/dRyZ5S2PpT9LOnWyItwzSbSfl6Z/Grtta+TYXBUAMIyea5y1ZFuBJO2cHgbeBWF+Y6FHlOyXVLfIe0s1VM/Lg5/Ori6tO5VREGXGMKtc4k0w2/ZY7lyRyF+Vf51ZVWkkBezmUKOSJdxzUctzRSt0OotbwSIscgZWY4G5KbqGjLJCzrHDMSc5K4ArMttS0qz2b7+/tnUdCGYflUtxqdpOn+haqkzk5O2MqxHfPrT9myedMwdQsrZJnDoUwfXjPtTdFv9X0G7F9oGpXFnMDw8EhH5+tT6jfRvM68MB/Dt2t+VZEkkCEmMspBzx2/CkotDbTPoj4afHiO58uw8cRrBIflS/hHyk/7a9vrzXuUEsNxbpc280c0Ei7kkQ5Vh6ivgF7sN/rlHzcFuoP1r0X4S/FfVvBEsVncyNfaEzYktictD/tR5/lxW9OrJaSOepRT1ifXf4GiqPh7WdL8Q6PDq2jXkd3ZzDIZeqn0I7Grx4OK6uhyNWCiiigQUUUUAI33TW/bMgtogR/AP5Vgnoa3Lbb9nj/AHX8A7+1O5SMOiiigkKKUdeahvbq3sbKe+vJFitrdDJK7HgAUAcX8Z/H0HgPwu12nlyancZS1jJ/8e/CvinX9UvdX1OfUdQupLm7nYtJK5ySa6b4weNbrxt4tuL+SRjbKxS1j7Kma4WSUxnaQSRxzzXM7ydzpS5VYsW6fNgqGz3Paul8PW+6dVVXcj0FcxbM7HJPNd34NWOQIrS7XweASCfyqKrsjWirs6e60+MeE5XePDM+Pm715vLEGuCkRb738PGK9k1eB5fDSW4Xc7EbVP8AOvMdbs7e0mMImZ2HBKcAH8K5aU9TsrQ90q20pVyhuT9Gc4FaOnSrHIQlxEOPlKhuD+VYdrbRlyVhZsevetq3tN0a+XJNErDB2g8Vu7HPG50tpqLR482/imDjDLKhOPzFMl0jzS89hLab35JwBg9fSoLSzuUxucOpxhmQEj86v3kUcenu0kcJfBAZHILH6DgULTqErPocJ4gg1RLp1u4h8nWUKCD+VYTzOBmRirDvmt2+u5FldLe7lTnmKXkfgaxb2ZJZD5sIjc9SMYP5cVa8zJ2WxGJwy8t96pbeZoeSMr1//VWfNEMbo2wB1pkdwQdr5x71fImhczR6l8KfiBqXgXV0vbCb7RptwcXlix+Ug9WUdAw9frX2L4e1fTte0a31jSpxPaXCBhg5KHup9CK/O+KVojvQ8fyr2f8AZw+I48MeIF0q/uD/AGRqLbGBPyxSHo3tzgGiMnTdnsE4Kor9T647e1JS8YBDKy4BVgeGBGQRSV0s4wooopAB6H6VsW5T7PH977g/lWOeh+lbNvn7PHz/AAD+VAzGooopiCvC/wBrnxiNO8NW3hKzuCl1fN5l1tPIjHQH6817qpQAtIwWMAl2PQAdTXwh8aPFC+KviPq+tRuTbb/JgDdlX/8AWazntY1pLqcXcSbMbT83b2quN7HIGT3pMmR8nOW71p6Vp0txMEjQsaltQWppGLqPQjsLO5uGVlUkA16j4F0h48SS7cjkDIzVXw74MvpkWSQbU744zXovhvwjLEVJQ/VielebXxKloeth8G4q7NSWyjvNGWMAxtyM98e2K5XxB4QupS40+ySOJVBLsMsx9a9V0rScRmOGNi2OpHFb0OmOqgTIpypVgF61yKrY9BYe61PnwfDXWYLY3DN8zZIVcdKzToOrWbmNmARf4i1fT50pXwkgKxY5UD71YWu+E0vrcSwxHYEOEUDINaqu2ZTwqseAxpMkJMhlaN+N2CQPyqG9sx9k8y3nBPcBs5/A16JdeAdUtXM8JcxnnYSOK5vxH4avYrRpI7NkbPGDzW8asepyzw0uiPKtZhAZg+QSe4rCm3R+47A1v+IFurdyk6SxkHneP61z0r598da66TutDz6seV6ogL88HHqKa+JRwNrDtRKFPK8VExIP9a3SOZj45Ch2tyO9WoH8rDKcKT19DVMnf8wGGHX3pY5CCUYZUjpQ0mOMmj7T/Zo8dDxV4OGi30wfVNJGzLHmSI8g/hkj8K9YxXwj8FPGbeDPHVhqsjH7GWEV2AesbcE/gCTX3XBNBcW8VxA++GVQ8TeqnpTpt2syKiV7jqKKKsyA9DW/bKPs8Xyn7g/lWAeh+ldBbIPs0X7xvuDv7Um7dSoq5z9KDg0h60fnVknG/G3X08NfCzW9R3lZJLdreEj++4Kj+dfBVy5bCDnGSx9Sa+sP2zdXa28I6RoiEYvJ2mcd8Jgj9Qa+SpZO46sfyrJu8jVfCvMt6bCbm6jgjGSxwK92+HfhGzsLMS3KeZOwzz2ryz4Z6fHNrEckoBC8819EaDCmzKjIxXnY2o17qPXy+ircxf06wD7F2BEXsK6extUjQPkHPArPtEAC8VrWi5cH0ry2z24pG1pyjaPlH4VpoEU/MuazbToMVoBhjnNI0ROHjB3+XuI6CmKV2suAEbqDTAQTU23oO1NITK89lazhVZMqPfiq11oenyR7Xtwy1cmDBxSvkL1/CqcmLlRwvij4b+G9YgdJbdkdlwCuOP0r5/8AiP8ABfW9HMl5ohN9bdSv8Qr62YZFUNRt1kjJ9KqnWnTehjWw8KqtJH563KzQTNDPGUkQ4YMMEVEXPQcivqz4rfDDSPEYe4t0Sz1IZKzKOH9iK+a/FXhbWPDd40GpW7IAcB1GVP417FDEwq+p89isFOg9NUYoO08dKeDnmowecfzoBKng5FdJxFiCTa2H6d6+2P2Y/FP/AAkfwwgtppd97pTm2lBPOzgqf1I/CviQ4IDr2r2v9kjxQui/EZtHuJdtrrUSxDngSAnb/wChUk7O5W8bH2DRSkYJFJWpgDfdP0rpLRR9li5/gX+Vc03KnPpXQ2vn/ZosMgGwY/KomuYuLsc/S9eKSnINzAe9XclbnyV+2fqXn/EOy05W/wCPPT13DPRizH+RFeBjsT6V6Z+0vqB1D41eIGzkQskQ/BF/xrzWYYcKPTms0a+R33wsVTfq8h6HBr6A0MgABB8uK+dPhvMTfRx5x82T719DaRMBGpXjjNeRjfjPdwD/AHaOrtNuzpWlZ44rK0990YJIGa2bZcAYIOa4GeqjWsmUDGMVfj3NxiqFqM7eORWihyfSg0QrLtGe9SRn5ORTQRnaT1pyYXI604iY9gCuSMmopEIGe1SZo/h56VUiUV5VwgZT9ao3bnjHFX3wQVFUrmPgkioKuc9qEQ3FzyT7Vzut6RZ6pZyWt9bxzQkfdZc4rrb2HI6Vj3a4Q4oTsZtJ7nzb8RvhX9g8zUdAJ2qSzQMO3tXlEm5HZJFKsDggjoa+v9Zj3I6kAgjnNfN3xR05LXW3lRNquewr1sHiXP3ZHg4/Cxh78TlLfhwD0JrQ0TUZNF1ux1OElZLS4WZDnoQazY85HPXoadctvCKOWIxXoNHl3sfpJpV9Hqek2epwndHdQLKp+oqzXA/s76p/avwa0KZpA8kEZgb224/xrvz196tPQhoa3StGMzeWuIWIwMfNWe3Q4roLYgW8X7sH5Bzn2q4T5ehnKHMtzn6fCcSqT0ByaZUd5KsFhdTt0jgkf8lJqHoi1ufn18UbptU+JmuXKZZp75lAHthf6Vz14uJdoGQOv1r0LwJa295491PVbu0e6jt5JJGRU3Y3M3OPauX8d21tb69crZsDCTuQYx165rnjVXPyeR2SotUvaeZt/CaAyak0gGdgzXu+kn5UB4GK8X+B8fmXV0BncAo/nXreoS39uiwadB5lxIQu44wg9a83F61bHqYF8tJM7ayvbS0tjNdToir0BqzbeK9KCBzKNpOBn/Cuf0jwfY3GyXWru4u5QMlRIVQH6AitLUfAfh65t/3U09v/ALkhJ/WsYxj1PR5pNHTaZ4j0y7f/AEedQQ3PIrpbeWOW3MsbKwr52174f3Gm7ptB1mdjncFmkIOfrVDw5418YaBdC1v5TlH5DjcrD61bpxa0Zn7acXaSPpgEhunWnxuQcHpXF+GPGMWo2kU0wWOSQhdh/pXTw3yOwDALniuWUXE64yUtUaispFB578e9Uri8S2hMhwRWPqniOCC1M0jFAOnvVJXBuyuzelUINzuoHrmsXU9asrbKy3EOf4QZMZryDxp8TNSnuns9NhkjjA5fbyTXP6T4f17xMUudUu5LWJiepO78AK3hSSV2ck67k7RR65qfi7TViVFIYk4O1s1Xt9asry2KlkSTHQ1V8NeDPDulJu2y3U5GPMmkY/pnFN1nw9ptwXePdBKfuujf0qJKOyKiqlrmXrTDLENxjjFeI/GC1DW/2gjDK3Nep+Vq9hdtY3zR3NseYph1H1rgfjREI9ELAZLMOfxq8P7tVHJiXzU5cx41Dhm2mlMTpceW3UdKv+GLBNQ1SO3lcJH1ZicYFdr490uzj8K2l9aQuslvNs814igcHGOSOe9etOqozUe55FLCyqUnU6I95/Yzu2l8Aarp7kE2l6CAT0Dg/wDxNe418yfsW37JrfiHTi/yTxRyge43f419OHrW0XoctRaiE4Fb0DnyI/lX7o/lWCc44rZgvrRYI1KMSFAJx7VVrkXS3MasnxrM0HgvWpVwCtlLgn3QitYdK47403v2P4a6qd+0zKIf++iB/WlP4WVTV5I+YPgBeLbfEz7LMQUv43i+rckfqa474rJGfHmpiNNiB+FHAByaueGWk07xbYXsLFTBcowI/wB4Vu/GXw3PB4nnvShaOdFcEDrnNcLtCqpPqj1feq4dwXR3LPwBtR5d7ORglgP517DEpV95T9K88+C1oLbTSGXJZhuwMV7TbaetxbDylwe5IrhxE/3jZ3YSlamkYz6mkEBZjgAZxXLa34ykt7driS6jtYOQAxyz/QVt+KtP1FIZI7KNDKQdrMOBXH/D/Q9M07xN9u8VrJqNxu+Tf/q4j6gdOKiioyl7zsdVac4QvFXMeL4leHTI0eqTanvD4yYmAI+gGa6PTJ/DXiBJbvRL77R5QGbef7zZ/u964L4g+FNftPGd7qWiBbq1ud/lyrEGQIy4Ix2PWvX/AIR+GdC0X4az2etSwx6jdP5kQXHmxHHBPv7V3ulStozzPb1+a8loQaTaLC0U9pL+5J5U9VI7V6XoifaY1IBLe9cdYW0Ug3pnGAHJGNzeuK7bwgfL25XofWvNk9bHs0k7XE1uGaFyuG2gdDXE6vtvZSjkhY89+K77xjKPmKt94cCuAu4gVwwkKyNhto5+tNMqomldnG6td6Pp0M9xPPHBBEfnfbukc+gH/wBasZviT4RNylraXt/nYMuRwCfwr0/V/D/hi6+H+p6LbSRDVZl3iWcYZj/dGelfPmm+B/FN1qFnaX1v5FjbuUimkj2qFzySe9d8aNO2rueLOtWc/dVj1fS/Fa3A3adqKX8K8MDwVNbcesedCGCkHuPSuX8b+H9GvLiK48MGS31OOJVeWA4jk+o71qeE9O1h7UR6ltaXuyriuSvBQejO/D1Kk4+8i5O5mfPt6V5r8c1J8OKQOjj+dezto7xRb3bAA6Yry/4tWi3GgzxbclTmooz/AHiZli6b5GeafBCwt77xbJFdRb1W3JGeg6813/7Tl7Z2lro/huzjUNj7RJt7KcBR+YNZvwD0Gb+3Ly8KkRC1I3H8a5/4tTyar4zudQkbcHAWPn7qjPH869G6nXuuhxrmpYTke7O5/ZC/dfEEIFH73T3JA74K/wCNfV5Ofzr5O/ZWxH8TLFvM5a0mQj8Ur6w5rrpO6fqeVX+JegZxzWvDaztCjB1wVBFZDcA9fwragjn8iP5CflHP4V0RlynNOkqm7Mb0rzL9pCbZ4Jhth/y0nDN9BXpn17V5B+0ncA2lnZ78DyyxHvk1hWfuWOiirzR85WkTGYuGUOkgJ/A5Fe3/ABMt7fVfAFlf21s+/wAtfMkx3FeSWMC/YrmYk9c59OMV6t8K76HXvDcdpKGmEcbRXEf90jo36/pXBiU3Zroevg5KN0+pkfDxQkCY4xwa9c0yQLAEyc4615P4WQW+qz2qNlI52XPtXqWknIAA6jmvPq6u56WGtqap06O5QEnLGsy88LrMzFbfJbuBXQ6aMKfWr+5wuAKxTsdbjc4BvC3lLloRsB6H1q5FZLbuZdiluxxnFdTcrlSWHJrIuoJCuVStPaWFGi30MoRneXY/Mxzitrw8z78ngCs5o/LXe/X0q9pBIGAcZqbm8IW0JPEq+YAy9j1rm4lxco6kqwPWul1ZGAK/w461z4j/AH/ymi46kFezNKS3S7QsqjzMdcfrWNc+HGlnA2bucgbu9dLp8Luq5GB61f8As8md0bbsCq9qYOg0cna+GWhwy2+0gYZs9PpW1a6bHBCAyAt61sojqgEq8darXkgUYHTtms3NyH7NpGRqI2wspHGK8i+ISgW1wMZBHSvXNSbMRDEcCvLvEMC3uswWzpvR5lBX15FaQVmcle1tTW8NRW/hf4YvfLGqTT2rBS3UsxIFeMeL7dJpg4xuMJ6Dua774sas9pb2Ogux3QHcYl6KucgVzWt232i3jkgOWIU4r0sPtc8zFy5mrdDU/ZmiSD4jWPy7mCSDPpkr/hX1cRjjOa+cvgHp6W/ju1aNCXERycdM4z/Kvo1vvHpiu2hs/U8vE7r0Gt9010Fuh+zx/MR8g7e1YB6HjNdBbg/Z4/34HyDjA9K1fqc69DA5Oa8E/aKuxJ4hgtQ5CgDP5V72Bz7DnNfMvxpvfO8ZHMgKh+mO2ayrvRI6MOryucZGFTSZlA+Vk5Yj3Oa3f2etft9L8dy2Fy3y6km2PnguM8fjmsG6mjXS5MfdIfiuOmeZZI57ORop4nDxOhwVYdCK55RUtGdik4K6PetQjjsvG9z5S7FmPmBewya73RZBs39jXg/hPUvEf/CV32l+KpD9usiIyrEEj6kE17PoVx+4UAivPq03B2Z6eEqKfvLqdzYHKgg44rUjK7cnntXOWNyQi7uh4rUS8RMl8bRXM1qetHYuSxAfM3A96wPEN/HFEDFxzjiq2ra3LNci2gfjPQdhWdrcqR6cJpD/AKt9zU2lcpydh04uHVAB8zHvW5psDAqCRkDmsSPUoJlSdXUoRnIPSt/TLm2YrIj5JpNWQqMtSW9hBXYWPIPWuVuUlju32c7OT7iuyvpo0i82VgECk5ribvVoGmlljcbACC1EUOtK513h65Sa3jdl6j8q2vKVXV0+5nmuF0a5lWxjlhy27Jx+NbOn6yATFISD3FPS5F2zamzhueD0rHvwTyTxVua5DxYHXOQazLi43xkuelS1qU3oZOquIo2JPGK4ewMc3jKz3/dWQuT9BXSeIboCJhkmvIPHGtatpM1rPo8oiunlIDEZOAOwrelD...
curl --location --request POST 'https://zylalabs.com/api/425/id+document+ocr+api/325/id+ocr?inputurl=https://static01.nyt.com/images/2008/09/16/nyregion/license533.jpg' --header 'Authorization: Bearer YOUR_API_KEY'
| Header | Description |
|---|---|
Authorization
|
[Required] Should be Bearer access_key. See "Your API Access Key" above when you are subscribed. |
No long term commitments. One click upgrade/downgrade or cancellation. No questions asked.
The API can recognize various types of ID documents, including passports, driver's licenses, national identification cards, and more.
The API utilizes Object Character Recognition (OCR) technology to extract data from ID documents. It analyzes the text and image elements to provide a structured JSON response.
Yes, the API supports multiple languages and can extract information from ID documents in different scripts, including non-Latin scripts like Cyrillic, Arabic, Chinese, etc.
The API provides a comprehensive JSON response that includes data fields such as name, surname, address, date of birth, expiration date, issuing date, document number, sex, signature image, profile picture, and more.
While the API focuses on data extraction, it can assist in security validations by providing relevant information from ID documents. However, it does not independently verify the authenticity of the documents.
Yes, by extracting the date of birth from the ID document, you can calculate the age of the individual and perform age verification checks as per your requirements.
The API returns structured data extracted from ID documents, including personal information such as name, surname, address, date of birth, expiration date, issuing date, document number, sex, and images of the signature and portrait.
The response data is organized in a structured JSON format, with key sections for personal details, OCR data, and image information. Each section contains relevant fields, making it easy to parse and utilize the extracted information.
Key fields in the response include "name," "surname," "address," "dateOfBirth," "documentNumber," "sex," and images for "portrait" and "signature." These fields provide comprehensive details about the ID holder.
The API provides information such as personal identification details (name, address, date of birth), document specifics (document type, issuing date, expiration date), and visual data (portrait and signature images) from various ID documents.
Users can customize their requests by specifying the URL of the ID document they wish to analyze. The API processes the document and returns a tailored JSON response based on the extracted data.
Typical use cases include identity verification, age validation, data standardization for databases, and security checks for compliance in various industries such as finance, travel, and law enforcement.
Data accuracy is maintained through advanced OCR technology that ensures precise extraction from ID documents. Regular updates and improvements to the OCR algorithms also enhance the reliability of the extracted data.
If the API returns partial or empty results, check the quality of the input document (e.g., image clarity, completeness). Ensure the document is supported and properly formatted. You may also retry with a different document if issues persist.
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.
Service Level:
100%
Response Time:
482ms
Service Level:
100%
Response Time:
1,062ms
Service Level:
100%
Response Time:
6,346ms
Service Level:
100%
Response Time:
5,038ms
Service Level:
100%
Response Time:
7,565ms
Service Level:
100%
Response Time:
1,207ms
Service Level:
100%
Response Time:
3,190ms
Service Level:
100%
Response Time:
211ms
Service Level:
97%
Response Time:
678ms
Service Level:
100%
Response Time:
1,858ms
Free Sign Up
