Consultar Situação Cadastral - permite a consulta da situação atual de uma pessoa no CadÚnico. Observação: para maiores informações, consultar o swagger da API.
Parâmetros de Entrada
|
Atributo
|
Descrição de Negócio
|
|
CPF
|
Número do CPF a ser consultado
|
Parâmetros de Saída
|
Atributo
|
Descrição de Negócio
|
|
CPF Inválido
|
Caso o CPF informado não seja válido
|
|
Pessoa Cadastrada
|
Indica se o CPF consultado está presente no CadÚnico e a pessoa está com estado cadastral “cadastrado”.
Valores possíveis:
- “Sim”: o CPF consultado está presente no CadÚnico e a pessoa está com estado cadastral “cadastrado” ; ou
- “Não”: o CPF consultado não está presente no CadÚnico e a pessoa não está com estado cadastral “cadastrado”.
|
|
Família de Baixa Renda
|
O atributo é retornado apenas se Pessoa Cadastrada = “Sim”.
Indica se o CPF consultado está presente no CadÚnico, a pessoa está com estado cadastral “cadastrado” e faz parte de um grupo familiar considerado baixa renda conforme os critérios do CadÚnico (renda familiar per capita de até meio salário mínimo).
Valores possíveis:
- “Sim”: consta no CadÚnico com estado cadastral “cadastrado” e em grupo familiar de baixa renda; ou
- “Não”: consta no CadÚnico com estado cadastral “cadastrado” mas não pertence a um grupo familiar de baixa renda.
|
|
Cadastro Atualizado
|
O atributo é retornado apenas se Pessoa Cadastrada = “Sim”.
Indica se o CPF consultado está presente no CadÚnico, a pessoa está com estado cadastral “cadastrado” e se o cadastro da família está atualizado no CadÚnico (data da última atualização cadastral de até 24 meses).
Valores possíveis:
- “Sim”: consta no CadÚnico com estado cadastral “cadastrado” e está com o cadastro atualizado; ou
- “Não”: consta no CadÚnico com estado cadastral “cadastrado” e está com o cadastro desatualizado.
|
- Cadastro Único (CadÚnico)
1. Para o cidadão
APIs são a base para a troca automática e segura de informações entre os sistemas e não estão disponíveis para acesso pelo cidadão.
Caso esteja com dificuldade em acessar sua conta gov.br, tente recuperá-la seguindo os passos nesta página ou abra uma solicitação no Atendimento ao usuário – Conta GOV.BR.
Caso a dificuldade seja no reconhecimento facial do aplicativo gov.br, reinstale o aplicativo gov.br no celular e tente realizar o procedimento novamente.
Para demais problemas, envie um e-mail para atendimentogovbr@economia.gov.br e você receberá instruções gerais sobre como solucionar problemas mais comuns. Fique atento à caixa de spam ou "lixo eletrônico".
2. Para órgãos não SISP
Para utilizar a API, é necessário que o órgão solicitante faça parte do Sistema de Administração dos Recursos de Tecnologia da Informação (SISP). Para saber se o seu órgão faz parte, acesse: https://www.gov.br/governodigital/pt-br/sisp.
3. Para a iniciativa privada
O acesso à API pelo Programa Conecta gov.br está disponível apenas para órgãos do SISP.
4. Para órgãos SISP
A API está disponível apenas para órgãos e entidades da administração direta, autárquica e fundacional. Para utilizá-la, são necessárias a adesão ao Conecta e a autorização da Secretaria Nacional do Cadastro Único – SECAD, do Ministério da Cidadania, de acordo com os seguintes passos:
4.1. Indique o interesse do órgão
Indique seu interesse enviando um e-mail para o endereço conecta@economia.gov.br.
4.2. Preencha, assine e encaminhe a adesão
Você receberá a minuta do ofício de adesão ao Conecta, que deverá ser preenchida, assinada e enviada para o endereço do e-mail conecta@economia.gov.br. Ressaltamos os seguintes pontos relativos ao ofício de adesão:
- é preciso a definição clara da finalidade do uso dos dados, de acordo com a Lei Geral de Proteção de Dados Pessoais (LGPD);
- não é necessária a análise jurídica;
- deve ser assinado pelo Dirigente de TI e Responsável Técnico;
- deve haver definição da volumetria anual desejada (de 01/01 a 31/12);
- o ofício de adesão pode incluir outras APIs disponibilizadas pelo Conecta.
Para acessar os dados do Cadastro Único, também é necessário encaminhar:
- Termo de Responsabilidade assinado pelo representante legal do órgão ou entidade demandante, conforme modelo constante do Anexo V da Portaria MC nº 810/2022;
- Termos de Compromisso de Manutenção de Sigilo assinados pelos técnicos que terão acesso aos dados solicitados para utilização exclusivamente para a finalidade autorizada, conforme modelo constante do Anexo VI da Portaria MC nº 810/2022.
4.3. Esclareça eventuais dúvidas
O Conecta encaminhará para a Secretaria Nacional do Cadastro Único - SECAD a solicitação de autorização de acesso aos dados. A SECAD poderá entrar em contato diretamente com o órgão para esclarecer eventuais dúvidas pertinentes à autorização.
4.4. Receba o resultado da solicitação
Após análise da Secretaria Nacional do Cadastro Único - SECAD, o órgão receberá e-mail com ofício indicando se a solicitação de autorização de acesso à API foi deferida ou não. Em caso de deferimento, o órgão receberá orientações técnicas para acesso à plataforma e geração da chave de acesso para consumo da API. Em caso de indeferimento, o órgão receberá a justificativa no próprio ofício.
Endpoint Produção:
https://apigateway.conectagov.estaleiro.serpro.gov.br/api-cadunico-servicos/v1/situacaoCadastral/
https://apigateway.conectagov.estaleiro.serpro.gov.br/api-cadunico-servicos/v1/situacaoCadastral/nis
Endpoint Homologação:
https://h-apigateway.conectagov.estaleiro.serpro.gov.br/api-cadunico-servicos/v1/situacaoCadastral/
https://h-apigateway.conectagov.estaleiro.serpro.gov.br/api-cadunico-servicos/v1/situacaoCadastral/nis
Para consultar a documentação técnica da API acesse:
https://www.gov.br/conecta/catalogo/apis/cadunico-servicos/cadunico_servicos.json/swagger_view
Atenção: Caso seja a primeira integração desenvolvida para acesso a uma API da Plataforma Conecta, é necessário previamente cadastrar os IPs do órgão para que se proceda a criação de regra de firewall no Serpro que permita o acesso à Plataforma.
Atenção: Para geração das chaves de acesso, consulte a seção de Gestor Consumidor de APIs do Gerenciador Conecta em:
