Documentos

Leitura de cartão CNPJ - data de emissão

Confere se o cartão CNPJ foi emitido neste ano e devolve a data de emissão.

OCRtempo real
POST/api/v1/oracle/document/validate

Sobre esta API

Confere se o cartão CNPJ foi emitido no ano corrente e devolve a data de emissão com o parecer.

Envie a imagem ou o PDF do cartão em file. Cartão sem data de emissão, como o do MEI, é aprovado.

Não extrai os dados do cartão: para isso, use a Leitura de documentos com document_type=CARTÃO_CNPJ.

Tecnologia

OCR com visão computacional · Atualização: tempo real

Requisição

POST /api/v1/oracle/document/validate

Autenticação HTTP Basic: public_key:secret_key em Base64. Guarde a chave secreta no servidor.

CabeçalhoDescrição
Authorization
Obrigatório
Chave de API em Basic: public_key:secret_key em Base64.
X-Project-Id
Opcional
Projeto que recebe a chamada. Sem ele, vale o projeto padrão da conta.
Idempotency-Key
Opcional
Repetir a mesma chave em até 24 horas devolve a resposta anterior, sem executar nem cobrar de novo.

Parâmetros

CampoTipo e localDescrição
file
Obrigatório
filefileImagem ou PDF do cartão CNPJ.
curl --request POST 'https://api.apifordevs.com/api/v1/oracle/document/validate' \
  --user "afd_live_pk_...:$AFD_SECRET_KEY" \
  --header "X-Project-Id: $AFD_PROJECT_ID" \
  --form 'file=@./file.jpg'

Campos de resposta

Campos e tipos publicados no catálogo desta API.

Tipo de documentodocument_typestring
Arquivo enviadofilenamestring
Parecer da validaçãovalidation_resultobject
Parecer da validação. Em faturamento, os meses vêm consolidados.
Documento reconhecidovalidation_result.is_validstring
Data de emissãovalidation_result.data_emissaostring
Data da conferênciavalidation_result.data_atualstring
Parecervalidation_result.descricaostring

Exemplo de resposta

{
  "success": true,
  "code": 200,
  "code_message": "A requisição foi processada com sucesso.",
  "errors": [],
  "header": null,
  "data_count": 1,
  "data": [
    {
      "document_type": "CARTÃO_CNPJ",
      "filename": "cartao-cnpj.pdf",
      "validation_result": {
        "is_valid": "true",
        "data_emissao": "05/01/2026",
        "data_atual": "09/10/2026",
        "descricao": "Documento válido"
      }
    }
  ]
}

Respostas e cobrança

HTTPDescriçãoCobrança
200Sucesso.Sujeita à cobrança
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.Sem cobrança
401

unauthorized

Credencial ausente, inválida ou revogada.Sem cobrança
402

payment_required

Saldo insuficiente ou limite de gasto diário atingido.Sem cobrança
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.Sem cobrança
409

conflict

Requisição com a mesma Idempotency-Key ainda em andamento.Sem cobrança
413

payload_too_large

Arquivo acima de 20 MB.Sem cobrança
422

validation_error

Parâmetro obrigatório ausente ou fora do formato, ou Idempotency-Key repetida com outro conteúdo.Sem cobrança
429

rate_limit_exceeded

Limite de requisições por minuto da chave atingido.Sem cobrança
500

internal_error

Falha interna.Sem cobrança
503

service_unavailable

Serviço desativado ou temporariamente indisponível.Sem cobrança

Casos de uso

Comprovante atualizado

Aceitar no cadastro de fornecedor só o cartão CNPJ emitido no ano, sem conferir a data à mão.

Prova documental

Guardar o parecer junto do arquivo, para auditoria do que foi apresentado no momento do cadastro.

SUA PRÓXIMA ENTREGA

Qual é a sua próxima integração?

Encontre a API que resolve o próximo passo do seu produto.