Get an OCR task by ID | Monite Documentation

curl https://api.sandbox.monite.com/v1/ocr_tasks/task_id \
     -H "x-monite-version: 2024-05-25" \
     -H "Authorization: Bearer <token>"

{
  "id": "id",
  "created_at": "2024-01-15T09:30:00Z",
  "updated_at": "2024-01-15T09:30:00Z",
  "status": "processing",
  "document_type": "invoice",
  "recognized_data": {
    "type": "invoice",
    "recipient": {
      "address": {
        "city": "city",
        "country": "AF",
        "postal_code": "postal_code",
        "state": "state",
        "street_and_number": "street_and_number"
      },
      "bank_account": {
        "bank_account_number": "bank_account_number",
        "iban": "iban",
        "swift_bic": "swift_bic"
      },
      "email": "email",
      "name": "name",
      "tax_number": "tax_number",
      "vat_number": "vat_number"
    },
    "sender": {
      "address": {
        "city": "city",
        "country": "AF",
        "postal_code": "postal_code",
        "state": "state",
        "street_and_number": "street_and_number"
      },
      "bank_account": {
        "bank_account_number": "bank_account_number",
        "iban": "iban",
        "swift_bic": "swift_bic"
      },
      "email": "email",
      "name": "name",
      "tax_number": "tax_number",
      "vat_number": "vat_number"
    },
    "amount_paid": 1.1,
    "currency": "AED",
    "document_number": "document_number",
    "due_date": "due_date",
    "issue_date": "issue_date",
    "line_items": [
      {
        "description": "description",
        "line_reference": "line_reference",
        "name": "name",
        "quantity": 1.1,
        "subtotal": 1.1,
        "tax_amount": 1.1,
        "tax_rate": 1.1,
        "total_amount": 1.1,
        "unit": "unit",
        "unit_price": 1.1
      }
    ],
    "payment_terms": "payment_terms",
    "subtotal": 1.1,
    "tax_amount": 1.1,
    "tax_rate": 1.1,
    "total_amount": 1.1
  }
}

Authentication

AuthorizationBearer

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

Path parameters

task_idstringRequired

Response

Successful Response

idstringformat: "uuid"

created_atdatetime

updated_atdatetime

statusenum

Allowed values:

document_typeenum

Allowed values:

recognized_dataobject

Errors

401

Get OCR Tasks ID Request Unauthorized Error

404

Get OCR Tasks ID Request Not Found Error

422

Get OCR Tasks ID Request Unprocessable Entity Error

429

Get OCR Tasks ID Request Too Many Requests Error

Authentication

Path parameters

Headers

Response

Errors