CPF 验证

通过模11算法验证 CPF 号码的格式和校验位。

接口

POST /api/external/cpf/validate

请求头

请求头	类型	必填	说明
Authorization	String	是	ApiKey {client_id}:{client_secret}
Content-Type	String	是	application/json

请求体

字段	类型	必填	说明	示例
document_number	String	是	CPF 号码（可带或不带格式化符号）	"12345678909" 或 "123.456.789-09"

示例

curl -X POST https://api.owem.com.br/api/external/cpf/validate \
  -H "Authorization: ApiKey $CLIENT_ID:$CLIENT_SECRET" \
  -H "Content-Type: application/json" \
  -d '{"document_number":"12345678909"}'

成功响应 -- CPF 有效 (200)

{
  "worked": true,
  "valid": true,
  "formatted": "123.456.789-09"
}

成功响应 -- CPF 无效 (200)

{
  "worked": true,
  "valid": false,
  "formatted": null
}

字段	类型	说明
worked	Boolean	true 表示请求已处理
valid	Boolean	true 表示 CPF 有效，false 表示无效
formatted	String	格式化后的 CPF（XXX.XXX.XXX-XX），无效时为 null

执行的验证

1. 检查 CPF 是否恰好包含 11 位数字
2. 拒绝所有数字相同的 CPF（例如：111.111.111-11）
3. 使用模11算法计算并验证 2 位校验位

错误响应 (400)

{
  "worked": false,
  "detail": "O campo document_number e obrigatorio"
}

错误响应 (401)

{
  "error": {
    "status": 401,
    "message": "Missing API key credentials. Use Authorization: ApiKey <client_id>:<client_secret>"
  }
}

用途

此接口仅对 CPF 执行数学校验（模11算法）。不会查询巴西联邦税务局（Receita Federal），也不会验证证件的注册状态。