Brasil API
Analytics & DataQuery Brazilian public data through Brasil API, a free and keyless service covering postal codes, company registry records, banks, and more. Agents validate and enrich Brazilian records without a vendor contract.
What This Integration Enables
Brasil API is free, open, and keyless. No account, no token, no per-call meter. That sounds like a footnote and it is actually the whole point, because it changes what you can afford to check. Most verification programs are designed around cost: check new vendors, check high-value payments, sample the rest. Remove the cost and the design constraint goes with it. An agent can re-derive every Brazilian record you hold, on a schedule, against the source that published it.
The surface is the Brazilian public data estate. Postal codes resolve to full street addresses, with a multi-provider fallback chain so a single provider outage does not stop the flow, and optionally with coordinates and a timezone. CNPJs resolve to the Receita Federal open registration record: legal and trade name, status, CNAE activity codes, share capital, address, and the full partner list. Banks, PIX participants, and CVM brokerage firms resolve by code so payment routing is checked rather than assumed. Beyond that sit national holidays for business-day math, FIPE vehicle prices, IBGE states and municipalities, telephone area codes, PTAX exchange rates, Selic and CDI and IPCA, NCM product classification codes, .br domain status, ISBN book records, and CPTEC weather and ocean forecasts. Together these are the reference layer that Brazilian operations quietly depend on and rarely check.
Without FlowRunner
With FlowRunner
Use Case Scenarios
Vendor Master Drift Sweep
A vendor record is correct on the day it is created and slowly stops being correct. Companies change registered address, change legal name, and change registration status, and none of that reaches your ERP. On a schedule, the agent walks the Brazilian vendor master and runs Look Up Company By CNPJ against every record. It compares the registered legal name, the CNAE codes, the address, and the registration status to what the ERP holds, then runs Look Up Postal Code on the CEP to check that the street and city on the record agree with the postal source. The output is not a pass or fail per vendor, it is a diff: here are the records where the state's version and your version have separated, ranked by how much the difference matters to a payment. The controller reviews the diff instead of auditing a master file nobody has time to audit.
Checkout Address Completion
A Brazilian customer types a CEP into a checkout form on Shopify or WooCommerce. The agent runs Look Up Postal Code and returns street, neighborhood, city, and state so the customer confirms rather than types. Where the order routes to a carrier that needs coordinates, Look Up Postal Code With Geolocation supplies latitude, longitude, and the IANA timezone in the same step, with the caveat that those coordinates are a best-effort hint from third-party sources rather than a surveyed position. Look Up Area Code resolves the phone number's DDD to a state so the agent can flag an order whose stated address and phone region do not belong to each other, which is a cheap and useful fraud signal.
Payout Batch on a Real Business Calendar
Before a supplier payout batch runs, the agent builds the settlement calendar from List National Holidays, including the movable feasts that derive from Easter, so a payment is not scheduled into Carnival. For each payee it confirms the routing institution with Get Bank and checks List PIX Participants for the current business day. It then re-runs Look Up Company By CNPJ on every payee in the batch. If a payee's registration status is no longer active, the agent does not drop the payment and it does not push it through. It pulls that line out of the batch, releases the rest, and puts the held line in front of a person with the registry record attached.
Human-in-Loop Highlight
The lookups here are read-only. The dangerous operation is the one that happens afterwards: writing the registry's version of the truth back over your vendor master. A sweep that finds four hundred differences and applies all four hundred is not verification, it is a mass overwrite of supplier data with no author. So the agent stages the corrections and stops. It posts to the finance channel: "Registry sweep found 412 differences across 1,180 Brazilian vendors. 38 changed registered address, 9 changed legal name, 6 are no longer active at Receita Federal, 359 are formatting only. Apply the 359 formatting corrections automatically, and review the 53 material ones?" The reviewer approves the safe class as a set, then walks the material ones individually, each with the ERP value and the registry value side by side. Only then does anything get written. This is human-in-the-loop applied where it belongs, on the write rather than on the read, so a free and unlimited data source never turns into an unreviewed bulk edit of the records your payments run on.
Agent Capabilities
30 actionsAddresses and Geography
6- Look Up Postal Code Resolves a Brazilian CEP into street, neighborhood, city, and state, reporting which upstream provider answered. The provider chain falls back automatically, so the step survives a single provider outage. Accepts eight digits with or without the hyphen.
- Look Up Postal Code With Geolocation Same resolution with latitude, longitude, and the IANA timezone attached. Used when a downstream carrier or routing engine needs coordinates. Treat the coordinates as a best-effort hint rather than a surveyed position.
- List States Returns all 27 federative units with IBGE code, two-letter abbreviation, region, and the latest population estimate. Used to populate selectors and to join regional data onto records keyed by UF.
- Get State Retrieves one federative unit by either its abbreviation or its IBGE code. Accepting both forms makes it the normalisation step for state references arriving in mixed formats from different systems.
- List Municipalities Returns the municipalities of a state with their IBGE codes. Pin a specific source provider when you need the same IBGE codes to come back run after run.
- Look Up Area Code Resolves a DDD telephone area code to its state and the cities it covers. Used to derive a caller's region from a phone number, or to flag a record whose address region and phone region disagree.
Companies and Financial Institutions
6- Look Up Company By CNPJ Retrieves the public Receita Federal registration record for a company: legal and trade name, registration status, incorporation date, share capital, size, primary and secondary CNAE codes, address, phones, and the full partner and administrator list. The core verification call for any Brazilian counterparty.
- List Banks Lists every institution in the Brazilian banking system with compensation code, ISPB identifier, and names. Used to validate a bank code captured from a form before it reaches a payment file.
- Get Bank Retrieves one institution by compensation code, returning a not-found error for codes that are not registered. That not-found is the useful answer: it turns a typo into a caught exception rather than a failed transfer.
- List PIX Participants Lists institutions participating in PIX for the current or most recent business day, using Banco Central do Brasil data, with ISPB, names, modality, and participation type. Used to confirm an instant-payment route is live before it is used.
- List Brokerage Firms Lists every securities brokerage registered with the CVM, each with CNPJ, CVM code, status, contact details, and latest reported net equity. Used to build brokerage pickers and to reconcile counterparties in financial workflows.
- Look Up Brokerage Firm Retrieves a single CVM-registered brokerage by CNPJ. Returns a not-found error when the CNPJ does not belong to a registered brokerage, which is itself a verification result worth acting on.
Business Calendar
1- List National Holidays Lists Brazilian national public holidays for a year, including the movable feasts derived from the Easter date, for any year from 1900 to 2199. Used to build settlement and SLA calendars forward, and to reconcile dated records backward.
Rates and Indices
4- List Currencies Lists the foreign currencies quoted against the real by Banco Central do Brasil, with ISO 4217 symbol and central bank currency type. Supplies the symbol that Get Exchange Rate expects.
- Get Exchange Rate Retrieves the official PTAX bulletins for a currency on a given date, with buy and sell rates and parities. Data runs from 28 November 1984 onward, and weekend or holiday requests return the last available business day.
- List Interest Rates Lists the official Brazilian rates and indices currently published, such as Selic, CDI, and IPCA, with their current values. Used to feed contract indexation and dashboards.
- Get Interest Rate Retrieves one rate or index by acronym. Used when a contract clause names a single indicator and the flow needs that value alone.
Vehicle Prices
4- List FIPE Reference Tables Lists the FIPE reference tables available for historical pricing, pairing a table code with the month it represents. Pass a code to the other vehicle operations to price as of a past month.
- List Vehicle Brands Lists vehicle brands in the FIPE table with the brand codes that List Vehicle Models needs. Filter by vehicle type, or omit the type to span cars, motorcycles, and trucks.
- List Vehicle Models Lists every FIPE-catalogued model for a vehicle type and brand code. Supply a reference table code to read the catalogue as it stood in a past month.
- Get Vehicle Price Returns the official FIPE market price for a vehicle by FIPE code, with brand, model, model year, fuel type, and the reference month of the quotation. Used to settle valuation disputes against a published source rather than an opinion.
Product Classification and Domains
3- Search Product Classification Codes Searches the NCM catalogue used for Brazilian customs and tax classification, matching on code or product description, and returning each entry's validity period. Prefer a search term, since the full catalogue is large.
- Get Product Classification Code Retrieves one NCM entry by code, with description and validity dates. Used to check a classification on an invoice or product record before a fiscal document is submitted.
- Check Domain Availability Evaluates a .br domain through Registro.br, returning a status such as AVAILABLE, REGISTERED, UNAVAILABLE, or INVALID_QUERY, plus nameservers and expiry for registered names and free alternatives for unavailable ones.
Books
1- Look Up Book By ISBN Retrieves bibliographic detail from an ISBN-10 or ISBN-13: title, subtitle, authors, publisher, synopsis, year, page count, subjects, dimensions, suggested retail price, and cover image. With no providers selected, all sources are queried in parallel and the fastest answer wins.
Weather
5- Search Weather Cities Searches the CPTEC/INPE station catalogue by full or partial city name and returns the numeric city code that the forecast operations require.
- Get Capitals Weather Retrieves current conditions for every Brazilian state capital in one call, with temperature, humidity, wind, pressure, visibility, and sky condition. Used for national dashboards and bulk alerting without iterating city by city.
- Get Airport Weather Retrieves the current observation for a Brazilian airport by four-letter ICAO code, read from that airport's own meteorological station. Used in flight and freight workflows that need conditions at the field itself.
- Get Weather Forecast Retrieves a day-by-day CPTEC/INPE forecast for a city, up to six days ahead, with minimum and maximum temperature, UV index, and sky condition.
- Get Ocean Forecast Retrieves the CPTEC/INPE ocean forecast for a coastal locality at three-hour intervals, with wave height, wave and wind direction, wind speed, and a sea agitation description. Coastal city codes only.
Frequently Asked Questions
What can FlowRunner do with Brasil API?
FlowRunner agents can run Look Up Postal Code, Look Up Postal Code With Geolocation, and Look Up Company By CNPJ in Brasil API, plus 27 more actions.
Does connecting Brasil API to FlowRunner require OAuth?
No. Brasil API needs no credentials at all, so there is no key to obtain, store, or rotate.
Can Brasil API trigger a FlowRunner workflow automatically?
Brasil API doesn't currently expose triggers in FlowRunner. It connects as an action step inside workflows started by another trigger.
Start building with Brasil API
$100 in credits. No card required. Connect in minutes.