CPFHub.io

使用 Node.js 查询巴西 CPF

使用原生 fetch 在 Node.js 中查询 CPF(巴西个人税号)。无外部依赖,适用于 Node.js 18+。

正在使用 Cursor、Lovable、v0 或其他 AI 工具? 复制标准查询的提示词,粘贴到您的 AI 助手中。

在 Cursor 中打开

准备工作

  1. 在 app.cpfhub.io 免费创建账户。免费版包含 50 个积分,无需信用卡。
  2. 在 app.cpfhub.io/api-keys 复制您的 API 密钥。
  3. 将密钥保存在环境变量中,不要写进代码:
bash
export CPFHUB_API_KEY="your_api_key"

示例

JavaScript
// cpf-lookup.mjs
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, body.data.birthDate)
} else if (res.status === 404) {
  console.log('CPF not found (does not use a credit)')
} else if (res.status === 429) {
  console.log(`Per-minute limit reached. Try again in ${res.headers.get('retry-after')} s`)
} else {
  // error comes as text ("...") or as an object ({ message: "..." })
  const error = typeof body.error === 'string' ? body.error : body.error?.message
  throw new Error(`Error ${res.status}: ${error}`)
}

保存为 cpf-lookup.mjs,然后使用 node cpf-lookup.mjs 运行。.mjs 扩展名允许在文件顶层使用 await。

响应

查到 CPF(200,消耗 1 个积分):

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
  }
}

未查到 CPF(404,不消耗积分):

JSON
{
  "success": false,
  "data": null,
  "error": { "message": "CPF não encontrado na base de dados" }
}

CPF 12345678909 为虚构号码,仅用于示例。gender 可能为 null。error.message 的文本由 API 以葡萄牙语返回(意为“数据库中未找到该 CPF”)。

错误

状态码含义处理方式
404数据库中没有该 CPF按“未找到”处理。不消耗积分。
400 / 422CPF 不是 11 位数字或校验位无效修正输入。不消耗积分。
401缺少 API 密钥或密钥无效检查 CPFHUB_API_KEY 变量。
403积分已用完或账户未激活通过 GET /quota 查看余额,或在控制台充值。
429超出每分钟请求限制等待 Retry-After 响应头中的秒数,然后重试。
5xx临时故障几秒后重试。

error 字段可能是文本("error": "..."),也可能是对象("error": { "message": "..." }),取决于状态码。上面的示例已处理这两种格式。完整列表见错误代码。

下一步