Serviços / Documentos

Leitura de documentos

POST/api/v1/oracle/document/read

Extrai os dados de CNH, RG, passaporte, cartão CNPJ e contrato social a partir da foto ou do PDF, prontos para preencher um cadastro.

Informe o tipo em document_type e envie o arquivo em file — imagem, HEIC ou PDF, até 20 MB. Os campos de analysis_result variam conforme o tipo, e is_valid indica se o arquivo é mesmo o documento informado.

Lê o que está impresso: não confere os dados em base oficial nem atesta a autenticidade do documento.

Fonte: OCR com visão computacional · tempo real

Parâmetros

filefileObrigatório

Imagem, HEIC ou PDF do documento.

file
document_typestringObrigatório

Tipo do documento enviado.

CNH
query

Campos da resposta

Tipo de documento

document_type

Tipo de documento lido.

string

Arquivo enviado

filename

Nome do arquivo enviado.

string

Campos extraídos

analysis_result

Campos extraídos. As chaves variam por tipo de documento.

object

Documento reconhecido

analysis_result.is_valid

boolean

Nome

analysis_result.nome

Em CNH, RG-FRONT, PASSAPORTE.

string

Nº de registro

analysis_result.numero_registro

Em CNH.

string

CPF

analysis_result.cpf

Em CNH, RG-FRONT, RG-BACK, PASSAPORTE.

string

Nacionalidade

analysis_result.nacionalidade

Em CNH, PASSAPORTE.

string

Documento de identidade

analysis_result.doc_identidade

Em CNH.

string

Órgão emissor

analysis_result.org_emissor

Em CNH.

string

Data de emissão

analysis_result.data_emissao

Em CNH.

string

Validade

analysis_result.validade

Em CNH.

string

Filiação 1

analysis_result.filiacao1

Em CNH, RG-FRONT, RG-BACK, PASSAPORTE.

string

Filiação 2

analysis_result.filiacao2

Em CNH, RG-FRONT, RG-BACK.

string

Data de nascimento

analysis_result.data_nascimento

Em RG-FRONT, RG-BACK, PASSAPORTE.

string

Naturalidade (UF)

analysis_result.naturalidade

Em RG-FRONT.

string

Órgão expedidor

analysis_result.orgao_expedidor

Em RG-FRONT, RG-BACK.

string

Sexo

analysis_result.sex

Em RG-FRONT.

string

RG

analysis_result.rg

Em RG-FRONT, RG-BACK.

string

Data de expedição

analysis_result.data_expedicao

Em RG-BACK.

string

Registro civil

analysis_result.registro_civil

Em RG-BACK.

string

País emissor

analysis_result.pais_emissor

Em PASSAPORTE.

string

Tipo de passaporte

analysis_result.tipo_passaporte

Em PASSAPORTE.

string

Zona de leitura (MRZ)

analysis_result.codigo_abaixo

Em PASSAPORTE.

string

Nº do passaporte

analysis_result.numero_passaporte

Em PASSAPORTE.

string

CNPJ

analysis_result.numero_cnpj_inscricao

Em CARTÃO_CNPJ.

string

Data de abertura

analysis_result.data_abertura

Em CARTÃO_CNPJ.

string

Razão social

analysis_result.nome_empresarial

Em CARTÃO_CNPJ.

string

Nome fantasia

analysis_result.titulo_estabelecimento_fantasia

Em CARTÃO_CNPJ.

string

CNAE principal

analysis_result.codigo_e_descricao_principal

Em CARTÃO_CNPJ.

string

CNAEs secundários

analysis_result.codigos_e_descricoes_secundarias

Em CARTÃO_CNPJ.

string

Natureza jurídica

analysis_result.codigo_e_descricao_natureza_juridica

Em CARTÃO_CNPJ.

string

Logradouro

analysis_result.logradouro

Em CARTÃO_CNPJ.

string

Número

analysis_result.numero

Em CARTÃO_CNPJ.

string

Complemento

analysis_result.complemento

Em CARTÃO_CNPJ.

string

CEP

analysis_result.cep

Em CARTÃO_CNPJ.

string

Bairro

analysis_result.bairro

Em CARTÃO_CNPJ.

string

Município

analysis_result.municipio

Em CARTÃO_CNPJ.

string

UF

analysis_result.uf

Em CARTÃO_CNPJ.

string

E-mail

analysis_result.email

Em CARTÃO_CNPJ.

string

Telefone

analysis_result.telefone

Em CARTÃO_CNPJ.

string

Situação cadastral

analysis_result.situacao_cadastral

Em CARTÃO_CNPJ.

string

Porte

analysis_result.porte

Em CARTÃO_CNPJ.

string

Capital social (MEI)

analysis_result.capital_social

Em CARTÃO_CNPJ.

string

Capital social (número)

analysis_result.capital_social_int

Em CONTRATO_SOCIAL.

integer

Capital social (como escrito)

analysis_result.capital_social_str

Em CONTRATO_SOCIAL.

string

Sócios

analysis_result.socios

Em CONTRATO_SOCIAL.

object

Exemplo de resposta

Modelo de resposta: DocumentReadOutput
JSON · response
{
  "success": true,
  "code": 200,
  "code_message": "A requisição foi processada com sucesso.",
  "errors": [],
  "header": null,
  "data_count": 1,
  "data": [
    {
      "document_type": "CNH",
      "filename": "cnh.jpg",
      "analysis_result": {
        "is_valid": true,
        "nome": "FULANO DE TAL DA SILVA",
        "numero_registro": "01234567890",
        "cpf": "123.456.789-09",
        "nacionalidade": "BRASILEIRO",
        "doc_identidade": "12345678",
        "org_emissor": "SSP SP",
        "data_emissao": "14/03/2024",
        "validade": "14/03/2034",
        "filiacao1": "JOSE DE TAL DA SILVA",
        "filiacao2": "MARIA DE TAL DA SILVA"
      }
    }
  ]
}

Casos de uso

Onboarding sem digitação

O cliente fotografa a CNH e o formulário já vem preenchido: nome, CPF, filiação e validade, sem digitar nada.

Conferência de cadastro

Comparar o que o documento diz com o que o cliente declarou e levantar a divergência antes da aprovação.

Leitura de contrato social

Extrair capital social e sócios do contrato para instruir análise de crédito ou KYC de pessoa jurídica.

Notas de integração

  • Cobrada por requisição e por token: documento de muitas páginas consome mais. O custo típico ao lado do preço é a média real dos últimos 30 dias.