Resultado de SmartOCR
Com o transactionID retornado na solicitação de análise do documento, você poderá consultar o resultado de uma análise processada.
Após a notificação recebida via webhook, consulte o resultado das suas solicitações.
Seus respectivos modelos de chamada e dicionário de variáveis estão localizados a seguir.
Qualquer consulta via método GET não tem cobrança!
Endereço dos nossos serviços:
Homologação: GET https://datatrustapihml.clearsale.com.br/v1/transaction/{id}/ai-docs
Produção: GET https://datatrustapi.clearsale.com.br/v1/transaction/{id}/ai-docsAcesse aqui a documentação técnica
Dicionário de variáveis -
Response
| Nome | Descrição | Tipo | Tamanho |
|---|---|---|---|
| type | Tipo de documento enviado | Enum | |
| transactionId | Identificador gerado pela transaction da Plataforma Data Trust | String | 36 |
| identifierId | Identificador enviado pelo cliente | String | - |
| processStatusCode | Código da etapa atual do processamento da análise | Integer | - |
| processStatus | Descrição da etapa atual do processamento da análise | Enum | - |
| statusCode | Código referente ao status da análise | Enum | - |
| status | Descrição do status | Enum | - |
| substatusCode | Código referente ao substatus da análise (detalhamento) | Enum | - |
| substatus | Classificação da análise (detalhamento) | String | - |
| receivedDate | Data de recebimento da análise | DateTime | - |
| endDate | Data fim do processamento da análise | DateTime | - |
| isDigital | Identifica se o Documento é digital | Boolean | true / false |
| ocr | Dados extraídos do documento. Retorno null quando não for possível obter os dados | Array | - |
Type
| Valor | Descrição |
|---|---|
| 0 | NotSet |
| 1 | RG (Carteira de Identidade) |
| 2 | CNH (Carteira Nacional de Habilitação) |
| 3 | RNE/RNM (Registro Nacional de Estrangeiro) |
| 4 | CIN (Carteira de Identidade Nacional) |
| 5 | DNI (Documento Nacional de Identidade) |
| 99 | Invalid |
ProcessStatusCode
| Valor | Descrição |
|---|---|
| 1 | Em processamento |
| 2 | Concluído |
| 3 | Erro |
StatusCode e Status
| Valor | Descrição |
|---|---|
| 0 | Em processamento |
| 1 | Não Foi Possível Analisar |
| 3 | Documento Processado Com Sucesso |
| 5 | Regra de negócio não atendida |
SubstatusCode e Substatus
Abaixo seguem as tabelas de substatus possíveis, agrupadas por Status.
1 - Não Foi Possível Analisar
Lista de substatus possíveis para o StatusCode = 1.
| SubstatusID | Substatus (retorno) |
|---|---|
| 101 | Não foi possível fazer o download de uma ou mais imagens fornecidas |
| 102 | Uma ou mais imagens não possuem um formato Base64 válido |
| 103 | A imagem excede o tamanho máximo permitido de 20MB |
| 104 | O formato da imagem é inválido ou não suportado |
| 105 | PDF Inválido ou Corrompido |
| 106 | Imagem com qualidade baixa |
| 107 | Ausência de uma ou mais faces do documento |
| 108 | Versão de Documento não aceita |
| 109 | Informação ilegível |
3 - Documento Processado Com Sucesso
Lista de substatus possíveis para o StatusCode = 3.
| SubstatusID | Substatus (retorno) |
|---|---|
| 0 | - |
| 301 | Documento de menor de idade |
5 - Regra de Negócio Não Atendida
Lista de substatus possíveis para o StatusCode = 5.
Importante: Esses retornos só serão possíveis de ocorrer quando essas regras de negócio estiverem ativadas.
| SubstatusID | Substatus (retorno) |
|---|---|
| 501 | O documento é uma fotocópia preto e branco |
| 502 | O documento é uma fotocópia colorida |
| 503 | O documento é uma foto de tela |
| 504 | O documento digital não é original |
| 505 | Documento com data de emissão mais antiga do que o permitido |
| 506 | Idade inferior a idade mínima estabelecida. X anos. |
| 507 | Documento vencido |
| 508 | Documento sem CPF |
| 509 | O documento é de uma pessoa não alfabetizada |
| 510 | Categoria de CNH não aceita |
| 511 | Tipo de documento não aceito |
Updated 12 days ago