# Holofin API Documentation

> REST API for Holofin: send a financial or identity document to a workflow, get its data back as structured JSON with the validation and fraud checks run on it, and receive a webhook when processing finishes. Dossiers group a case's documents and check them against case rules written in HoloLang.


## Getting Started

- [Introduction](https://app.holofin.ai/docs/api/v1.1/): Overview of the API: send a document, get structured JSON back, receive a webhook when processing finishes
- [Quickstart](https://app.holofin.ai/docs/api/v1.1/quickstart/): Send a first document and read the result, in four steps
- [Reliability and limits](https://app.holofin.ai/docs/api/v1.1/reliability/): What is safe to retry, idempotency, and the limits that stop a call
- [Authentication](https://app.holofin.ai/docs/api/v1.1/authentication/): API keys, IP allowlists, key expiry, and authentication errors
- [Errors](https://app.holofin.ai/docs/api/v1.1/errors/): Error codes, what causes each one, and how to handle it
- [Changelog](https://app.holofin.ai/docs/api/v1.1/changelog/): API changes, newest first; behaviour changes are marked

## Processing

- [Workflows](https://app.holofin.ai/docs/api/v1.1/workflows/): How a workflow classifies, segments and extracts a document; nodes and routing
- [Classification](https://app.holofin.ai/docs/api/v1.1/classification/): Document type detection, confidence score and tags
- [Segmentation](https://app.holofin.ai/docs/api/v1.1/segmentation/): Splitting a PDF that holds several documents, with page boundaries and a partition key such as an IBAN
- [Document Extraction](https://app.holofin.ai/docs/api/v1.1/extraction/): Extracted JSON (fields, transactions, balances) and the validation checks run on it
- [Address enrichment](https://app.holofin.ai/docs/api/v1.1/extraction/#address-enrichment)
- [2D-Doc seals](https://app.holofin.ai/docs/api/v1.1/extraction/#two-d-doc)
- [Field enrichment](https://app.holofin.ai/docs/api/v1.1/enrichment/): Schema field types resolved against an external reference after extraction (addresses, SIREN), and where the result is stored
- [Fraud Analysis](https://app.holofin.ai/docs/api/v1.1/fraud-analysis/): Fraud Analyzer node output: risk score, risk factors and trust factors

## Integrations

- [Webhooks](https://app.holofin.ai/docs/api/v1.1/webhooks/): Webhook events for workflow runs and dossiers, payloads, signatures and retries
- [MCP Server](https://app.holofin.ai/docs/api/v1.1/ai-assistants/): MCP server that lets Claude or another MCP client read a dossier
- [Agent Skills](https://app.holofin.ai/docs/api/v1.1/agent-skills/): Agent skill that tells an AI assistant which Holofin tool to call and how to read results
- [HoloLang overview](https://app.holofin.ai/docs/api/v1.1/hololang/): HoloLang, the formula language for validation rules and dossier case rules
- [HoloLang syntax](https://app.holofin.ai/docs/api/v1.1/hololang/syntax/): Field references, literals, operators, dates, aggregates, arrays and quantifiers
- [HoloLang rules](https://app.holofin.ai/docs/api/v1.1/hololang/rules/): Rule types: REQUIRED, VALIDATE FORMAT, ASSERT, IF/THEN, WARN
- [HoloLang fields](https://app.holofin.ai/docs/api/v1.1/hololang/fields/): Fields published by FORMAT validators and 2D-Doc seals
- [HoloLang examples](https://app.holofin.ai/docs/api/v1.1/hololang/examples/): A complete CERFA validation example and the error messages rules produce

## Dossiers

- [Dossiers](https://app.holofin.ai/docs/api/v1.1/cases/): Create a dossier from a case configuration, push its values, and read its requirements, documents and rule verdicts
- [Push dossier data - POST](https://app.holofin.ai/docs/api/v1.1/cases/#create-or-update)
- [Read a dossier - GET](https://app.holofin.ai/docs/api/v1.1/cases/#read)
- [Dossier activity - GET](https://app.holofin.ai/docs/api/v1.1/cases/#activities)
- [List dossiers - GET](https://app.holofin.ai/docs/api/v1.1/cases/#list)
- [Case configurations](https://app.holofin.ai/docs/api/v1.1/case-configs/): Case configurations: the fields, documents, participants and checks a dossier expects
- [List case configurations - GET](https://app.holofin.ai/docs/api/v1.1/case-configs/#list)
- [Read one configuration - GET](https://app.holofin.ai/docs/api/v1.1/case-configs/#detail)

## Workflow Runs

- [Workflow runs](https://app.holofin.ai/docs/api/v1.1/workflow-runs/): Run a workflow on a document, follow it, read its results and PDFs, cancel it
- [Create a workflow run - POST](https://app.holofin.ai/docs/api/v1.1/workflow-runs/#create-workflow-run)
- [Get a workflow run - GET](https://app.holofin.ai/docs/api/v1.1/workflow-runs/#get-workflow-run)
- [Download the run PDF - GET](https://app.holofin.ai/docs/api/v1.1/workflow-runs/#get-workflow-run-pdf)
- [Download a part PDF - GET](https://app.holofin.ai/docs/api/v1.1/workflow-runs/#get-part-pdf)
- [List workflow runs - GET](https://app.holofin.ai/docs/api/v1.1/workflow-runs/#list-workflow-runs)
- [List node runs - GET](https://app.holofin.ai/docs/api/v1.1/workflow-runs/#list-node-runs)
- [Cancel a workflow run - POST](https://app.holofin.ai/docs/api/v1.1/workflow-runs/#cancel-workflow-run)

## Organization

- [Usage - GET](https://app.holofin.ai/docs/api/v1.1/usage/): Pages processed over the last 30 days and since the start of the month
- [Processing metrics - GET](https://app.holofin.ai/docs/api/v1.1/metrics/): Document and page volumes, and throughput by outcome and channel, for BI
- [Health - GET](https://app.holofin.ai/docs/api/v1.1/health/): Unauthenticated status endpoint for monitoring
- [Sub-organizations](https://app.holofin.ai/docs/api/v1.1/sub-organizations/): Separate tenant organizations for each end client, managed from one API key

## Resources

- [Document Categories](https://app.holofin.ai/docs/api/v1.1/document-categories/): Classification categories and which ones support extraction
- [Schema Part Types](https://app.holofin.ai/docs/api/v1.1/schema-part-types/): part_type values in document_parts and the schema each one identifies
- [Supported Document Types](https://app.holofin.ai/docs/api/v1.1/supported-document-types/): Every supported document type and whether it uses a prebuilt schema or a custom extractor
- [Document Schemas](https://app.holofin.ai/docs/api/v1.1/document-schemas/): Response schema for French financial statements (liasse fiscale, CERFA forms) and the validation code registry
- [Identity & KYC Schemas](https://app.holofin.ai/docs/api/v1.1/schemas/identity/): Identity cards, passports, driving licences and residence permits, with MRZ parsing
- [Proof of Address Schemas](https://app.holofin.ai/docs/api/v1.1/schemas/proof-of-address/): French proof-of-address documents
- [Income & Employment Schemas](https://app.holofin.ai/docs/api/v1.1/schemas/income-employment/): Employment contracts, employer certificates and income tax returns
- [Banking & Wealth Schemas](https://app.holofin.ai/docs/api/v1.1/schemas/banking-wealth/): Bank certificates, transfer orders, amortization schedules and wealth statements
- [Business & Financial Schemas](https://app.holofin.ai/docs/api/v1.1/schemas/business-financial/): Registry extracts, beneficial-ownership declarations, minutes, audit reports and business plans
- [Vehicle & Asset Schemas](https://app.holofin.ai/docs/api/v1.1/schemas/vehicle-asset/): Vehicle registration, non-pledge certificates, vehicle invoices and purchase orders
- [After-Sales Schemas](https://app.holofin.ai/docs/api/v1.1/schemas/after-sales/): After-sales servicing requests and agreements on credit and lease contracts
- [Activity logs structure](https://app.holofin.ai/docs/api/v1.1/extraction/#activity-logs-structure)

## Security and Privacy

- [API Security](https://app.holofin.ai/docs/api/v1.1/security/): Encryption, retention, tenant isolation, API key controls, vulnerability reporting
- [Data Compliance](https://app.holofin.ai/docs/api/v1.1/data-compliance/): Storage location, encryption, subprocessors and data isolation
- [EU Data Residency](https://app.holofin.ai/docs/api/v1.1/eu-data-residency/): Where document data is processed and stored, and what leaves the EU
- [Data Lifecycle](https://app.holofin.ai/docs/api/v1.1/data-lifecycle/): Deletion jobs and signed deletion receipts, and how to verify one