Brazil
| Property | Value |
|---|---|
| Code | BR |
| Currency | BRL |
| Region | Americas, South America |
| Name order | Given name first |
| State | State/province, a list of 27 |
| Postcode | Required, checked, like 01310-100, and by state |
| Rules | GET /v1/countries/BR |
Form
The address form, in English. A field that is not required shows its optional label.
Fields
| Field | Label | Required | Autocomplete |
|---|---|---|---|
country | Country (list) | yes | country |
first_name | First name | yes | given-name |
last_name | Last name | yes | family-name |
postcode | Postal code | yes | postal-code |
line1 | Address | yes | address-line1 |
line2 | Apartment, suite, etc. | no | address-line2 |
city | City | yes | address-level2 |
state | State/province (list) | yes | address-level1 |
phone_number | Phone number | no | tel |
email | yes | email |
Postcode
| Rule | Value |
|---|---|
| Required | yes |
| Pattern | ^[0-9]{5}([0-9]{3})?$ |
| Example | 01310-100 |
| Written as | #####, #####-### |
| Checked by state | 27 of 27, below |
POST /v1/validate refuses a postcode sent with a state it does not start like, as not_in_state. A state not listed is checked by pattern only. From libaddressinput.
| State | Starts with |
|---|---|
| Acre | 699 |
| Alagoas | 57 |
| Amapá | 689 |
| Amazonas | 69[0-24-8] |
| Bahia | 4[0-8] |
| Ceará | 6[0-3] |
| Distrito Federal | 7[0-1]|72[0-7]|73[0-6] |
| Espírito Santo | 29 |
| Goiás | 72[89]|73[7-9]|7[4-6] |
| Maranhão | 65 |
| Mato Grosso | 78[0-8] |
| Mato Grosso do Sul | 79 |
| Minas Gerais | 3 |
| Paraná | 8[0-7] |
| Paraíba | 58 |
| Pará | 6[6-7]|68[0-8] |
| Pernambuco | 5[0-6] |
| Piauí | 64 |
| Rio Grande do Norte | 59 |
| Rio Grande do Sul | 9 |
| Rio de Janeiro | 2[0-8] |
| Rondônia | 76[89] |
| Roraima | 693 |
| Santa Catarina | 8[89] |
| Sergipe | 49 |
| São Paulo | [01][1-9] |
| Tocantins | 77 |
Phone
| Rule | Value |
|---|---|
| Calling code | +55 |
| National prefix | 0 |
| Pattern | ^[0-9]{8,12}$ |
| Example | (11) 96123-4567 |
| Written as | (##) #####-#### |
Address format
How an address is written for reading, on an order page, a receipt or a label: address.format in the rules.
{first_name} {last_name}
{line1}
{line2}
{city}-{state}
{postcode}
{country}On an envelope, the city and state/province are written in capitals.
Example
A real address in Brazil, from address.example, written with the format and the state by its name:
João Silva
Praça dos Três Poderes
Palácio do Congresso Nacional
Brasília-Distrito Federal
70160-900
BrazilState/province
The form submits the code, which is what an order stores; the name is what the shopper reads, in their language.
| Code | Name |
|---|---|
Acre | Acre |
Alagoas | Alagoas |
Amapá | Amapá |
Amazonas | Amazonas |
Bahia | Bahia |
Ceará | Ceará |
Distrito Federal | Distrito Federal |
Espírito Santo | Espírito Santo |
Goiás | Goiás |
Maranhão | Maranhão |
Mato Grosso | Mato Grosso |
Mato Grosso do Sul | Mato Grosso do Sul |
Minas Gerais | Minas Gerais |
Paraná | Paraná |
Paraíba | Paraíba |
Pará | Pará |
Pernambuco | Pernambuco |
Piauí | Piauí |
Rio Grande do Norte | Rio Grande do Norte |
Rio Grande do Sul | Rio Grande do Sul |
Rio de Janeiro | Rio de Janeiro |
Rondônia | Rondônia |
Roraima | Roraima |
Santa Catarina | Santa Catarina |
Sergipe | Sergipe |
São Paulo | São Paulo |
Tocantins | Tocantins |
Messages
What the form shows under a field when a value is refused, in English. Every language is on its page under Languages.
| Field | Error | Message |
|---|---|---|
country | not_selected | Select a country |
first_name | blank | Enter a first name |
first_name | invalid_characters | First name can only contain letters, spaces, hyphens and apostrophes |
first_name | contains_emoji | First name can't contain emojis |
first_name | too_long | First name must be 255 characters or fewer |
last_name | blank | Enter a last name |
last_name | invalid_characters | Last name can only contain letters, spaces, hyphens and apostrophes |
last_name | contains_emoji | Last name can't contain emojis |
last_name | too_long | Last name must be 255 characters or fewer |
postcode | blank | Enter a postal code |
postcode | invalid | Enter a valid postal code, like 01310-100 |
postcode | contains_emoji | Postal code can't contain emojis |
postcode | too_long | Postal code must be 64 characters or fewer |
line1 | blank | Enter an address |
line1 | contains_emoji | Address can't contain emojis |
line1 | too_long | Address must be 255 characters or fewer |
line2 | blank | Enter address line 2 |
line2 | contains_emoji | Address line 2 can't contain emojis |
line2 | too_long | Address line 2 must be 255 characters or fewer |
city | blank | Enter a city |
city | invalid | Enter a valid city |
city | contains_emoji | City can't contain emojis |
city | too_long | City must be 255 characters or fewer |
state | not_selected | Select a state or province |
state | invalid | Choose a state or province from the list |
state | contains_emoji | State or province can't contain emojis |
state | too_long | State or province must be 255 characters or fewer |
phone_number | blank | Enter a phone number |
phone_number | invalid | Enter a valid phone number, like (11) 96123-4567 |
phone_number | contains_emoji | Phone number can't contain emojis |
phone_number | too_long | Phone number must be 24 characters or fewer |
email | blank | Enter an email address |
email | invalid | Enter a valid email, like name@example.com |
email | contains_emoji | Email can't contain emojis |
email | too_long | Email must be 254 characters or fewer |