YouSign Document Analysis API
Analyze a document and extract structured data.
YouSign Document Analysis API is one of 38 APIs that YouSign publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
This API exposes 1 JSON Schema definition.
Tagged areas include Document Analysis. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a changelog, rate-limit docs, and 1 JSON Schema.
This API exposes 3 operations across 2 paths, and defines 113 schemas. It is described by OpenAPI 3.0.0, at version 3.0.
Requests are made against 2 base URLs: https://api-sandbox.yousign.app/v3, https://api.yousign.app/v3.
3 operations
2 paths
113 schemas
2 GET1 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
YouSign Document Analysis API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (bearerAuth).
By default, every request must be authenticated.
Paths & Operations 3
Across 2 paths, the API surfaces 3 operations — 2 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.
Document Analysis 3
Analyze a document and extract structured data.
GET
/document_analyses
List Document Analyses
POST
/document_analyses
Initiate a new Document Analysis
GET
/document_analyses/{documentAnalysisId}
Retrieve a Document Analysis
Schemas 113
The contract defines 113 schemas that model the data the API accepts and returns. The most detailed are ItalianVehicleRegistrationDocumentExtraction (18 properties), FrenchVehicleRegistrationDocumentExtraction (14 properties), FrenchInvoiceExtraction (14 properties), DocumentAnalysisMeta_1 (13 properties). Each schema is shown below with its type and property counts.
RNECertificateFull
object
12 required
VehicleRegistrationDocumentFull
TemporaryVehicleRegistrationDocumentExtraction
object
Extracted data from the document.
10 properties
10 required
FraudRiskAnalysis_indicators_inner
object
5 properties
5 required
VehicleRegistrationDocumentCheck
object
Checks performed on the document.
1 property
1 required
TooManyRequestsResponse
object
1 property
1 required
InitiateDocumentAnalysisFromApplicant
object
5 properties
1 required
FraudOnlyFull
object
Document Analysis run in fraud-only mode (analysistype.extraction is false). No document type and no extracted data; only the fraud detection result is returne…
InitiateBusinessRegistrationCertificate
object
7 properties
2 required
CompanyCertificateExtraction_legal_representatives_inner
object
7 properties
7 required
NotFoundResponse
object
2 properties
2 required
InitiateTaxNotice
object
8 properties
3 required
DocumentAnalysisType
string
Type of document you want to analyze. Will be used to match the detected document type.
FrenchVehicleRegistrationDocumentExtraction
object
Extracted data from a French vehicle registration document.
14 properties
14 required
InitiateTaxNotice_checks_income_year_check
object
Expected income year to check against the document.
1 property
1 required
InitiateFraudOnly
object
Fraud-only Document Analysis (no data extraction). Send analysistype[extraction]=false and analysistype[fraudlevel]=advanced, with no type.
5 properties
2 required
InitiateAutoInsuranceClaimsHistory
object
7 properties
2 required
TaxNoticeCheck
object
Checks performed on the document.
2 properties
CompanyCertificateExtraction
object
Extracted data from the document.
7 properties
7 required
DriverLicenceCheck
object
Checks performed on the document.
1 property
1 required
BusinessRegistrationCertificateExtraction
object
Extracted data from the document.
4 properties
4 required
CompanyCertificateCheck
object
Checks performed on the document.
1 property
1 required
FrenchInvoiceExtraction
object
Extracted data from the document.
14 properties
14 required
TemporaryVehicleRegistrationDocumentExtraction_document_recipient_information
object
Document recipient information extracted from the document.
4 properties
4 required
DocumentAnalysisMeta_1
object
13 properties
11 required
TaxNoticeFull
object
12 required
InitiatePayslip_checks
object
Checks to perform on the document.
1 property
FrenchVehicleRegistrationDocumentExtraction_co_owner_information_inner
object
1 property
1 required
InitiateSocialSecurity_checks
object
Checks to perform on the document.
2 properties
2 required
TemporaryVehicleRegistrationDocumentExtraction_vehicle_owner_information
object
Vehicle owner information extracted from the document.
3 properties
3 required
SocialSecurityExtraction
object
Extracted data from the document.
5 properties
5 required
InitiateTaxNotice_checks
object
Checks to perform on the document.
2 properties
InitiateRNECertificate
object
7 properties
2 required
InitiateCompanyCertificate
object
7 properties
2 required
UnsupportedMediaTypeResponse
object
2 properties
2 required
InitiateTemporaryVehicleRegistrationDocument
object
8 properties
3 required
InitiatePayslip
object
8 properties
3 required
BusinessRegistrationCertificateExtraction_company_description
object
8 properties
8 required
InitiateVehicleRegistrationDocument_checks_vehicle_owner
object
Vehicle owner information to check against the document.
4 properties
3 required
AutoInsuranceClaimsHistoryCheck_policy_holder
object
Check result for the policy holder.
1 property
1 required
French_Vehicle_Registration_Document
object
12 required
BusinessRegistrationCertificateExtraction_branch_description
object
5 properties
5 required
DriverLicenceExtraction
object
7 properties
7 required
RNECertificateCheck
object
Checks performed on the document.
1 property
1 required
DocumentAnalysisStatus
string
Status of the Document Analysis.
AnalysisTypeMultipart
object
Same as analysistype on the JSON path, but sent as multipart/form-data. Because form-data has no native boolean, extraction is a string ("true"/"false"). - Whe…
2 properties
WorkflowSessionId
string
Unique identifier of a Workflow Session. When provided, an Action is created in the Workflow Session, and this resource is associated with that Action.
TaxNoticeExtraction_2d_doc
object
The 2D document extracted from the document.
8 properties
8 required
Pagination
object
Metadata about the response.
1 property
1 required
AutoInsuranceClaimsHistoryExtraction_drivers_information_inner
object
7 properties
7 required
DocumentAnalysisMatchLevel
string
Level of match between extracted and expected value.
FrenchVehicleRegistrationDocumentExtraction_vehicle_motor_information
object
4 properties
4 required
InitiateDocumentAnalysisFromMultipart
object
CompanyCertificateFull
object
12 required
FrenchVehicleRegistrationDocumentExtraction_owner_information
object
3 properties
3 required
InitiateCompanyCertificate_checks
object
Checks to perform on the document.
1 property
1 required
PayslipCheck
object
Checks performed on the document.
1 property
FraudRiskAnalysis
object
Result of the fraud detection analysis. null when no fraud detection verdict is available (e.g. fraud detection was not requested, or is still in progress).
2 properties
2 required
ItalianVehicleRegistrationDocumentExtraction
object
Extracted data from an Italian vehicle registration document.
18 properties
18 required
DriverLicenceFull
object
12 required
MethodNotAllowed
object
1 property
1 required
ItalianVehicleRegistrationDocumentExtraction_vehicle_motor_information
object
3 properties
3 required
AutoInsuranceClaimsHistoryExtraction
object
Extracted data from the document.
12 properties
12 required
BadRequestResponse
object
2 properties
2 required
ForbiddenResponse
object
2 properties
2 required
UnauthorizedResponse
object
2 properties
2 required
ItalianVehicleRegistrationDocumentExtraction_owner_information
object
4 properties
4 required
TemporaryVehicleRegistrationDocumentCheck_vehicle_owner
object
Check result for the vehicle owner.
1 property
1 required
InitiateVehicleRegistrationDocument
object
8 properties
3 required
AutoInsuranceClaimsHistoryExtraction_incidents_information_inner
object
5 properties
5 required
InitiateDocumentAnalysisFromApplicant_checks_income_year_check
object
Expected income year to check against the document.
1 property
1 required
InvoiceFull
object
12 required
InitiateDriverLicence
object
7 properties
2 required
DocumentAnalysisMeta
object
13 properties
11 required
InitiateDocumentAnalysisFromApplicant_checks
object
Checks to perform on the document. Only accepted when type is taxnotice.
1 property
InitiatePayslip_checks_full_name_check
object
Expected full name to check against the document.
2 properties
2 required
InitiateAutoInsuranceClaimsHistory_checks_policy_holder
object
Expected policy holder information.
4 properties
1 required
get_document_analyses_200_response
object
2 properties
ItalianVehicleRegistrationDocumentExtraction_deed_informations_inner
object
4 properties
4 required
InternalServerError
object
2 properties
2 required
post_document_analyses_201_response
CompanyCertificateCheck_legal_representatives_inner
object
1 property
1 required
FrenchVehicleRegistrationDocumentExtraction_vehicle_information
object
3 properties
3 required
PayslipExtraction
object
Extracted data from the document.
9 properties
9 required
InitiateTemporaryVehicleRegistrationDocument_checks_vehicle_owner
object
Expected vehicle owner information.
4 properties
1 required
PayslipFull
object
12 required
TemporaryVehicleRegistrationDocumentFull
object
12 required
InitiateAutoInsuranceClaimsHistory_checks
object
Checks to perform on the document.
1 property
1 required
InitiateInvoice
object
6 properties
3 required
AutoInsuranceClaimsHistoryCheck
object
Checks performed on the document.
1 property
1 required
InitiateVehicleRegistrationDocument_checks
object
Checks to perform on the document.
1 property
1 required
TemporaryVehicleRegistrationDocumentCheck
object
Checks performed on the document.
1 property
1 required
SocialSecurityCheck
object
Checks performed on the document.
1 property
1 required
AutoInsuranceClaimsHistoryFull
object
12 required
TaxNoticeCheck_income_year
object
3 properties
3 required
Italian_Vehicle_Registration_Document
object
12 required
InitiateFraudOnly_analysis_type
object
2 properties
2 required
InitiateCompanyCertificate_checks_legal_representatives_inner
object
2 properties
2 required
WorkflowSessionApplicantId
string
Unique identifier of an Applicant.
FraudOnlyFull_allOf_analysis_type
object
2 properties
2 required
UUID
string
The unique identifier for a resource.
InitiateTaxNotice_checks_full_name_check
object
Expected full name to check against the document.
2 properties
2 required
BusinessRegistrationCertificateCheck
object
Checks performed on the document.
1 property
1 required
RNECertificateExtraction
object
Extracted data from the document.
6 properties
6 required
AnalysisType
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…
2 properties
InitiateTemporaryVehicleRegistrationDocument_checks
object
Checks to perform on the document.
1 property
1 required
TaxNoticeExtraction
object
Extracted data from the document.
9 properties
9 required
PreviousAttemptId
string
ID of the previous attempt within the same workflowsessionid. Allows continuity between multiple attempts of the same Action. Null if this is the first attempt.
BusinessRegistrationCertificateFull
object
12 required
InvoiceFull_allOf_checks
object
Checks performed on the document. Always null for invoices.
SocialSecurityFull
object
12 required
InitiateSocialSecurity
object
7 properties
2 required
DocumentAnalysisCheck
object
Represents the result of checking if an extracted value matches an expected value with different levels of match (exact, close, or no match).
3 properties
3 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from YouSign 12
Other APIs YouSign publishes across the network.
YouSign Applicant API
YouSign Approver API
YouSign Archive API
YouSign Audit Trail API
YouSign Bank Account Lookup Verification API
YouSign Bank Account Verification API
YouSign Company Verification API
YouSign Consumption API
YouSign Contact API
YouSign Custom Experience API
YouSign Custom Property API
YouSign Deprecated API
#Document Analysis