latestOpenAPI 3.1.02026-07-2440101174.2 KB

e20afa10cd0e

Endereços

Consulta de endereço por CEP

Realize consultas de endereços através do código postal.

get/addresses/{zipCode}

Path parameters

zipCodestring nullable required

Código postal correspondente ao endereço.

Example:05402100

Código postal correspondente ao endereço.

Parameters

#/paths/~1banklist/get/parameters/5 — unresolved $ref
#/paths/~1banklist/get/parameters/6 — unresolved $ref

Response

Recurso encontrado

zipCodestring required

Código postal correspondente ao endereço. Informe somente números.

addressLinestring required

Logradouro (nome da rua, avenida etc.).

neighborhoodstring required

Nome do bairro ou distrito.

citystring required

Nome da cidade.

statestring required

Sigla do estado brasileiro, conforme a ISO 3166-2:BR. 'AC','AL','AM','AP','BA','CE','DF','ES','GO','MA','MG','MS','MT','PA','PB','PE','PI','PR','RJ','RN','RO','RR','RS','SC','SE','SP','TO'

countrystring required

Sigla do país (Brasil), conforme a ISO 3166-2. Exemplo: BR.

cityCodestring required

Código do município, conforme a tabela do IBGE. Exemplo: 3550308.