Enviar Documentos para Analises apenas OCR

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]/OCR/Enviar

Header

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

Body

Parâmetro	Descrição	Tipo	Exemplos	Atualização
Chave	Campo para identificação da analise	String	"ChaveDefinidaPeloCliente"
CPF	CPF do Cliente	String	"000000000000"	Jul/2024
ImagemFrente	Imagem da frente do documento	Base64	Base64
ImagemVerso	Imagem do verso do documento	Base64	Base64

Exemplo

{
  "Chave": "string",
  "CPF": "string",
  "ImagemFrente": "string",
  "ImagemVerso": "string"
}

Status Code 200

Retorno de sucesso.

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

Exemplo

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

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": []

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": "OK",
  "Mensagens": [
    "string"
  ]
}