v1

latestSwagger 2.02026-07-13202782.8 KB
ImageOcr

Recognize a photo of a form, extract key fields using stored templates

Analyzes a photograph of a form as input, and outputs key business fields and information. Customzie data to be extracted by defining fields for the form. Uses template definitions stored in Cloudmersive Configuration; to configure stored templates in a configuration bucket, log into Cloudmersive Management Portal and navigate to Settings > API Configuration > Create Bucket. Note: for free tier API keys, it is required to add a credit card to your account for security reasons, to use the free tier key with this API.

post/ocr/photo/recognize/form/advanced

Headers

bucketIDstring

Bucket ID of the Configuration Bucket storing the form templates

bucketSecretKeystring

Bucket Secret Key of the Configuration Bucket storing the form templates

recognitionModestring

Optional, enable advanced recognition mode by specifying 'Advanced', enable handwriting recognition by specifying 'EnableHandwriting'. Default is disabled.

preprocessingstring

Optional, preprocessing mode, default is 'Auto'. Possible values are None (no preprocessing of the image), and Auto (automatic image enhancement of the image - including automatic unrotation of the image - before OCR is applied; this is recommended). Set this to 'None' if you do not want to use automatic image unrotation and enhancement.

diagnosticsstring

Optional, diagnostics mode, default is 'false'. Possible values are 'true' (will set DiagnosticImage to a diagnostic PNG image in the result), and 'false' (no diagnostics are enabled; this is recommended for best performance).

Response

OK

Successfulboolean

True if the operation was successful, false otherwise

Diagnosticsstring[]

Diagnostic images - default is null, enable diagnostics=true to populate this parameter with one image per field

BestMatchFormSettingNamestring

Optional; populated when using photo/recognize/form/advanced with the Setting Name of the best-matching highest-relevance form