Document AI — OCR & IDP
Document AI — PDF
Document AI — Anonymization
Extract ID card or passport
WHEN TO USE: identity cards and passports — extracts document number, holder name, dates of birth, issue and expiry via the prepared "Identity Document" profile.
This operation has 27 documented variants (same method and path, different fields):
- Extract ID card or passport — WHEN TO USE: identity cards and passports — extracts document number, holder name, dates of birth, issue and expiry via the prepared "Identity Document" profile.
- Extract insurance policy — Extract insurance policy fields — policy number, insured party, coverage period, and premium.
- Extract legal document — Extract structured sections and parties from legal documents and contracts.
- Start adhoc document integrity check — WRITE: start an adhoc Trust / integrity scan (credits). No agent id. Required: pofid or documents_id. Optional profile and tier. Then read po_documents_trust_get. Use processing_lane for Start-SLA...
- Extract payroll / pay stub — Payroll / Pay Stub Extract salary and payroll data. Fields: employee_name, pay_period, gross, net, deductions, taxes, employer
- Extract hotel invoice — Extract hotel invoice fields — guest, stay dates, room charges, taxes, and total amount.
- Export DATEV SKR03 accounting — Extract structured accounting data in DATEV SKR03 format. Fields: document date, document number, posting text, debit/credit account, amount, tax rate.
- Extract bank check data — WHEN TO USE: cheque documents — extracts cheque number, date, payee, amounts, bank and account data via the prepared "Process Bank Check" profile. For bank statements use po_extraction_bank_details.
- Extract bank details — Extract bank account details from financial documents — IBAN, BIC, account holder, and bank name fields.
- Extract cash receipt data — Extract structured fields from cash receipts — amount, date, vendor, and payment method.
- Extract custom fields (IDP) — WHEN TO USE: extraction with your OWN field definitions (free profile) instead of a prepared one. Field keys use the canonical form with a leading underscore (_check_number). Keys without it are normalized automatically; the result...
- Extract invoice — Extract structured invoice fields via the IDP workflow (POST /job/add/workflow).
- Extract invoice (German/DATEV-optimized) — Extract data from German invoices with DATEV-compatible fields. Fields: invoice number, date, supplier, customer, net, gross, VAT, IBAN, BIC.
- Extract invoice basic fields — Lightweight invoice extraction with essential fields only — vendor, total, date, and invoice number.
- Extract statement of account — Extract account statement fields — period, opening balance, transactions, and closing balance.
- Extract utility bill — Extract utility bill fields — provider, billing period, consumption, and amount due.
- Extract letter or mail — Letters: Letter / Mail Extract letter metadata and content. Fields: sender, recipient, date, subject, body_summary. category: letters Use processing_lane for Start-SLA (no_sla|sla_24h|sla_12h|sla_6h|sla_1h|instant).
- Extract receipt — Extract retail receipt fields — merchant, line items, tax, and total.
- Extract delivery note — Extract delivery note fields — shipper, recipient, items, quantities, and delivery date.
- Extract purchase order — Orders: Purchase Order Extract purchase order data. Fields: order_number, date, vendor, buyer, items, delivery_date, total
- Extract shipping waybill — Extract shipping waybill fields — tracking number, carrier, sender, recipient, and weight.
- Extract construction plan/blueprint — Extract metadata and annotations from construction plans and blueprints via AI-IDP workflow.
- Extract vehicle registration — Vehicle Registration Extract vehicle registration data. Fields: plate_number, make, model, VIN, owner, registration_date
- Split PDF via AI — Split a multi-document PDF into separate files using AI layout analysis.
- Anonymize document (single-step) — POST /job/add/workflow. template=document_anonymize. Params: file|pofid, model (required: basic|premium|ultra; without it 400 MODEL_REQUIRED before billing), redact_categories, whitelist, custom_redact, custom_instructions, scenario...
- Detect PII preview — POST /job/add/workflow multipart. template=document_anonymize_preview (required). Params: file|pofid, model (required: basic|premium|ultra; without it 400 MODEL_REQUIRED before billing), redact_categories, whitelist, custom_redact...
- Finalize anonymize (workflow) — POST /job/add/workflow template=document_anonymize_finalize. Alternative to paperoffice_dataripper___redact_image when staying in workflow templates. Params: preview_images, preview_bounding_boxes, redact_boxes. Canonical apply for...
post/job/add/workflow
Request
- Base URL: https://api.paperoffice.ai/latest
- URL: https://api.paperoffice.ai/latest/job/add/workflow
- Auth: HTTP bearer
Response
Success
Changes
No recorded changes to this operation across all 1 revision of this API.