Classificador

Serviços para classificação de documentos.

O serviço identifica documentos dentro do arquivo enviado e a partir deles nossas IA's os classificam.

Request

POST /classify/v3

Parâmetros Arquivos

Como parâmetro esse endpoint espera o arquivo ou imagem a ser classificado. Para mais informações acesse aqui

TIP

Esse endpoint só aceita um arquivo ou imagem por vez.

Response

Campo	Descrição	Tipo	Observação
id	ID único da requisição	`String`
version	Versão da API	`String`
data	Lista com os resultados da análise	`Object[]`
data.classification	Objeto com os detalhes da classificação	`Object`
data.classification.type	Tipo do documento encontrado	`String`	Vide lista de documentos aceitos
data.classification.subtype	Subtipo do documento encontrado	`String`	Vide lista de documentos aceitos
data.classification.country	País de origem do documento encontrado	`String`	Vide lista de documentos aceitos
data.classification.sides	Lista com o lado do documento encontrado	`Object[]`	Sempre conterá somente um item
data.classification.sides.side	Lado encontrado do documento	`String`	Enum: (`OnlyFront`, `OnlyBack`, `FrontAndBack`)
data.classification.sides.page	Página onde o documento foi encontrado	`Number`
data.classification.sides.fieldname	Nome do campo em que o arquivo foi passado	`String`
data.classification.sides.confidence	Confiança da classificação	`Number`	Valor já filtrado internamente
metadata	Metadatas das informações (para apoio a debug)	`Object`
metadata.filesInfo	Lista com as informações (metadata dos arquivos)	`Object[]`
metadata.filesInfo.fieldname	Nome do parâmetro passado o arquivo	`Number`
metadata.filesInfo.name	Nome do arquivo passado	`Number`
metadata.filesInfo.size	Tamanho do arquivo passado	`Number`
metadata.filesInfo.pages	Página em questão	`Number`
metadata.filesInfo.mimetype	Mimetypes do arquivo passado	`Number`
metadata.filesInfo.encoding	Encoding do arquivo passado	`Number`
metadata.filesInfo.sha256	SHA256 do arquivo passado	`Number`

TIP

confidence - Já realizamos o filtro interno para devolver somente os documentos acima da confiança esperada. Recomendamos o uso de filtro nesse campo somente em caso específicos, onde o filtro default não atenda ou queira "subir a régua" da qualidade mínima aceita.

Exemplo Request

GET /classify/v3

TIP

A resposta é sempre uma lista (campo data), pois em um arquivo/imagem pode ter nenhum, 1 ou mais identidades. Porém, para simplificar o consumo deste dado, a lista está ordenada do melhor ao pior resultado, ou seja, caso o cenário esperado seja somente um arquivo, recomendamos pegar o primeiro item da lista, caso esta esteja vazio significa que não foi possível identificar nenhum documento naquela imagem.

Exemplos JSON

Veja alguns exemplos em JSON da resposta.

Exemplo quando uma identidade é encontradada na imagem

Status Code: 200

json

{
  "id": "5a7bad63-cac6-430c-ac65-a94def0f7b7a",
  "version": "v3",
  "data": [
    {
      "classification": {
        "type": "DriversLicense",
        "subtype": "Printed",
        "country": "BRA",
        "sides": [
          {
            "side": "FrontAndBack",
            "page": 0,
            "fieldname": "documento",
            "confidence": 0.99
          }
        ]
      }
    }
  ],
  "metadata": {
    "filesInfo": [
      {
        "fieldname": "documento",
        "name": "arquivo.JPG",
        "size": 567098,
        "pages": 1,
        "mimetype": "image/jpeg",
        "encoding": "7bit",
        "sha256": "41c2ece339abfcf9ba1e7d5a60666162a24ef34ba95adeb41ed1d9721c91c6b0"
      }
    ],
    "timeSpent": 10000
  }
}

Exemplo quando nenhum documento é encontrado na imagem

Status Code: 200

json

