Consulta de endereço por CEP
stable
Este endpoint possibilita realizar consultas de endereços por meio de seu código postal.
Dica
Para consultar códigos postais brasileiros, recomendamos o Via CEP, serviço gratuito e de alto desempenho para a consulta de CEPs. Já no site Brasil API, o parceiro encontrará um endpoint moderno e com baixa latência para a busca de códigos postais, dentre outros serviços.
Requisição
Requisição HTTP
GET https://api-mtls.sandbox.bankly.com.br/addresses/{zipCode}
curl --request GET \
--url 'https://api-mtls.sandbox.bankly.com.br/addresses/68060100' \
--header 'accept: application/json' \
--header 'api-version: 1.0'
--header 'Authorization: {{token}}
Autorização
Para garantir a segurança nas requisições, todos os endpoints do Bankly utilizam scopes como parte do seu fluxo de autorização.
Esta requisição requer o scope descrito a seguir:
| Scope | Descrição |
|---|---|
zipcode.read | Concede acesso à consulta de endereços através do código postal. |
Cabeçalhos (Headers)
| Nome | Descrição |
|---|---|
api-version | Obrigatório. Versão da API. Atualmente estamos na versão 1.0. |
Authorization | Obrigatório. Token de autorização do tipo Bearer. |
Parâmetros da rota (Path)
No path desta requisição envie o seguinte campo:
| Nome | Tipo | Descrição |
|---|---|---|
zipCode | path | Obrigatório. Código postal correspondente ao endereço. Informe somente números. |
Corpo da requisição (Body)
Não é necessário enviar campos no body desta requisição.
Resposta (Response)
O status code 200 indicará sucesso na consulta.
Sendo bem-sucedido, o retorno irá trazer os seguintes campos em formato JSON:
| Nome | Tipo | Descrição |
|---|---|---|
zipCode | string | Código postal correspondente ao endereço. |
addressLine | string | Logradouro (nome da rua, avenida etc.). |
neighborhood | string | Nome do bairro ou distrito. |
city | string | Nome da cidade. |
state | string | Sigla do estado brasileiro conforme a ISO 3166-2:BR. Exemplo: MG. |
country | string | Sigla do país conforme a ISO 3166-2. Exemplo: BR. |
{
"zipCode": "68060100",
"addressLine": "Rua 6 de Março",
"neighborhood": "Alter do Chão",
"city": "Santarém",
"state": "PA",
"country": "BR"
}
Dica
Para simular uma requisição nesse endpoint, acesse o API Reference.
Erros
Este endpoint não retorna erros específicos. Porém, ele poderá retornar alguns erros comuns entre todos os endpoints.
Eventos
Este endpoint não possui eventos relacionados a ele.
Importante
O tempo máximo de resposta de nossas APIs é de 30 segundos.
Updated 6 months ago