Content Extraction [application/json]

Request body description

Name	Type	Mandatory	Description
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.
returnImage	Boolean	No	If true, returns the binary clipping of the typed images with the corrected perspective
returnedImageQuality	String	No	It's not mandatory. Allows you to set the quality of the returned deskew image in the extraction path. The attribute is optional, and its default value (when not reporting) is 75.
returnCrops	Boolean	No	If true, it returns the clippings of binary images contained within a standardized document with corrected perspective, such as photo clippings, signature, barcode, and fingerprint. Refer to the list of read documents to view all available crops.
tags	String	No	Optional parameter that aids in document identification, reducing processing time and enhancing detection accuracy, acting as a filter. Values entered in the tag array must be strings following the Regex pattern. Refer to the list of read documents to view all available tags.

Request

Header Params

Authorization

string

required

Authorization token obtained in the Authentication/Authenticate method

Example:

Bearer {{bearer_token}}

Body Params application/json

fileBase64

string

required

fileUrl

string

required

filePassword

string

required

returnImage

boolean

required

returnedImageQuality

string

required

returnCrops

boolean

required

tags

array[string]

optional

tables

array

optional

requestId

string

required

elapsedMilliseconds

integer

required

status

object

required

code

string

required

message

string

required

Example

{
  "result": [
    {
      "fields": [
        {
          "name": "nome",
          "value": "XXXXXXXX XXXXXXX XX XXXXX",
          "score": 0.9
        },
        {
          "name": "rg",
          "value": "XXXXXXXX",
          "score": 0.9
        }
      ],
      "image": null,
      "score": 0.9,
      "type": "rg",
      "pageNumber": 1,
      "tags": [
        "br-rg-1"
      ],
      "tables": []
    }
  ],
  "requestId": "XXXXXXXXXXXXXXXXXXXX",
  "elapsedMilliseconds": 2000,
  "status": {
    "code": "200",
    "message": "Ok"
  }
}

⚪0200 OK Async Response

🔴500500 Error Response

Content Extraction [application/json]

Request body description

Request

Request samples

Responses

Content Extraction [application/json]

Request body description#

Request

Request samples

Responses

Request body description