post
https://api-sandbox.yousign.app/v3/document_analyses
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 documenttypeis required. Optionally setfraud_level(standardoradvanced) to also run fraud detection.extraction: false(fraud-only): no data extraction. Only available withmultipart/form-data(direct file upload):typeis optional andfraud_levelmust bestandardoradvanced. Whentypeis set, the classification checks that the document is of this type (DA_1003orDA_1004otherwise). Whentypeis omitted, the classification is only reported indocument_classification. Not supported with theapplication/json(Applicant) variant, where a documenttypeis always required.
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").
🧾 Tax notice (tax_notice) in France, per fraud_level
The 2D-Doc printed on the French tax notice is read only with standard.
fraud_level | Files | Extraction | 2d_doc | DA_1304 | Checks compared with | Fraud detection |
|---|---|---|---|---|---|---|
none or omitted | PDF, JPG, PNG | Yes | null | Never | Values read in the text | None |
standard | PDF only | Yes | Filled when an income tax notice 2D-Doc (ANTS type 04, or 28 since 2025) is found and its signature and certificate are valid. Otherwise null | When the file was read and holds no 2D-Doc: the analysis is failed. A 2D-Doc that cannot be read gives inconclusive with DA_3004, or failed with DA_3001 when the fraud risk is blocking | The valid 2D-Doc, otherwise the values read in the text | Document Trust (fraud_risk_analysis, barcode.* indicators) |
advanced | PDF, JPG, PNG | Yes | null | Never | Values read in the text | Resistant (fraud_risk_analysis) |
standard, extraction: false | PDF only | No (classification only) | None: extracted_from_document is [] | Never | None | Document Trust. The 2D-Doc signature and certificate are checked only when a 2D-Doc is found, so a tax notice without a 2D-Doc can end done |
advanced, extraction: false | PDF, JPG, PNG | No (classification only) | None: extracted_from_document is [] | Never | None | Resistant |
🔓 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_levelset tostandardand ExtractionDocument Trust Standard - For Fraud Detection with
fraud_levelset toadvancedand ExtractionDocument Trust Advanced
- For extraction only
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…

