CLEARSALE

Solicitar AIDocs

📘

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 deste endpoint, você pode criar uma requisição para a análise automática das imagens dos documentos fornecidos. Esta requisição será executada de acordo com o pacote contratado pelo cliente junto à ClearSale.

O processo inclui:

  • Extração de Dados: Identificação e extração das informações relevantes dos documentos;
  • Análise Automatizada: Verificação e validação dos dados extraídos utilizando Inteligência Artificial e Aprendizado de Máquina;
  • Face Match: Comparação da selfie do portador com a foto no documento para garantir a autenticidade.

*Ao contratar este serviço, o Smart OCR já está incluído, realizando a captura, tipificação, processamento da imagem, reconhecimento e transcrição de texto (OCR), além das validações textuais e de regras de negócio.

O módulo de Autenticação de Identidade 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

NomeDescriçãoTipoTamanhoObrigatório
IdentifierIDID do pedido controlado pela entidadeString100Sim
ImagesDocumentImagens do documentoArray-Sim
ServiceNúmero do serviço contratadoInt-Sim
SelfieFoto selfie do portadorObject-Sim

ImagesDocument e Selfie

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
5Solicitação de AIDocs (OCR + Validação Automática do Documento + Facematch)

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