API Reference
Status PageRoadmapTestimoniesShare feedback

Initiate a new Document Analysis

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

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

Related guide: Document 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.

🔓 Endpoint access

  • Environments: production, sandbox
  • API key scopes: organization, workspace
  • Plans: pro, scale
  • Add-ons (for production access): Document Analysis
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
uuid
required

The Applicant ID linked to the Workflow Session.

string
enum
required

Type of document you want to analyze.

string
enum

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

Allowed:
checks
object | null

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

Headers
string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Responses

Updated 6 days ago

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Choose an example:
application/json

Updated 6 days ago