CPFHub.io

Node.js vía HTTP

En Node.js 18+ no necesitas ningún paquete: el fetch nativo hace la consulta en pocas líneas, en JavaScript o TypeScript. El CPF es el número de identificación fiscal de personas físicas en Brasil.

ℹ

El SDK oficial para Node.js está en preparación. Mientras tanto, usa la llamada HTTP de abajo.

Consulta

TypeScript
const cpf = '12345678909'

const res = await fetch(`https://api.cpfhub.io/cpf/${cpf}`, {
  headers: { 'x-api-key': process.env.CPFHUB_API_KEY! },
  signal: AbortSignal.timeout(10_000),
})
const body = await res.json()

if (res.ok) {
  console.log(body.data.name)      // "Fulano de Tal"
  console.log(body.data.birthDate) // "15/06/1990"
} else if (res.status === 404) {
  // CPF no encontrado en la base de datos (no consume crédito)
} else {
  // error viene como texto ("...") o como objeto ({ message: "..." })
  const message = typeof body.error === 'string' ? body.error : body.error?.message
  throw new Error(`Error ${res.status}: ${message}`)
}

Respuesta exitosa (200):

JSON
{
  "success": true,
  "data": {
    "cpf": "12345678909",
    "name": "Fulano de Tal",
    "nameUpper": "FULANO DE TAL",
    "gender": "M",
    "birthDate": "15/06/1990",
    "day": 15,
    "month": 6,
    "year": 1990
  }
}

Errores

StatusSignificado
400CPF sin 11 dígitos
401Clave de API ausente o inválida
403Créditos agotados o cuenta inactiva
404CPF no encontrado en la base de datos (no consume crédito)
422Dígito verificador incorrecto
429Límite de solicitudes por minuto: espera los segundos indicados en el header Retry-After

Consulta la lista completa en Códigos de Error.

Próximos pasos