Get an OCR task by ID

GET

/ocr_tasks/:task_id

Path parameters

task_idstringRequired

Headers

Auth

AuthorizationstringRequired

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

x-monite-versionstringRequired

x-monite-entity-idstringRequired

The ID of the entity that owns the requested resource.

Response

Successful Response

idstringformat: "uuid"

created_atdatetime

updated_atdatetime

statusenum

Allowed values: processingsuccesserror

document_typeenum

Allowed values: invoicecredit_notereceipt

recognized_dataobjectOptional

Errors

GET

1 curl https://api.sandbox.monite.com/v1/ocr_tasks/task_id \
2      -H "x-monite-version: 2024-05-25" \
3      -H "x-monite-entity-id: 9d2b4c8f-2087-4738-ba91-7359683c49a4" \
4      -H "Authorization: Bearer <token>"

200Retrieved

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": "receipt",
9     "line_items": [
10       {
11         "line_reference": "line_reference",
12         "name": "name",
13         "description": "description",
14         "quantity": 1.1,
15         "unit_price": 1.1,
16         "unit": "unit",
17         "subtotal": 1.1,
18         "tax_rate": 1.1,
19         "tax_amount": 1.1,
20         "total_amount": 1.1,
21         "discount_amount": 1.1
22       }
23     ],
24     "sender": {
25       "address": {
26         "street_and_number": "street_and_number",
27         "city": "city",
28         "postal_code": "postal_code",
29         "country": "AF",
30         "state": "state"
31       },
32       "bank_account": {
33         "bank_account_number": "bank_account_number",
34         "iban": "iban",
35         "swift_bic": "swift_bic"
36       },
37       "vat_number": "vat_number",
38       "tax_number": "tax_number",
39       "email": "email",
40       "name": "name"
41     },
42     "currency": "AED",
43     "discount": 1.1,
44     "document_number": "recognized_data",
45     "issued_at": "2024-01-15T09:30:00Z",
46     "subtotal": 1.1,
47     "tax_amount": 1.1,
48     "tax_rate": 1.1,
49     "tax_type": "recognized_data",
50     "total_amount": 1.1
51   }
52 }

Get PDF templates

Up Next

1	curl https://api.sandbox.monite.com/v1/ocr_tasks/task_id \
2	-H "x-monite-version: 2024-05-25" \
3	-H "x-monite-entity-id: 9d2b4c8f-2087-4738-ba91-7359683c49a4" \
4	-H "Authorization: Bearer <token>"

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": "receipt",
9	"line_items": [
10	{
11	"line_reference": "line_reference",
12	"name": "name",
13	"description": "description",
14	"quantity": 1.1,
15	"unit_price": 1.1,
16	"unit": "unit",
17	"subtotal": 1.1,
18	"tax_rate": 1.1,
19	"tax_amount": 1.1,
20	"total_amount": 1.1,
21	"discount_amount": 1.1
22	}
23	],
24	"sender": {
25	"address": {
26	"street_and_number": "street_and_number",
27	"city": "city",
28	"postal_code": "postal_code",
29	"country": "AF",
30	"state": "state"
31	},
32	"bank_account": {
33	"bank_account_number": "bank_account_number",
34	"iban": "iban",
35	"swift_bic": "swift_bic"
36	},
37	"vat_number": "vat_number",
38	"tax_number": "tax_number",
39	"email": "email",
40	"name": "name"
41	},
42	"currency": "AED",
43	"discount": 1.1,
44	"document_number": "recognized_data",
45	"issued_at": "2024-01-15T09:30:00Z",
46	"subtotal": 1.1,
47	"tax_amount": 1.1,
48	"tax_rate": 1.1,
49	"tax_type": "recognized_data",
50	"total_amount": 1.1
51	}
52	}