Sign in
Document Trust Analysis

Initiate a new Document Trust Analysis

Initiate a new Document Trust Analysis to extract data from a given document type.

Related guide: Document Trust Analysis

ℹ️ This endpoint accepts two request body formats — pick the one that matches your use case:

  • 📁 multipart/form-data — upload a binary file containing the document to analyse.
  • 📝 application/json — reference an existing Workflow Session Applicant by ID.

🔎 Analysis type (analysis_type)

  • extraction: true (default): data is extracted from the document. A document type is required. Optionally set fraud_level (standard or advanced) to also run fraud detection (not supported for tax_notice).
  • extraction: false (fraud-only): no data extraction. type must be omitted and fraud_level must be advanced.

On multipart/form-data, analysis_type is sent as form fields (analysis_type[extraction], analysis_type[fraud_level]) and extraction is a string ("true"/"false").

🔓 Endpoint access

  • Environments: production, sandbox
  • API key scopes: organization, workspace
  • Plans: pro, scale
  • Add-ons (for production access):
    • For extraction only Document Analysis
    • For Fraud Detection with fraud_level set to standard and Extraction Document Trust Standard
    • For Fraud Detection with fraud_level set to advanced and Extraction Document Trust Advanced
post/document_analyses

Request body

applicant_idstring uuid required

The Applicant ID linked to the Workflow Session.

type'social_security' | 'company_certificate' | 'business_registration_certificate' | 'driver_licence' | 'rne_certificate' | 'temporary_vehicle_registration_document' | 'vehicle_registration_document' | 'auto_insurance_claims_history' | 'tax_notice' | 'payslip' | 'invoice' | 'proof_of_address' | 'id_document' required

Type of document you want to analyze. Will be used to match the detected document type.

country_code'FR' | 'IT' | 'DE'

The country code of the document. Required when type is vehicle_registration_document (accepted: FR, IT), tax_notice (accepted: FR, DE), payslip (accepted: FR, IT), invoice (accepted: FR, IT, DE), proof_of_address (accepted: IT, DE) or id_document (accepted: DE).

Example request

{
  "applicant_id": "9a93d3b5-fb3b-4abf-9e70-26315b33506c",
  "type": "social_security",
  "analysis_type": {
    "extraction": true,
    "fraud_level": "advanced"
  },
  "country_code": "FR",
  "checks": {
    "income_year_check": {
      "income_year": 2024
    }
  }
}

Response

OK

PostDocumentAnalyses201Response required— unresolved $ref

Changes