Skip to main content
GET
Get zipcode information

Authorizations

Authorization
string
header
required

JWT token for user authentication

Path Parameters

id
string
required

The zipcode to lookup (5-9 digits)

Pattern: ^[0-9]{5,9}$

Response

Zipcode information retrieved successfully

zipcode
string
required
Example:

"13306582"

street
string
required
Example:

"Rua Ana Rosa de Jesus dos Santos"

neighborhood
string
required
Example:

"Jardim Villas do Golf"

city
string
required
Example:

"Itu"

state
string
required
Example:

"SP"