IZConnect API
Concentrador de APIs de dados cadastrais. Consulte informacoes de CPF, CNPJ e outros registros de forma rapida, com cache inteligente e uma unica integracao.
URL Base
Todas as requisicoes devem ser feitas para o seguinte endereco:
Autenticacao
Cada empresa recebe um token unico ao ser cadastrada no IZConnect. Este token deve ser enviado em todas as requisicoes aos endpoints protegidos.
Como enviar o token
X-API-Key: iz_seu_token_aqui
?api_key=iz_seu_token_aqui
Formato de Resposta
Todas as respostas sao retornadas em formato JSON com a seguinte estrutura padrao:
{
"success": true,
"message": "Descricao da operacao",
"data": { // dados retornados }
}
{
"success": false,
"error": "Descricao do erro"
}
Codigos de Status HTTP
- 200 Consulta realizada com sucesso
- 401 API Key nao fornecida ou invalida
- 404 Endpoint nao encontrado
- 422 Parametro obrigatorio ausente ou invalido
- 500 Erro interno do servidor
Health Check
Verifica se o servico esta online e o status da conexao com o banco de dados. Util para monitoramento e health checks automatizados.
curl -s https://izconnect.iztec.online/health
{
"success": true,
"message": "IZConnect esta operacional",
"data": {
"service": "IZConnect",
"version": "1.0.0",
"php": "8.3.30",
"database": "connected",
"timestamp": "2026-03-14 17:00:00"
}
}
Listar APIs Disponiveis
Lista todos os endpoints disponiveis no concentrador com seus parametros e metodos de autenticacao.
curl -s https://izconnect.iztec.online/apis
{
"success": true,
"message": "APIs disponiveis",
"data": {
"endpoints": [
{
"method": "GET",
"path": "/api/cpf",
"description": "Consulta dados basicos de pessoa fisica por CPF",
"params": { "cpf": "string (11 digitos)" },
"auth": "X-API-Key header ou ?api_key= query param"
}
]
}
}
Consulta CPF
Retorna dados basicos de pessoa fisica a partir do numero de CPF. O sistema utiliza cache inteligente: se o CPF ja foi consultado anteriormente, retorna do banco local (mais rapido e sem custo). Caso contrario, consulta a API externa, salva no cache e retorna.
source na resposta indica se veio do cache ou da api externa.Consulta dados de CPF via query parameter.
| Parametro | Tipo | Obrigatorio | Descricao |
|---|---|---|---|
| cpf | string | Sim | Numero do CPF com 11 digitos (somente numeros ou com mascara) |
curl -s \ -H 'X-API-Key: iz_SEU_TOKEN' \ 'https://izconnect.iztec.online/api/cpf?cpf=12345678901'
curl -s 'https://izconnect.iztec.online/api/cpf?cpf=12345678901&api_key=iz_SEU_TOKEN'
fetch('https://izconnect.iztec.online/api/cpf?cpf=12345678901', { headers: { 'X-API-Key': 'iz_SEU_TOKEN' } }) .then(r => r.json()) .then(console.log);
import requests response = requests.get( 'https://izconnect.iztec.online/api/cpf', params={'cpf': '12345678901'}, headers={'X-API-Key': 'iz_SEU_TOKEN'} ) print(response.json())
$ch = curl_init('https://izconnect.iztec.online/api/cpf?cpf=12345678901'); curl_setopt_array($ch, [ CURLOPT_RETURNTRANSFER => true, CURLOPT_HTTPHEADER => ['X-API-Key: iz_SEU_TOKEN'], ]); $response = json_decode(curl_exec($ch), true); curl_close($ch);
{
"success": true,
"message": "Consulta realizada com sucesso",
"data": {
"id": 1,
"cpf": "12345678901",
"nome": "JOAO DA SILVA SANTOS",
"data_nascimento": "15/03/1990",
"sexo": "M",
"nome_mae": "MARIA DA SILVA",
"nome_pai": "JOSE DOS SANTOS",
"situacao": "Regular",
"pis": "12345678901",
"ctps": "",
"titulo": "0012345678901",
"rg_numero": "12.345.678-9",
"rg_emissor": "SSP",
"rg_uf": "SP",
"produto": "pf-dadosbasicos",
"data_agora": "2026-03-14 17:00:00"
}
}
{
"success": false,
"error": "Token invalido ou empresa inativa"
}
{
"success": false,
"error": "Parametro \"cpf\" e obrigatorio"
}
| Campo | Tipo | Descricao |
|---|---|---|
| cpf | string | Numero do CPF (11 digitos) |
| nome | string | Nome completo do titular |
| data_nascimento | string | Data de nascimento (DD/MM/AAAA) |
| sexo | string | Sexo (M ou F) |
| nome_mae | string | Nome da mae |
| nome_pai | string | Nome do pai |
| situacao | string | Situacao cadastral na Receita Federal |
| pis | string | Numero do PIS/PASEP |
| ctps | string | Numero da CTPS |
| titulo | string | Numero do titulo de eleitor |
| rg_numero | string | Numero do RG |
| rg_emissor | string | Orgao emissor do RG |
| rg_uf | string | UF de emissao do RG |
Consulta CPF (POST)
Mesma consulta de CPF, porem recebendo o parametro via corpo da requisicao em JSON. Ideal para integracoes que preferem enviar dados via body.
| Parametro | Tipo | Obrigatorio | Descricao |
|---|---|---|---|
| cpf | string | Sim | Numero do CPF com 11 digitos |
curl -s -X POST 'https://izconnect.iztec.online/api/cpf' \ -H 'Content-Type: application/json' \ -H 'X-API-Key: iz_SEU_TOKEN' \ -d '{"cpf": "12345678901"}'
fetch('https://izconnect.iztec.online/api/cpf', { method: 'POST', headers: { 'Content-Type': 'application/json', 'X-API-Key': 'iz_SEU_TOKEN' }, body: JSON.stringify({ cpf: '12345678901' }) }) .then(r => r.json()) .then(console.log);
import requests response = requests.post( 'https://izconnect.iztec.online/api/cpf', json={'cpf': '12345678901'}, headers={'X-API-Key': 'iz_SEU_TOKEN'} ) print(response.json())
Consulta CNPJ
Retorna dados cadastrais de pessoa juridica a partir do numero de CNPJ. Inclui informacoes de situacao cadastral, endereco, atividade economica (CNAE), porte, capital social e MCC (quando disponivel). O sistema utiliza cache inteligente.
source na resposta indica se veio do cache ou da api externa.Consulta dados de CNPJ via query parameter.
| Parametro | Tipo | Obrigatorio | Descricao |
|---|---|---|---|
| cnpj | string | Sim | Numero do CNPJ com 14 digitos (somente numeros ou com mascara) |
curl -s \ -H 'X-API-Key: iz_SEU_TOKEN' \ 'https://izconnect.iztec.online/api/cnpj?cnpj=12345678000190'
fetch('https://izconnect.iztec.online/api/cnpj?cnpj=12345678000190', { headers: { 'X-API-Key': 'iz_SEU_TOKEN' } }) .then(r => r.json()) .then(console.log);
import requests response = requests.get( 'https://izconnect.iztec.online/api/cnpj', params={'cnpj': '12345678000190'}, headers={'X-API-Key': 'iz_SEU_TOKEN'} ) print(response.json())
$ch = curl_init('https://izconnect.iztec.online/api/cnpj?cnpj=12345678000190'); curl_setopt_array($ch, [ CURLOPT_RETURNTRANSFER => true, CURLOPT_HTTPHEADER => ['X-API-Key: iz_SEU_TOKEN'], ]); $response = json_decode(curl_exec($ch), true); curl_close($ch);
{
"success": true,
"message": "Consulta realizada com sucesso",
"data": {
"cnpj": "12345678000190",
"nome": "EMPRESA EXEMPLO LTDA",
"fantasia": "EXEMPLO",
"abertura": "01/01/2010",
"situacao": "ATIVA",
"tipo": "MATRIZ",
"porte": "MICRO EMPRESA",
"natureza_juridica": "206-2 - Sociedade Empresaria Limitada",
"cnae_codigo": "62.01-5-01",
"cnae_descricao": "Desenvolvimento de programas de computador sob encomenda",
"logradouro": "RUA EXEMPLO",
"numero": "123",
"complemento": "SALA 1",
"bairro": "CENTRO",
"municipio": "SAO PAULO",
"uf": "SP",
"cep": "01000-000",
"email": "contato@exemplo.com.br",
"telefone": "(11) 1234-5678",
"capital_social": "100000.00",
"mcc": 5734
}
}
{
"success": false,
"error": "Token invalido ou empresa inativa"
}
{
"success": false,
"error": "Parametro \"cnpj\" e obrigatorio"
}
| Campo | Tipo | Descricao |
|---|---|---|
| cnpj | string | Numero do CNPJ (14 digitos) |
| nome | string | Razao social |
| fantasia | string | Nome fantasia |
| abertura | string | Data de abertura |
| situacao | string | Situacao cadastral (ATIVA, BAIXADA, etc) |
| data_situacao | string | Data da situacao cadastral |
| tipo | string | Tipo (MATRIZ ou FILIAL) |
| porte | string | Porte da empresa |
| natureza_juridica | string | Natureza juridica |
| cnae_codigo | string | Codigo CNAE da atividade principal |
| cnae_descricao | string | Descricao do CNAE |
| logradouro | string | Logradouro |
| numero | string | Numero |
| complemento | string | Complemento |
| bairro | string | Bairro |
| municipio | string | Municipio |
| uf | string | UF |
| cep | string | CEP |
| string | E-mail da empresa | |
| telefone | string | Telefone |
| capital_social | string | Capital social |
| mcc | int|null | MCC (Merchant Category Code) baseado no CNAE, quando disponivel |
Consulta CNPJ (POST)
Mesma consulta de CNPJ, porem recebendo o parametro via corpo da requisicao em JSON.
| Parametro | Tipo | Obrigatorio | Descricao |
|---|---|---|---|
| cnpj | string | Sim | Numero do CNPJ com 14 digitos |
curl -s -X POST 'https://izconnect.iztec.online/api/cnpj' \ -H 'Content-Type: application/json' \ -H 'X-API-Key: iz_SEU_TOKEN' \ -d '{"cnpj": "12345678000190"}'
fetch('https://izconnect.iztec.online/api/cnpj', { method: 'POST', headers: { 'Content-Type': 'application/json', 'X-API-Key': 'iz_SEU_TOKEN' }, body: JSON.stringify({ cnpj: '12345678000190' }) }) .then(r => r.json()) .then(console.log);