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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
file
required

The file containing the data to extract. Accepted formats: PDF, PNG, JPG, JPEG. Max size: 10 MB. Max number of pages for PDF: 2.

string
enum
required
Allowed:
uuid | null

Scopes the Document Analysis to a specific workspace. Defaults to the default workspace if not specified.

uuid | null

Unique identifier of a Workflow Session. When provided, an Action is created in the Workflow Session, and this resource is associated with that Action.

uuid | null

ID of the previous attempt within the same workflow_session_id. Allows continuity between multiple attempts of the same Action. Null if this is the first attempt.

checks
object | null

Checks to perform on the document.

Responses

Updated 28 days ago

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

Updated 28 days ago