{
  "id": "5a7bad63-cac6-430c-ac65-a94def0f7b7a",
  "version": "v3",
  "data": [],
  "metadata": {
    "filesInfo": [
      {
        "fieldname": "documento",
        "name": "arquivo.JPG",
        "size": 567098,
        "pages": 1,
        "mimetype": "image/jpeg",
        "encoding": "7bit",
        "sha256": "41c2ece339abfcf9ba1e7d5a60666162a24ef34ba95adeb41ed1d9721c91c6b0"
      }
    ],
    "timeSpent": 10000
  }
}

Tipo e Subtipos de Identidades

Lista com os tipos, subtipos e lados de cada identidade reconhecida por nosso classificador. Perceba que a lista abaixo respeita a seguinte sequência: País de origem, Tipo, Subtipo e Lado.

Ex.:

País
- Tipo
  - Subtipo
    - Lado

Lista Completa

ARG

DriversLicense

empty
- OnlyFront

FederalID

empty
- OnlyBack
- OnlyFront

BHR

FederalID

empty
- OnlyBack
- OnlyFront

BRA

FederalCouncil

Accounting_Paper
- OnlyBack
- OnlyFront
- FrontAndBack
Accounting_Plastic
- OnlyBack
- OnlyFront
Administration_v1
- OnlyBack
- OnlyFront
Administration_v2
- OnlyBack
- OnlyFront
ArchitectureAndUrbanism
- OnlyFront
Biology
- OnlyBack
- OnlyFront
- FrontAndBack
Biomedicine
- OnlyBack
- OnlyFront
Chemistry
- OnlyBack
- OnlyFront
Dentistry
- OnlyBack
- OnlyFront
EngineeringAndAgronomy_Paper
- OnlyBack
- OnlyFront
- FrontAndBack
EngineeringAndAgronomy_Plastic
- OnlyBack
- OnlyFront
Fishery
- OnlyBack
- OnlyFront
- FrontAndBack
Lawyers
- OnlyBack
- OnlyFront
Medicine_Paper
- OnlyBack
- OnlyFront
- FrontAndBack
Medicine_Plastic
- OnlyBack
- OnlyFront
Musician
- OnlyBack
- OnlyFront
Nursing_v1
- OnlyBack
- OnlyFront
- FrontAndBack
Nursing_v2
- OnlyBack
- OnlyFront
- FrontAndBack
Nutrition
- OnlyBack
- OnlyFront
Pharmacy_Paper
- OnlyBack
- OnlyFront
Pharmacy_Plastic
- OnlyBack
- OnlyFront
PhysicalEducation
- OnlyBack
- OnlyFront
- FrontAndBack
Psychology
- OnlyBack
- OnlyFront
- FrontAndBack
Radiology
- OnlyBack
- OnlyFront
- FrontAndBack
SalesRepresentatives
- OnlyFront
SocialService
- OnlyBack
- OnlyFront
Veterinary
- OnlyBack
- OnlyFront

DriversLicense

BoatAndVessel
- OnlyBack
- OnlyFront
- FrontAndBack
Digital
- OnlyBack
- OnlyFront
- FrontAndBack
Printed
- OnlyBack
- OnlyFront
- FrontAndBack
Resolution2021Digital
- OnlyBack
- OnlyFront
- FrontAndBack
Resolution2021Paper
- OnlyBack
- OnlyFront
- FrontAndBack

FederalID

Decree2018Digital
- OnlyBack
- OnlyFront
- FrontAndBack
Decree2018Paper
- OnlyBack
- OnlyFront
- FrontAndBack
Decree2018Plastic
- OnlyBack
- OnlyFront
Decree2022Paper
- OnlyBack
- OnlyFront
- FrontAndBack
MainModel
- OnlyBack
- OnlyFront
- FrontAndBack

FederalRevenueService

CIC
- OnlyFront
Plastic
- OnlyFront
Printed
- OnlyFront
Temporary
- OnlyFront

FirefighterID

RioDeJaneiro
- OnlyBack
- OnlyFront

ForeignID

empty
- OnlyBack
- OnlyFront

MigratoryRegister

empty
- OnlyBack
- OnlyFront

