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
  • Schemas
    • Schemas
      • Fields
        • Person ID (CPF)
        • fullName
        • motherFullName
        • Date of birth
        • Date of death
        • Webhook
        • personStatus
      • Query Result
      • Person
      • Person CAP
      • Person PEP
      • Person KYC
      • Person Verification
      • Verification
      • address
  1. Brazil

Zip code/CEP

Developing
GET
https://api.heimdall.watch/v1/brazil/zip/{zip}

Request

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

Responses

🟢200Success
application/json
Body

Example
{
    "zip": "22021001",
    "state": "",
    "city": "",
    "district": "",
    "street": ""
}
Modified at 2024-10-28 19:55:43
Previous
Get query result
Next
personId