Solicitar SmartOCR

📘

Endereço dos nossos serviços:

Homologação: POST https://datatrustapihml.clearsale.com.br/v1/transaction/{id}/ai-docs
Produção: POST https://datatrustapi.clearsale.com.br/v1/transaction/{id}/ai-docs

Acesse aqui a documentação técnica

Através desse endpoint, será criada uma requisição de extração dos dados das imagens de documentos fornecidos. Esta requisição será executada conforme pacote contratado pelo cliente junto a ClearSale.

O processo inclui as seguintes etapas:

Captura: Coleta das imagens dos documentos;
Tipificação: Classificação dos tipos de documentos;
Identificação do Documento: Apresenta se o documento é digital;
Processamento da Imagem: Melhoria da qualidade das imagens;
Extração de Dados: Identificação e extração das informações relevantes dos documentos;
Políticas de Regras de Negócios: Aplicação das regras de negócio para validação dos dados.

OBS: Este módulo não realiza nenhum tipo de análise de fraude.

O módulo de Validação por Documentos tem retorno assíncrono, sugerimos a implementação de umwebhook para que possamos notificá-lo quando o resultado do módulo estiver pronto!

Dicionário de variáveis

Request

NomeDescriçãoTipoTamanhoObrigatório
IdentifierIDID do pedido controlado pela entidadeString100Sim
ImagesDocumentImagens do documentoArray

Sim
ServiceNúmero do serviço contratadoInt

Sim

ImagesDocument

NomeDescriçãoTipoObrigatório
Base64Imagem em formato BASE64StringSim*
UrlURL da imagemStringSim*

*Base64 é obrigatório apenas se o campo Url não for preenchido.

*Url é obrigatório apenas se o campo Base64 não for preenchido.

Service

Para garantir a correta resposta do produto, o cliente deve assegurar que o parâmetro Service foi enviado de acordo com o serviço contratado:

ValorDescrição
4Solicitação de Smart OCR

Response

NomeDescriçãoTipoTamanho
IdentifierIDO valor enviado na transação será retornado na respostaString

TransactionIDIdentificador gerado pela transaction da Plataforma Data TrustString36
DateData da geração da transactionDateTime10

Did this page help you?