Initiate a new Document Trust Analysis

post

https://api-sandbox.yousign.app/v3/document_analyses

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

ℹ️ 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 to 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 and Extraction Document Trust Advanced

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

applicant_id

uuid

required

The Applicant ID linked to the Workflow Session.

type

string

enum

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

analysis_type

object

Controls what the Document Analysis performs.

When extraction is true (default), data is extracted from the document and a document type is required.
When extraction is false (fraud-only), no type must be provided and fraud_level must be advanced.

country_code

string

enum

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) or invoice (accepted: FR, IT, DE).

Allowed:

checks

object | null

Checks to perform on the document. Only accepted when type is tax_notice.

Headers

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Responses

201OK

400Bad request

401Access unauthorized

403Access forbidden

404Resource not found

405This method is not allowed

415UnsupportedMediaType

429Too Many Requests, please try again later.

500Internal Server Error