Skip to main content
GET
Lookup Zip Code

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

zipCode
string
required

Zip code

Example:

"04102000"

Query Parameters

fields
string

Comma-separated list of fields to include in the response. Supports dot notation for nested projection (e.g. id,name,user.email,trips.route.id). Unknown fields are silently dropped.

Response

OK

Address data resolved from zip code

city
string
required

City

Example:

"Sao Paulo"

country
string
required

Country

Example:

"BR"

state
string
required

State

Example:

"SP"

zipCode
any
required

Zip code

Example:

"01310-100"

neighborhood
string

Neighborhood

Example:

"Vila Mariana"

street
string

Street

Example:

"Rua das Palmeiras"