Get document ocr info

GET

https://api.invofox.com/documents/:id/ocr

GET

/documents/:id/ocr

1 const url = 'https://api.invofox.com/documents/id/ocr';
2 const options = {method: 'GET', headers: {'x-api-key': '<apiKey>'}};
3 
4 try {
5   const response = await fetch(url, options);
6   const data = await response.json();
7   console.log(data);
8 } catch (error) {
9   console.error(error);
10 }

1 {
2   "result": [
3     {
4       "page": 1,
5       "angle": 0,
6       "width": 8.5,
7       "height": 11,
8       "unit": "inch",
9       "lines": [
10         {
11           "boundingBox": [
12             0.5,
13             10.5,
14             7.5,
15             10.5,
16             7.5,
17             10.8,
18             0.5,
19             10.8
20           ],
21           "text": "Invoice Number: INV-20240615-001",
22           "appearance": {},
23           "words": [
24             {
25               "boundingBox": "0.5,10.5,2.5,10.5,2.5,10.8,0.5,10.8",
26               "text": "Invoice",
27               "confidence": 0.98
28             },
29             {
30               "boundingBox": "2.6,10.5,4.0,10.5,4.0,10.8,2.6,10.8",
31               "text": "Number:",
32               "confidence": 0.97
33             },
34             {
35               "boundingBox": "4.1,10.5,7.5,10.5,7.5,10.8,4.1,10.8",
36               "text": "INV-20240615-001",
37               "confidence": 0.99
38             }
39           ]
40         }
41       ]
42     }
43   ]
44 }

Authentication

x-api-keystring

API Key authentication via header

Path parameters

idstringRequired

id of the document to get

Response

Document ocr info by id

resultlist of objects

Array of pages read

Errors

400

Bad Request Error

403

Forbidden Error

404

Not Found Error

429

Too Many Requests Error

500

Internal Server Error