APIS em Destaque / Registros de Referência

CEP - Cadastro Base de Endereço

Ministério da Gestão e da Inovação em Serviços Públicos - Secretaria de Governo Digital (MGI/SGD)

Versão 1.0 - 01/10/2020

Base / Sistema: Código de Endereçamento Postal – CEP

Disponível via Conecta
Federal Estadual Municipal

O Cadastro Base de Endereço foi instituído pela Resolução nº 05 de 12 de janeiro de 2021 do CCGD (Comitê Central de Governança de Dados), e define um conjunto mínimo de dados para identificação de um endereço. Para a instituição deste cadastro em específico foi celebrado um acordo com a Empresa Brasileira de Correios e Telégrafos (ECT), que são os atuais gestores dos dados.

A API do Cadastro Base de Endereço proporciona a interoperabilidade e a integração no uso do conjunto mínimo de dados de endereço, que atualmente conta com dados vinculados ao CEP, visando facilitar o acesso ao conjunto de dados necessário pelos Órgãos e Entidades da Administração Pública Federal Direta, Autárquica e Fundacional e demais Poderes da União, bem como integrantes da Rede Gov.br e demais interessados em suas iniciativas para um Governo 100% integrado, sendo mais um instrumento para impulsionar a transformação digital no Estado brasileiro.

 

Qual o Impacto desta API?

O Impacto estimado da Interoperabilidade deste serviço público é de R$ 3,62.

Para maiores informações sobre a metodologia de Cálculo de Impacto da Interoperabilidade, acesse:  https://www.gov.br/governodigital/pt-br/governanca-de-dados/calculadora-de-impacto

 

O que é uma API?

API é a sigla em inglês para Application Programming Interface, ou interface de programação de aplicações. As interfaces de programação de aplicativos (APIs) são conjuntos de ferramentas, definições e protocolos para a criação de aplicações de software. APIs conectam soluções e serviços, sem a necessidade de saber como esses elementos foram implementados.

Principais Operações

Consultar CEP (Endereço)
GET https://apigateway.conectagov.estaleiro.serpro.gov.br/api-cep/v1/consulta/cep/
Parâmetros de Entrada CEP

Número do CEP (08 dígitos) a ser consultado para retorno do conjunto mínimo de dados do endereço vinculado

Parâmetros de Saída CEP

Código de endereçamento postal (08 dígitos)

Tipo CEP

Tipo de endereçamento postal de acordo com sua finalidade. Ex.: Localidade, Logradouro, Unidades Operacional dos Correios, Grande Usuário, Caixa Postal Comunitária.

Subtipo CEP

Subtipo de endereçamento postal

UF

Sigla da Unidade da Federação

Cidade

Nome da cidade

Bairro

Comunidade ou região dentro de uma cidade ou município

Endereço

Logradouro (empregado para se referir a uma rua, endereço ou um espaço público que compõe uma cidade)

Complemento

Complemento do endereço

Código IBGE

Código do município na base de dados de município do IBGE. O Código IBGE só é retornado para o tipo de endereçamento "Localidade", os demais tipos não retornam este atributo..

Endpoints

Produção
https://apigateway.conectagov.estaleiro.serpro.gov.br/api-cep/v1/consulta/cep/
Homologação
https://h-apigateway.conectagov.np.estaleiro.serpro.gov.br/api-cep/v1/consulta/cep/
Como Acessar

Para órgão Público Federal, Estadual e Municipal, siga as instruções de adesão ao Conecta gov.br

Quero acessar
Contato do Responsável

Diretoria de Infraestrutura de Dados - DEDAD/SGD/MGI

(61) 2020-2088/2255

Horário comercial