Heimdall APIs
  1. Brazil
Heimdall APIs
  • About
  • Authentication
    • Intro
    • Get access token
      POST
  • KYC
    • Query person status
      POST
    • Query person status simple
      POST
    • Query person CAP BR
      POST
    • Query person PEP BR
      POST
    • Get query result
      GET
  • Brazil
    • Zip code/CEP
      GET
  1. Brazil

Zip code/CEP

Developing
GET
/v1/brazil/zip/{zip}

Request

Authorization
Add parameter in header
x-api-key
Example:
x-api-key: ********************
Path Params
zip
string 
required

Responses

🟢200Success
application/json
Body
zip
string 
required
state
string 
required
city
string 
required
district
string 
required
street
string 
required
Example
{
  "zip": "22021001",
  "state": "",
  "city": "",
  "district": "",
  "street": ""
}
Modified at 2024-10-28 19:55:43
Previous
Get query result