Skip to main content
POST
/
api
/
v1
/
extract
/
formalistic
OCR múltiplo (formalística)
curl --request POST \
  --url https://flex-hml.flexdoc-apis.com.br/services/api/v1/extract/formalistic \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form rulesGroup=pj \
  --form forensics=true \
  --form datavalid=true \
  --form faceDB=true \
  --form 'files=<unknown>' \
  --form 'cpfCnpj=<string>' \
  --form files.items='@example-file'
{
  "statusCode": 123,
  "timestamp": "<string>",
  "resquestUri": "<string>",
  "error": {
    "message": "<string>",
    "stackTrace": "<string>",
    "source": "<string>"
  },
  "succesful": true,
  "ocrResultList": [
    {
      "statusCode": 123,
      "timestamp": "<string>",
      "resquestUri": "<string>",
      "error": {
        "message": "<string>",
        "stackTrace": "<string>",
        "source": "<string>"
      },
      "ocrResult": {
        "empty": true
      },
      "faceResult": {
        "empty": true
      },
      "yoloResult": {
        "empty": true
      },
      "datavalidResult": {
        "empty": true
      },
      "companyAlias": "<string>",
      "processedImage": "<string>",
      "succesful": true
    }
  ],
  "checkListResult": {
    "batchId": 123,
    "result": {
      "empty": true
    },
    "methodName": "<string>"
  }
}

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

Requisição multipart para extração de OCR em múltiplos documentos (formalística).

rulesGroup
enum<string>
required

Grupo de regras a ser utilizado na análise formalística.

Available options:
pj,
BbSEG
forensics
boolean
required

Se deve usar a funcionalidade de Forensics.

datavalid
boolean
required

Se deve usar a funcionalidade de Datavalid.

faceDB
boolean
required

Se deve usar a funcionalidade de FaceDB.

files
file<binary>[]
required
Required array length: 1 - 20 elements
cpfCnpj
string

CPF/CNPJ do cliente.

Response

Resultado da extração múltipla retornado com sucesso.

statusCode
integer<int32>
timestamp
string
resquestUri
string
error
object
succesful
boolean
ocrResultList
object[]
checkListResult
object