Pular para o conteúdo

GET /v1/address/cep/{cep}

GET
/v1/address/cep/{cep}
curl --request GET \
--url https://seu-endereco-da-api/v1/address/cep/example \
--header 'Authorization: Bearer <token>'

Permissão que a Chave de acesso precisa: Ler contatos (contacts:read), ou Gerenciar a Central de apps (integrations:manage).

cep
required
string
Media typeapplication/json
object
cep
required

Os oito digitos, sem tracos

string
street
required

Vazio quando o CEP cobre a cidade inteira

string
neighborhood
required

Vazio quando os Correios nao tem o bairro dessa faixa

string
city
required
string
state
required

A sigla de duas letras

string

Example generated

{
"cep": "example",
"street": "example",
"neighborhood": "example",
"city": "example",
"state": "example"
}

Cep malformado ou desconhecido

A consulta de cep nao respondeu