CPFHub.io API
67
AI ReadinessAI-Aware (B+)67/100
Official vendor OpenAPI document · agent-readyIdentity AuthIdentity VerificationapiKey5 EndpointsREST
For Agents
Look up the name, gender, and date of birth tied to a Brazilian CPF, singly, in bulk, or in real time against the Receita Federal. Authenticated with an apiKey in the x-api-key header across 5 operations.
Use for: Look up the holder name for a Brazilian CPF, Submit a batch of CPFs for asynchronous lookup, Check whether a CPF is valid in real time against the Receita Federal, Get the status and results of a bulk CPF job
Not supported: Does not handle CNPJ company lookups, document capture, or biometric checks. Use for Brazilian CPF registration lookups only.
The CPFHub.io API looks up the registration data tied to a Brazilian CPF, returning the full name, gender, and date of birth for the holder. It offers a simple single lookup, an asynchronous bulk job for many CPFs at once, and a real-time check that queries the Receita Federal with the CPF and date of birth to return the record's current status. A quota endpoint reports the remaining credit balance and plan so an agent can pace its lookups.
Install Jentic One Beta
Connect the CPFHub.io API to your agent
Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the CPFHub.io API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.
Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.
1
Step 1: Jentic One Host machine
# On the machine that will host your Jentic One instance:
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fcpfhub.io%2Fcpfhub" | sh2
Step 2: Agent machine
# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fcpfhub.io%2Fcpfhub" | sh
jentic register # connects your agent to your Jentic One instanceJentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.
Capabilities
What an agent can do with CPFHub.io API.
Look up the name, gender, and date of birth for a single Brazilian CPF
Submit a batch of CPFs for asynchronous lookup and poll the job status
Run a real-time check against the Receita Federal using the CPF and date of birth
Read the remaining credit balance and plan from the quota endpoint
Use Cases
Patterns agents use CPFHub.io API for, with concrete tasks.
★ CPF Identity Verification
An onboarding agent confirms a customer's identity by looking up the name, gender, and date of birth registered to their Brazilian CPF. For stronger assurance it runs the real-time check, which queries the Receita Federal with the CPF and date of birth and returns the record's current status.
Call GET /cpf/{cpf} to read the registered name, then POST /cpf/realtime with the CPF and date of birth to confirm status
Bulk CPF Enrichment
A back-office agent enriches a list of customer records by submitting their CPFs as an asynchronous batch. It polls the job for results as they settle, each lookup returning the same registration fields as a single query, so large lists are processed without a request per record.
Call POST /cpf/bulk with the list of CPFs, then GET /cpf/bulk/{jobId} to read the results as they complete
AI Agent Integration via Jentic
An AI agent reaches the CPFHub.io API through Jentic without handling the apiKey header itself. It searches by intent, receives the matching operation and its input schema, and executes the lookup with the credential injected at run time, checking its quota first so it does not exhaust the plan balance.
Search Jentic for 'look up a Brazilian CPF', load the GET /cpf/{cpf} schema, and execute it with Jentic-managed credentials
Key Endpoints
5 endpoints — the cpfhub.
METHOD
PATH
DESCRIPTION
GET
/cpf/{cpf}
Single CPF lookup
POST
/cpf/bulk
Submit a batch of CPFs for asynchronous lookup
GET
/cpf/bulk/{jobId}
Read the status and results of a bulk job
POST
/cpf/realtime
Real-time check against the Receita Federal
GET
/quota
Read the remaining credit balance and plan
GET
/cpf/{cpf}
Single CPF lookup
POST
/cpf/bulk
Submit a batch of CPFs for asynchronous lookup
GET
/cpf/bulk/{jobId}
Read the status and results of a bulk job
POST
/cpf/realtime
Real-time check against the Receita Federal
GET
/quota
Read the remaining credit balance and plan
Jentic AI Readiness Score
This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.
C
CPFHub.io API
- AI-Aware (B+)67/100
82
Foundational Compliance80
Developer Experience & Jentic Compatibility48
AI-Readiness & Agent Experience94
Agent Usability50
Security85
AI DiscoverabilityPowered by JenticScoring Framework 1.0.0 | Scoring Engine 0.4.2
Show dimension breakdown
82
Foundational Compliance
Base layer of spec validity and structural soundness.
Grade: ASignals: 4
99%
Lint Results
Aggregated quality score from linter diagnostics, weighted by severity.
100%
Resolution Completeness
Percentage of `$ref` references that resolve successfully.
100%
Specification Validity
Checks whether the API description parses successfully and conforms to its declared specification (e.g., OpenAPI).
30%
Structural Integrity
Structural correctness score based on schema issues using logarithmic dampening.
80
Developer Experience & Jentic Compatibility
Clarity, completeness, and ingestion readiness for developers and tooling.
Grade: ASignals: 4
47%
Example Density
How richly the API is illustrated with examples.
100%
Example Validity
Percentage of examples that conform to their schemas.
75%
Response Coverage
Percentage of operations with complete response definitions (success, client error, server error).
100%
Tooling Readiness
Health of API ingestion, bundling, and resolution within Jentic pipelines.
48
AI-Readiness & Agent Experience
Semantic breadth, depth, and agent comprehension for AI systems.
Grade: D+Signals: 4
77%
Description Coverage
Coverage of descriptions across API elements.
0%
Error Standardization
Coverage of RFC 9457 Problem Details for error responses.
100%
OperationId Quality
Coverage, uniqueness, and casing consistency of operationIds for AI inference.
15%
Summary Coverage
Coverage of summaries across operations/tags/info.
94
Agent Usability
Functional utility, complexity comfort, and AI orchestration readiness.
Grade: A+Signals: 1
94%
Complexity Comfort
Agent comfort level based on API operational and structural complexity.
50
Security
Trust, risk posture, and security compliance.
Grade: C-Signals: 1
50%
Authentication Strength
Average quality of security schemes based on authentication method strength (weakest link for OAuth2).
85
AI Discoverability
Findability, semantic richness, and reasoning readiness.
Grade: ASignals: 1
85%
Descriptive Richness
Clarity and depth of descriptions across API elements.
Score it yourself
Every API in the directory is allowlisted, so you can re-score it with no key required.
npx @jentic/api-scorecard-cli score <openapi-url>Why Jentic?
What agents get from Jentic-routed access to this vendor.
Setup
Wiring CPFHub.io by hand means sending its apiKey in the x-api-key header to api.cpfhub.io and handling the asynchronous bulk job polling yourself. Through Jentic you install once, import CPFHub.io from the API Directory, store the key once, and your agent calls it.
Permission scoping
This API is a small, read-only set of lookups, so a rule can allow just the single CPF query the agent needs while withholding the bulk job and the real-time Receita Federal check. You decide which lookups it may call, so it reads registration data and nothing more.
Credential isolation
Your CPFHub.io key is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
Intent-based discovery
Agents search Jentic by intent such as 'look up a Brazilian CPF' or 'verify a CPF in real time', and Jentic returns the matching CPFHub.io operation with its input schema so the agent calls the right endpoint without browsing the reference docs.
Related APIs
Alternatives and complements available in the Jentic catalogue.
FAQs
Specific to using CPFHub.io API through Jentic.
What authentication does the CPFHub.io API use?
The CPFHub.io API authenticates with an apiKey sent in the x-api-key header per its OpenAPI spec. Through Jentic the key is stored encrypted by your own Jentic One instance and injected at execution time, so it never enters the agent's context.
Can I verify a CPF in real time with the CPFHub.io API?
Yes. The real-time endpoint queries the Receita Federal with the CPF and the holder's date of birth and returns the record's current status, while the single lookup reads the name, gender, and date of birth from the CPFHub.io base. Responses are structured JSON an agent can act on directly.
Can I look up many CPFs at once with the CPFHub.io API?
Yes. Submit the CPFs with the bulk endpoint to start an asynchronous job, then poll the job by its id to read results as they settle. Each lookup returns the same registration fields as a single query, so large lists avoid one request per record.
How do I look up a CPF through Jentic with the CPFHub.io API?
Search Jentic for 'look up a Brazilian CPF', and it returns the CPFHub.io single-lookup operation with its input schema. Load the schema and execute GET /cpf/{cpf} with the credential injected at run time. To run it on your own infrastructure, install Jentic One from its GitHub repo.
Can I limit what my agent is allowed to do with the CPFHub.io API?
Yes. Write a rule that allows only the lookups the agent needs, for example the single CPF query, while leaving out the bulk job or the real-time Receita Federal check unless you add them. Each call runs through your own instance and is logged for review.
GET STARTED