---
title: "Extract File"
method: POST
path: "/v1/extract/file"
---

# Extract File

`POST /v1/extract/file`

## Request

- Base URL: `https://api.claims.zicron.ai`
- URL: `https://api.claims.zicron.ai/v1/extract/file`
- Auth: none declared

Extract structured data from an uploaded file.

## Query parameters

- `claim_type` 'wc' | 'ssdi' | 'ssi' | 'va' | 'pi' | 'ltd' | 'std' | 'feca' | 'sdi' | 'medicare' | 'medicaid' | 'hospice' | 'lnc': Insurance/benefits claim types the platform supports.
- `document_type` 'medical_record' | 'ime_report' | 'msa_report' | 'first_report_of_injury' | 'wage_statement' | 'fce' | 'function_report' | 'c_and_p_exam' | 'dd_214' | 'police_report' | 'determination_letter' | 'policy_document' | 'attending_physician_statement' | 'demand_letter' | 'buddy_statement' | 'job_description' | 'billing_record' | 'work_history' | 'earnings_record' | 'service_treatment_record' | 'employer_statement' | 'settlement_document' | 'consultative_exam': All document types that flow through the platform.
- `mechanism` 'ime' | 'msa' | 'fce': Cross-cutting evaluation/settlement mechanisms that serve multiple claim types.
- `password` string, nullable: Optional password for encrypted PDFs

## Response `200`

Successful Response

- ExtractionResponse: Successful extraction response.
  - `success` boolean, required
  - `data` object, required
  - `warnings` string[]
  - `metadata` ExtractionMetadata, required: Metadata about an extraction operation.
    - `model` string, required
    - `claim_type` 'wc' | 'ssdi' | 'ssi' | 'va' | 'pi' | 'ltd' | 'std' | 'feca' | 'sdi' | 'medicare' | 'medicaid' | 'hospice' | 'lnc': Insurance/benefits claim types the platform supports.
    - `document_type` 'medical_record' | 'ime_report' | 'msa_report' | 'first_report_of_injury' | 'wage_statement' | 'fce' | 'function_report' | 'c_and_p_exam' | 'dd_214' | 'police_report' | 'determination_letter' | 'policy_document' | 'attending_physician_statement' | 'demand_letter' | 'buddy_statement' | 'job_description' | 'billing_record' | 'work_history' | 'earnings_record' | 'service_treatment_record' | 'employer_statement' | 'settlement_document' | 'consultative_exam': All document types that flow through the platform.
    - `mechanism` 'ime' | 'msa' | 'fce': Cross-cutting evaluation/settlement mechanisms that serve multiple claim types.
    - `duration_seconds` number, required
    - `content_length` integer, required
    - `page_count` integer, nullable
    - `ocr_pages` integer[]
    - `ocr_confidence` number, nullable
    - `record_id` string, nullable
    - `prior_record_id` string, nullable
    - `has_delta` boolean

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/zicron/apis/zicron-api.md) · [All operations](https://skmtc.dev/zicron/apis/zicron-api/llms.txt) · [OpenAPI document](https://skmtc.dev/zicron/apis/zicron-api/revisions/abe62e22aa46?raw)