canonical: https://jentic.com/apis/cpfhub.io/cpfhub # CPFHub.io API 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. ## For AI 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. ## Scope Does not handle CNPJ company lookups, document capture, or biometric checks. Use for Brazilian CPF registration lookups only. ## Capabilities - 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 ### 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. Example prompt: 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. Example prompt: 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. Example prompt: Search Jentic for 'look up a Brazilian CPF', load the GET `/cpf/{cpf}` schema, and execute it with Jentic-managed credentials ## Key endpoints | 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 | ## Key resources - **CPF Lookup** — Single, bulk, and real-time CPF lookups under /cpf - **Quota** — Read the remaining credit balance and plan via /quota ## AI readiness 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. - **Score:** 67 / 100 - **Maturity:** AI-Aware - **Dimensions:** - Foundational Compliance: 82 / 100 - Developer Experience & Jentic Compatibility: 80 / 100 - AI-Readiness & Agent Experience: 48 / 100 - Agent Usability: 94 / 100 - Security: 50 / 100 - AI Discoverability: 85 / 100 - **View full report:** https://jentic.com/apis/cpfhub.io/cpfhub/scorecard - **How the score is calculated:** https://docs.jentic.com/reference/api-readiness-framework/overview/ - **More about the dimensions:** https://docs.jentic.com/reference/api-readiness-framework/specification/#dimensional-model-overview ### Score it yourself Every API in the directory is allowlisted, so you can re-score it with no key required. - **Score your own API:** https://jentic.com/scorecard.md - **Scoring CLI agent skill:** https://github.com/jentic/jentic-api-scorecard/blob/main/skills/jentic-api-scorecard/SKILL.md ```sh npx @jentic/api-scorecard-cli score ``` ## Why Jentic - **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 handling:** 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. - **Discovery method:** 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 - **Truora** — Latin American identity verification and background checks - **Onfido** — Document and biometric identity verification - **Veriff** — Automated identity verification with document and face matching ## FAQ ### 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.