OCR a file from URL | Monite Documentation

curl -X POST https://api.sandbox.monite.com/v1/ocr_tasks \
     -H "x-monite-version: 2024-05-25" \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "file_url": "file_url"
}'

{
  "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.

Headers

x-monite-versionstringRequired

x-monite-entity-idstringOptional

The ID of the entity that owns the requested resource.

Request

This endpoint expects an object.

file_urlstringRequired

document_typeenumOptional

Allowed values:

Response

OCR task has been accepted for execution.

idstringformat: "uuid"

created_atdatetime

updated_atdatetime

statusenum

Allowed values:

document_typeenum

Allowed values:

recognized_dataobject

Errors

400

Post OCR Tasks Request Bad Request Error

401

Post OCR Tasks Request Unauthorized Error

413

Post OCR Tasks Request Content Too Large Error

415

Post OCR Tasks Request Unsupported Media Type Error

421

Post OCR Tasks Request Misdirected Request Error

422

Post OCR Tasks Request Unprocessable Entity Error

424

Post OCR Tasks Request Failed Dependency Error

429

Post OCR Tasks Request Too Many Requests Error