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 umwebhook 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

Selfie

Foto selfie do portador

Object


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

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