Documentos
Leitura de comprovante de endereço
AtivaOCRRequisição e token● tempo real
POST
/api/v1/oracle/document/addressConfere se o arquivo é um comprovante de endereço (conta de luz, água, gás, telefone ou internet, fatura de cartão, correspondência de banco ou de órgão público, IPTU) e se ele é dos últimos 3 meses, e devolve titular, CPF/CNPJ, endereço completo e as datas.
Envie a imagem ou o PDF em file. O prazo conta da data de emissão; sem ela, do vencimento; sem os dois, do fim do mês de referência. is_valid só é true quando é comprovante e está no prazo, e descricao diz o motivo quando não está.
É leitura do documento enviado: não confirma o endereço em outra fonte.
Tecnologia: OCR com visão computacional · tempo real
Campos da resposta
Dados que esta API devolve em cada chamada.
Na página
Tipo de documento
document_typeArquivo enviadofilenameParecer e dados do comprovantevalidation_resultÉ comprovante de endereçois_proof_of_addressTipo de documentotipo_documentoEmissoremissorTitulartitularCPF/CNPJ do titularcpf_cnpj_titularLogradourologradouroNúmeronumeroComplementocomplementoBairrobairroCasos de uso
Onde esta API entra no seu processo.
Aceitar só comprovante recente e preencher o endereço do cadastro a partir dele.
Testar e integrar
Execute uma chamada e copie o código para a sua aplicação.
POST
https://api.apifordevs.com/api/v1/oracle/document/addressChave de API necessária · multipart/form-data · 30 req./min · Cobrança apenas em respostas 2xx
Autenticação
AuthorizationheaderInjetado automaticamenteChave de API em Basic: public_key:secret_key em Base64.
Sessão do painel · ••••••••
X-Project-IdheaderInjetado automaticamenteProjeto que recebe a chamada. Sem ele, vale o projeto padrão da conta.
Projeto selecionado no painel
Idempotency-KeyheaderOpcionalRepetir a mesma chave em até 24 horas devolve a resposta anterior, sem executar nem cobrar de novo.
Parâmetros
filefileObrigatório
Imagem, HEIC ou PDF do comprovante de endereço.
A simulação devolve um exemplo sem chamar o serviço nem cobrar. A execução pede confirmação antes da cobrança.
Execute a requisição para ver a resposta aqui.
Exemplos de requisição
curl -X POST 'https://api.apifordevs.com/api/v1/oracle/document/address?summary=true' \ -u "afd_live_pk_...:$APIFORDEVS_LIVE_SECRET" \ -H 'X-Project-Id: proj_...' \ -F 'file=@./YOUR_FILE'Exemplo de resposta
DocumentValidateOutput{ "success": true, "code": 200, "code_message": "A requisição foi processada com sucesso.", "errors": [], "header": null, "data_count": 1, "data": [ { "document_type": "COMPROVANTE_ENDERECO", "filename": "conta-de-luz.pdf", "validation_result": { "is_proof_of_address": true, "tipo_documento": "Conta de energia elétrica", "emissor": "Companhia de Energia", "titular": "FULANO DE TAL DA SILVA", "cpf_cnpj_titular": "529.982.247-25", "logradouro": "RUA EXEMPLO", "numero": "100", "complemento": "APTO 12", "bairro": "CENTRO", "municipio": "SAO PAULO", "uf": "SP", "cep": "01001-000", "data_emissao": "02/10/2026", "data_vencimento": "20/10/2026", "mes_referencia": "09/2026", "is_valid": true, "data_considerada": "02/10/2026", "base_da_data": "data_emissao", "dias_desde_a_data": 16, "dentro_do_prazo": true, "data_atual": "18/10/2026", "descricao": "Comprovante de endereço válido: emitido em 02/10/2026." } } ]}Códigos de resposta
| Status | errors[].code | Quando acontece | Cobrança |
|---|---|---|---|
| 200 | — | Sucesso. | Sim |
| 400 | bad_request, live_key_cannot_use_dev_mode | Arquivo ou parâmetro que a rota não consegue processar, projeto inválido, ou `dev_mode=true` com chave de produção. | Não |
| 401 | unauthorized | Credencial ausente, inválida ou revogada. | Não |
| 402 | payment_required | Saldo insuficiente ou limite de gasto diário atingido. | Não |
| 403 | forbidden, ip_not_allowed, test_key_cannot_run_live | E-mail da conta não verificado, chave sem escopo para o serviço, IP fora da allowlist do projeto ou chave de teste sem `dev_mode=true`. | Não |
| 409 | conflict | Requisição com a mesma `Idempotency-Key` ainda em andamento. | Não |
| 413 | payload_too_large | Arquivo acima de 20 MB. | Não |
| 422 | validation_error | Parâmetro obrigatório ausente ou fora do formato, ou `Idempotency-Key` repetida com outro conteúdo. | Não |
| 429 | rate_limit_exceeded | Limite de requisições por minuto da chave atingido. | Não |
| 500 | internal_error | Falha interna. | Não |
| 503 | service_unavailable | Serviço desativado ou temporariamente indisponível. | Não |
Preço por consultaR$ 0,1037