Content Compare [application/json]

Request body description

Name	Type	Mandatory	Description
fields	Field List	Yes	Field List serialized in JSON. These values will be used in comparison with the content.
fileBase64	String	Yes, when fileUrl parameter is not informed	Binary of the file to be processed, encoded in text string according to RFC3548 standard using base64 encoding.
fileUrl	String	Yes, when fileBase64 parameter is not informed	Public URL of the file to be processed.
filePassword	String	Yes, if the submitted file is an encrypted PDF	Password encoded in a base64 string, as PDFs allow passwords to be binary data.

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 application/json

fields

array [object {2}]

required

name

string

optional

value

string

optional

fileBase64

string

required

fileUrl

string

required

filePassword

string

required

Example

{
  "fields": [
    {
      "name": "",
      "value": ""
    }
  ],
  "fileBase64": "",
  "fileUrl": "",
  "filePassword": ""
}

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": "XXXX",
          "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"
  }
}

⚪0500 Error Response

Content Compare [application/json]

Request body description#

Field#

Request

Request samples

Responses

Request body description

Field