Solicitar OCR (Smart OCR)
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-docsAcesse 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 um webhook para que possamos notificá-lo quando o resultado do módulo estiver pronto!
Dicionário de variáveis
Request
Nome | Descrição | Tipo | Tamanho | Obrigatório |
---|---|---|---|---|
IdentifierID | ID do pedido controlado pela entidade | String | 100 | Sim |
ImagesDocument | Imagens do documento | Array | - | Sim |
Service | Número do serviço contratado | Int | - | Sim |
ImagesDocument
Nome | Descrição | Tipo | Obrigatório |
---|---|---|---|
Base64 | Imagem em formato BASE64 | String | Sim* |
Url | URL da imagem | String | Sim* |
*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:
Valor | Descrição |
---|---|
4 | Solicitação de Smart OCR |
Response
Nome | Descrição | Tipo | Tamanho |
---|---|---|---|
IdentifierID | O valor enviado na transação será retornado na resposta | String | - |
TransactionID | Identificador gerado pela transaction da Plataforma Data Trust | String | 36 |
Date | Data da geração da transaction | DateTime | 10 |
Updated 1 day ago