Content Compare [multipart/form-data]

Description of the request body

Field Json

The json field is part of the form and must contain a Field list serialized in JSON.

{
    "fields": [
        {
            "name": "",
            "value": ""
        }
    ]
}

Field

Name	Type	Nullable	Description
name	String	Yes	Name of the field that will be compared to the content
value	String	Yes	Value used in the comparison

Request

Header Params

Authorization

string

required

Authorization token obtained in the Authentication/Authenticate method

Example:

Bearer {{bearer_token}}

Param-AntiXss-Response

string

optional

Parameter to sanitize the response JSON

Example:

Body Params multipart/form-data

file

required

Binary file to be processed.

fileUrl

string

required

Public Url of the file to be processed.

filePassword

string

required

Required if the submitted file is a password-encrypted PDF. The password must be encoded in a base64 string, since PDF files allow passwords to be binary data.

json

string

required

Contains a Field list to serialize into JSON. These values will be used in the comparison with the content.

Example:

{ "fields":[ { "name": "", "value": "" } ] }

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200200 Ok Response

application/json

Body

result

array [object {8}]

required

fields

array [object {4}]

optional

image

null

optional

score

null

optional

type

null

optional

stdType

null

optional

pageNumber

integer

optional

tags

null

optional

tables

null

optional

requestId

string

required

elapsedMiliseconds

integer

required

status

object

required

code

integer

required

message

string

required

Example

{
  "result": [
    {
      "fields": [
        {
          "name": "name",
          "stdName": null,
          "value": "marco",
          "score": 0.6
        }
      ],
      "image": null,
      "score": null,
      "type": null,
      "stdType": null,
      "pageNumber": 0,
      "tags": null,
      "tables": null
    }
  ],
  "requestId": "pJIJ6Nw7nkSbueKfsiyqc",
  "elapsedMiliseconds": 0,
  "status": {
    "code": 200,
    "message": "Ok"
  }
}

🔴500500 Error Response

Content Compare [multipart/form-data]

Description of the request body#

Field Json#

Field#

Request

Request samples

Responses

Description of the request body

Field Json

Field