Extrair dados do Documento

Para a melhor performance da validação automática em relação a qualidade de imagem do documento/selfie, os parâmetros de tamanho da imagem devem seguir os requisistos:

• tamanho mínimo: 100KB
• tamanho máximo: 4.5MB
• extensões: JPEG, PNG, PDF

Requisição

POST [Url Ambiente]/Flash/V2/ExtrairDados/{Modelo}

Header

Identificador	Valor
Content-type	application/json
Accept	application/json
Authorization	Bearer [Valor do Token retornado na Autenticação]

Query

Parâmetro	Descrição	Tipo	Exemplos	Obrigatório
Modelo	Modelo para extração de dados	String	"crlv-v3"	Sim

Body

Parâmetro	Descrição	Tipo	Exemplos	Obrigatório
Chave	Campo para identificação da analise	String	"ChaveDefinidaPeloCliente"	Sim
TipoDocumento	Tipo de documento enviado	String	"CRLV"	Não
ImagemDocumento	Imagem do documento	Base64	Base64	Sim
CPF	CPF do Cliente	String	"000000000000"	Não
WebHook	Configurações para envio de webhook especificas da analise (libere os IPs de NAT)	Objeto	{ "Url": "https://meuwebhook.com.br/api/receber", "Headers": { "token" : "sf8sd9f89ds7f9dsf9ds79f7ds" } }	Não

Exemplo

{
  "Chave": "string",
  "TipoDocumento": "string",
  "ImagemDocumento": "string",
  "CPF": "string",
  "WebHook": {
    "Url": "string",
    "Headers": {
      "additionalProp1": "string",
      "additionalProp2": "string",
      "additionalProp3": "string",
      ...
    }
  }
}

Status Code 200

Retorno de sucesso.

Com acesso ao token e chave, será possível obter o retorno/consulta da análise. Segue campos que são retornados na consulta:

Parâmetro	Descrição	Tipo	Exemplos
Result	Resultado dos dados extraídos	String	O Resultado é variável, dependendo do cadastro da empresa e do tipo de documento enviado

Exemplo

{
    "Result": {
       "Cilindradas": 1984,
       "Categoria": "PARTICULAR",
       "Cor": "CINZA",
       "Motor": "CXD057886",
       "Capacidade Máxima de Carga": 0.0,
       "Peso Bruto Total": 1.95,
       "Capacidade Máxima de Tração": 1.95,
       "Eixos": 2,
       "Local": "SAO PAULO",
       "Data de Emissão": "11/01/2022",
       "Observações": ""
    }
}

Status Code 400

Não encontrado.

Parâmetro	Descrição	Tipo	Exemplos
Status	Status da requisição	OK = 0, ERRO = 1	1
Mensagens	Descrição dos erros	String[]	"Mensagens": "Mensagens": []

Status Code 401

Usuário/Senha inválidos.

Parâmetro	Descrição	Tipo	Exemplos
Status	Status da requisição	OK = 0, ERRO = 1	1
Mensagens	Descrição dos erros	String[]	"Mensagens": "Mensagens": []

Status Code 404

Erro 404 - Url não encontrado

O erro 404 é exibido quando um endpoint especificado pelo usuário não é encontrado na API. Isso pode ocorrer quando o usuário digitou um URL incorreto ou quando o endpoint não está mais disponível.

Status Code 500

Erro não tratado pelo sistema.

Parâmetro	Descrição	Tipo	Exemplos
Status	Status da requisição	OK/ERRO	ERRO
Mensagens	Descrição dos erros	String[]	"Mensagens": []

Exemplo

{
  "Status": 0,
  "Mensagens": [
    "string"
  ]
}