Começar

Introdução

Integre consultas de CPF, CNPJ, veículos, telefone e e-mail diretamente na sua aplicação. Uma API REST com autenticação por chave e respostas em JSON.

Visão geral

Protocolo — HTTPS, padrão REST
Autenticação — cabeçalho Authorization: Bearer SUA_API_KEY
Base URL — https://alpes24.com/api/desenvolvedor/consultas
Cobrança — consultas sem resultado não são cobradas

Primeira requisição

Vamos consultar um CPF. Escolha a linguagem no bloco abaixo.

Resposta

JSON

Formato de resposta

Toda resposta segue o mesmo envelope: success indica se houve dados, data traz o conteúdo (um objeto ou uma lista, conforme o endpoint), message descreve o resultado e, quando success é false, error diz o motivo em poucas palavras.

Sucesso

Sem resultado · 200

Erro

Importante

Documento não encontrado não é erro: vem como 200 com error: "Sem resultado" e não é cobrado. Erros de verdade usam o status HTTP (veja Códigos de erro).