Recognize a photo of a form, extract key fields and business information

POST

/ocr/photo/recognize/form

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. 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.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://api.cloudmersive.com/ocr/photo/recognize/form' \
--form 'imageFile=@""'

Response Example

{
    "BestMatchFormSettingName": "string",
    "Diagnostics": [
        "string"
    ],
    "FieldValueExtractionResult": [
        {
            "FieldValues": [
                {
                    "BoundingPoints": [
                        {
                            "X": 0,
                            "Y": 0
                        }
                    ],
                    "ConfidenceLevel": 0,
                    "Height": 0,
                    "Text": "string",
                    "Width": 0,
                    "XLeft": 0,
                    "YTop": 0
                }
            ],
            "TargetField": {
                "AllowNumericDigits": true,
                "AlternateAnchor": "string",
                "AnchorMode": "string",
                "BottomAnchor": "string",
                "DataType": "string",
                "FieldID": "string",
                "HorizontalAlignmentType": "string",
                "Ignore": [
                    "string"
                ],
                "LeftAnchor": "string",
                "MinimumCharacterCount": 0,
                "Options": "string",
                "TargetDigitCount": 0,
                "TargetFieldHeight_Relative": 0,
                "TargetFieldHorizontalAdjustment": 0,
                "TargetFieldVerticalAdjustment": 0,
                "TargetFieldWidth_Relative": 0,
                "TopAnchor": "string",
                "VerticalAlignmentType": "string"
            }
        }
    ],
    "Successful": true,
    "TableValueExtractionResults": [
        {
            "TableDefinition": {
                "ColumnDefinitions": [
                    {
                        "AllowNumericDigits": true,
                        "AnchorMode": "string",
                        "ColumnID": "string",
                        "DataType": "string",
                        "MinimumCharacterCount": 0,
                        "TopAnchor": "string"
                    }
                ],
                "TableID": "string",
                "TargetRowHeight_Relative": 0,
                "TargetTableHeight_Relative": 0
            },
            "TableRowsResult": [
                {
                    "TableRowCellsResult": [
                        {
                            "CellValues": [
                                {
                                    "BoundingPoints": [
                                        {
                                            "X": 0,
                                            "Y": 0
                                        }
                                    ],
                                    "ConfidenceLevel": 0,
                                    "Height": 0,
                                    "Text": "string",
                                    "Width": 0,
                                    "XLeft": 0,
                                    "YTop": 0
                                }
                            ],
                            "ColumnID": "string"
                        }
                    ]
                }
            ]
        }
    ]
}

Request

Header Params

Body Params multipart/form-data

Responses

🟢200OK

application/json

Body

Modified at 2023-08-15 09:12:04

Recognize a photo of a business card, extract key business information

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