Upload a file for OCR

POST

/ocr_tasks/upload_from_file

Headers

Auth

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

x-monite-versionstringRequired

x-monite-entity-idstringOptional

The ID of the entity that owns the requested resource.

Query parameters

document_typeenumOptional

Allowed values: invoicecredit_notereceipt

Request

This endpoint expects a multipart form containing a file.

filefileRequired

Response

OCR task has been accepted for execution.

idstringformat: "uuid"

created_atdatetime

updated_atdatetime

statusenum

Allowed values: processingsuccesserror

document_typeenumOptional

Allowed values: invoicecredit_notereceipt

recognized_dataobjectOptional

Errors

POST

1 curl -X POST https://api.sandbox.monite.com/v1/ocr_tasks/upload_from_file \
2      -H "x-monite-version: 2024-05-25" \
3      -H "x-monite-entity-id: 9d2b4c8f-2087-4738-ba91-7359683c49a4" \
4      -H "Authorization: Bearer <token>" \
5      -H "Content-Type: multipart/form-data" \
6      -F file=@<file1>

202Accepted

1 {
2   "id": "id",
3   "created_at": "2024-01-15T09:30:00Z",
4   "updated_at": "2024-01-15T09:30:00Z",
5   "status": "processing",
6   "document_type": "invoice",
7   "recognized_data": {
8     "type": "invoice",
9     "recipient": {
10       "address": {
11         "street_and_number": "street_and_number",
12         "city": "city",
13         "postal_code": "postal_code",
14         "country": "AF",
15         "state": "state"
16       },
17       "bank_account": {
18         "bank_account_number": "bank_account_number",
19         "iban": "iban",
20         "swift_bic": "swift_bic"
21       },
22       "vat_number": "vat_number",
23       "tax_number": "tax_number",
24       "email": "email",
25       "name": "name"
26     },
27     "sender": {
28       "address": {
29         "street_and_number": "street_and_number",
30         "city": "city",
31         "postal_code": "postal_code",
32         "country": "AF",
33         "state": "state"
34       },
35       "bank_account": {
36         "bank_account_number": "bank_account_number",
37         "iban": "iban",
38         "swift_bic": "swift_bic"
39       },
40       "vat_number": "vat_number",
41       "tax_number": "tax_number",
42       "email": "email",
43       "name": "name"
44     },
45     "amount_paid": 1.1,
46     "currency": "AED",
47     "document_number": "document_number",
48     "due_date": "due_date",
49     "issue_date": "issue_date",
50     "line_items": [
51       {
52         "line_reference": "line_reference",
53         "name": "name",
54         "description": "description",
55         "quantity": 1.1,
56         "unit_price": 1.1,
57         "unit": "unit",
58         "subtotal": 1.1,
59         "tax_rate": 1.1,
60         "tax_amount": 1.1,
61         "total_amount": 1.1
62       }
63     ],
64     "payment_terms": "payment_terms",
65     "subtotal": 1.1,
66     "tax_amount": 1.1,
67     "tax_rate": 1.1,
68     "total_amount": 1.1
69   }
70 }

Get an OCR task by ID

Up Next

1	curl -X POST https://api.sandbox.monite.com/v1/ocr_tasks/upload_from_file \
2	-H "x-monite-version: 2024-05-25" \
3	-H "x-monite-entity-id: 9d2b4c8f-2087-4738-ba91-7359683c49a4" \
4	-H "Authorization: Bearer <token>" \
5	-H "Content-Type: multipart/form-data" \
6	-F file=@<file1>

1	{
2	"id": "id",
3	"created_at": "2024-01-15T09:30:00Z",
4	"updated_at": "2024-01-15T09:30:00Z",
5	"status": "processing",
6	"document_type": "invoice",
7	"recognized_data": {
8	"type": "invoice",
9	"recipient": {
10	"address": {
11	"street_and_number": "street_and_number",
12	"city": "city",
13	"postal_code": "postal_code",
14	"country": "AF",
15	"state": "state"
16	},
17	"bank_account": {
18	"bank_account_number": "bank_account_number",
19	"iban": "iban",
20	"swift_bic": "swift_bic"
21	},
22	"vat_number": "vat_number",
23	"tax_number": "tax_number",
24	"email": "email",
25	"name": "name"
26	},
27	"sender": {
28	"address": {
29	"street_and_number": "street_and_number",
30	"city": "city",
31	"postal_code": "postal_code",
32	"country": "AF",
33	"state": "state"
34	},
35	"bank_account": {
36	"bank_account_number": "bank_account_number",
37	"iban": "iban",
38	"swift_bic": "swift_bic"
39	},
40	"vat_number": "vat_number",
41	"tax_number": "tax_number",
42	"email": "email",
43	"name": "name"
44	},
45	"amount_paid": 1.1,
46	"currency": "AED",
47	"document_number": "document_number",
48	"due_date": "due_date",
49	"issue_date": "issue_date",
50	"line_items": [
51	{
52	"line_reference": "line_reference",
53	"name": "name",
54	"description": "description",
55	"quantity": 1.1,
56	"unit_price": 1.1,
57	"unit": "unit",
58	"subtotal": 1.1,
59	"tax_rate": 1.1,
60	"tax_amount": 1.1,
61	"total_amount": 1.1
62	}
63	],
64	"payment_terms": "payment_terms",
65	"subtotal": 1.1,
66	"tax_amount": 1.1,
67	"tax_rate": 1.1,
68	"total_amount": 1.1
69	}
70	}