Get document plain ocr text

GET

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

GET

/documents/:id/text

1 const url = 'https://api.invofox.com/documents/id/text';
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     "Invoice #12345\nDate: 2024-04-15\nCustomer: Acme Corporation\n\nItem Description       Qty    Unit Price    Total\n-----------------------------------------------------\nWidget A               10     $15.00        $150.00\nWidget B               5      $25.00        $125.00\n\nSubtotal:                                $275.00\nTax (10%):                              $27.50\nTotal:                                  $302.50\n\nThank you for your business!"
4   ]
5 }

Authentication

x-api-keystring

API Key authentication via header

Path parameters

idstringRequired

id of the document to get

Response

Document ocr text by id

resultlist of strings

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