RefugeRequest

empty
- OnlyBack
- OnlyFront
- FrontAndBack

MilitaryID

Airforce
- OnlyBack
- OnlyFront
Army_Paper
- OnlyBack
- OnlyFront
Army_Temporary
- OnlyBack
- OnlyFront
- FrontAndBack
MilitaryDischarge
- OnlyBack
- OnlyFront
- FrontAndBack
Navy_Paper
- OnlyBack
- FrontAndBack
Navy_Plastic
- OnlyBack
- OnlyFront

Passport

empty
- OnlyFront

PoliceID

Alagoas
- OnlyFront
Amazonas
- OnlyFront
Bahia
- OnlyBack
Bahia
- OnlyFront
- FrontAndBack
Ceara
- OnlyFront
DistritoFederal
- OnlyBack
DistritoFederal
- OnlyFront
EspiritoSanto
- OnlyFront
MatoGrossoDoSul
- OnlyBack
- OnlyFront
- FrontAndBack
MatoGrosso
- OnlyBack
- OnlyFront
MinasGerais_Paper
- OnlyBack
- OnlyFront
MinasGerais_Plastic
- OnlyFront
Para
- OnlyBack
- OnlyFront
Paraiba
- OnlyBack
- OnlyFront
Pernambuco
- OnlyBack
- OnlyFront
Piaui
- OnlyFront
RioDeJaneiro
- OnlyBack
- OnlyFront
- FrontAndBack
RioGrandeDoNorte
- OnlyFront
SaoPaulo
- OnlyBack
- OnlyFront
- FrontAndBack

ProofOfResidence

Celesc
- OnlyFront
Cemig
- OnlyFront
Claro
- OnlyFront
CoelbaCelpe
- OnlyFront
Copel
- OnlyFront
Cpfl
- OnlyFront
Edp
- OnlyFront
Enel
- OnlyFront
Energisa
- OnlyFront
Equatorial
- OnlyFront
Light
- OnlyFront
Rge
- OnlyFront
Sabesp
- OnlyFront
Saneago
- OnlyFront
Tim
- OnlyFront
Vivo
- OnlyFront

Transportation

ANTT
- OnlyBack
- OnlyFront
- FrontAndBack
CRLV_Digital
- OnlyBack
- OnlyFront
- FrontAndBack
CRLV_Printed
- OnlyBack
- OnlyFront
- FrontAndBack

VoterID

empty
- OnlyBack
- OnlyFront

WorkAndSocialSecurityRegistry

Handwritten
- OnlyBack
- OnlyFront
Printed
- OnlyBack
- OnlyFront

COL

DriversLicense

empty
- OnlyFront

FederalID

empty
- OnlyBack
- OnlyFront

Passport

empty
- OnlyFront

ESP

FederalID

empty
- OnlyBack
- OnlyFront

ITA

FederalID

empty
- OnlyBack
- OnlyFront

MAR

DriversLicense

empty
- OnlyBack
- OnlyFront

MEX

VoterID

empty
- OnlyFront

PAK

FederalID

empty
- OnlyFront
- OnlyBack

PER

FederalID_Paper

empty
- OnlyFront

FederalID_Plastic

empty
- OnlyFront

Passport

empty
- OnlyFront

PRT

FederalID

empty
- OnlyFront
- OnlyBack

Passport

empty
- OnlyFront

PRY

FederalID

empty
- OnlyFront

URY

FederalID

empty
- OnlyFront

USA

DriversLicense

Florida
- OnlyFront
Georgia
- OnlyFront

Passport

empty
- OnlyFront

SocialSecurityID

empty
- OnlyFront

VEN

FederalID

empty
- OnlyFront

Passport

empty
- OnlyFront

Classificador

Classificador ​

Request ​

Parâmetros Arquivos ​

Response ​

Exemplo Request ​

Exemplos JSON ​

Tipo e Subtipos de Identidades ​

Lista Completa ​

Classificador

Request

Parâmetros Arquivos

Response

Exemplo Request

Exemplos JSON

Tipo e Subtipos de Identidades

Lista Completa