Skip to main content
POST
/
api
/
v1
/
extract
/
ocr
OCR de documento padronizado
curl --request POST \
  --url https://flex-hml.flexdoc-apis.com.br/services/api/v1/extract/ocr \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form image='@example-file'
{
  "typeRecognized": "rg",
  "typeParentAlias": "di",
  "digitalDocument": true,
  "fields": [
    {
      "key": "nome",
      "value": "João da Silva",
      "conf": 0.95,
      "bbox": [
        12,
        34,
        56,
        78
      ],
      "fields": "<unknown>"
    }
  ],
  "errorMessage": "Falha ao processar imagem: formato inválido"
}

Authorizations

​
Authorization
string
header
required

Autentica o acesso a partir de usuário e senha e retorna o Bearer token JWT. Copie o access_token retornado e utilize-o no header Authorization para acessar os endpoints da API.

Body

multipart/form-data

Dados multipart contendo o arquivo de imagem ou PDF para OCR.

Requisição contendo a imagem do documento para extração OCR.

​
image
file
required

Imagem do documento nos formatos JPEG, PNG ou PDF.

Response

Resultado de OCR retornado com sucesso.

Resultado da extração OCR, contendo tipos, campos extraídos, estatísticas e eventual mensagem de erro.

​
typeRecognized
string

Modelo de documento reconhecido pelo OCR.

Example:

"rg"

​
typeParentAlias
string

Tipo de documento reconhecido pelo OCR.

Example:

"di"

​
digitalDocument
boolean

Indica se o documento é digital.

Example:

true

​
fields
object[]
​
errorMessage
string

Mensagem de erro, caso a extração não seja bem-sucedida.

Example:

"Falha ao processar imagem: formato inválido"