Pular para o conteúdo principal

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

IdentificadorValor
Content-typeapplication/json
Acceptapplication/json
AuthorizationBearer [Valor do Token retornado na Autenticação]

Body

ParâmetroDescriçãoTipoExemplos
ChaveCampo para identificação da analiseString"ChaveDefinidaPeloCliente"
ImagemFrenteImagem da frente do documentoBase64Base64
ImagemVersoImagem do verso do documentoBase64Base64

Exemplo

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

Status Code 200

Retorno de sucesso.

ParâmetroDescriçãoTipoExemplos
StatusStatus da requisiçãoOK = 0, ERRO = 10
MensagensDescrição dos errosString[]["SUCESSO"]

Exemplo

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

Status Code 401

Usuário/Senha inválidos.

ParâmetroDescriçãoTipoExemplos
StatusStatus da requisiçãoOK = 0, ERRO = 11
MensagensDescrição dos errosString[]"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âmetroDescriçãoTipoExemplos
StatusStatus da requisiçãoOK/ERROERRO
MensagensDescrição dos errosString[]"Mensagens": []

Exemplo

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