API CPF

Documentação da API Receita Federal CPF

Recuperar dados de uma empresa no Receita Federal CPF

Método para recuperar as informações de uma pessoa através do seu CPF. As informações são exatamente as mesmas retornadas pelo site do Receita Federal CPF.

GET

URL para requisição 

https://www.sintegraws.com.br/api/v1/execute-api.php?token={token}&cpf={cpf}&data-nascimento={data_nascimento}&plugin={CPF}

Parâmetros de requisição da API do Receita Federal CPF

token
string

obrigatório
O seu token é gerado após o cadastro no portal.
Ver meu token

cpf
string

obrigatório
CPF que deseja obter as informações da através da Receita Federal. Utilize o formato 00000000000.

data-nascimento
string

obrigatório
Data de nascimento do representante do CPF informado. Utilize o formato ddmmaaaa.

plugin
string

obrigatório
Site no qual deseja as informações, no caso da API Receita Federal CPF informar "CPF".

Exemplo de resposta da API Receita Federal CPF
Uma resposta típica é composta por um JSON.

  • Status: 200 OK
  • Time: 200 ms
  • Size: 2021 bytes 

                

    
              


          

        

      

    

  


  

    

      

        
                 
          

            Campos de retorno da API Receita Federal CPF
          

        

        

          

            

            

              

                status
                string
                
              

              
                Indica a situação da requisição.
Valores possíveis:
  • OK
  • ERROR

              
            

            

              

                code
                string
                
              

              
                Código de retorno utilizado para informar o status da requisição.
              
            

            

              

                message
                string
                
              

              
                Mensagem explicativa indicando o campo status.
              
            

            

              

                cpf
                string
                
              

              
                CPF no formato 000.000.000-00.
              
            

            

              

                nome
                string
                
              

              
                Nome do titular do CPF.
              
            

            

              

                nome_mae
                string
                NovidadeBeta
              

              
                Nome da mãe do titular do CPF.
              
            

            

              

                data_nascimento
                string
                
              

              
                Data Nascimento do titular do CPF retornada no formato dd/mm/aaaa.
              
            

            

              

                situacao_cadastral
                string
                
              

              
                Situação cadastral do CPF na Receita Federal:
Valores possíveis:
  • Regular 
  • Suspensa
  • Cancelada
  • Titular falecido
  • Pendente
  • Nula
 Veja os detalhes
              
            

            

              

                genero
                objeto
                Novidade
              

              
                O objeto Genero representa informações relacionadas à identidade de gênero de um indivíduo em conformidade com os dados cadastrais registrados na Receita Federal. Esta classe é essencial para garantir que os registros pessoais sejam precisos.
              

              

                

                  

                    
                  

                  

                    

                      
            

              

                genero.sexo
                string
                
              

              
                Gênero da pessoa responsável pelo CPF consultado na Receita Federal:
Valores possíveis:
  • M para Masculino.
  • F para Feminino.

              
            

            

              

                genero.nome_social
                string
                
              

              
                Campo nome_social indica o nome pelo qual uma pessoa é conhecida socialmente, diferindo do nome registrado oficialmente. Utilizado para assegurar que interações e documentações refletem a identidade escolhida pela pessoa.
              
            

            

              

                genero.nome_civil
                string
                
              

              
                Campo nome_civil contém o nome oficial da pessoa conforme registrado em documentos legais. Fundamental para processos de verificação de identidade e validações cadastrais em contextos legais e administrativos.
              
            

            

              

                genero.transicao_genero
                boolean
                
              

              
                Campo transicao_genero indica se houve mudança oficial no gênero da pessoa. Essencial para rastreamento de alterações de identidade em bases de dados, incluindo contextos de segurança e verificações legais.
              
            

                    

                  
 
                

              

            

            

              

                idade
                string
                
              

              
                Idade do titular do CPF.
              
            

            

              

                uf
                Array [string]
                
              

              
                Possíveis UFs nos quais o cadastro do CPF foi realizado.
              
            

            

              

                data_inscricao
                string
                
              

              
                Data da inscrição no formato dd/mm/aaaa.
              
            

            

              

                digito_verificador
                string
                
              

              
                Dígito verificador.
              
            

            

              

                comprovante
                string
                
              

              
                Comprovante.
              
            

            

              

                ano_obito
                string
                
              

              
                Caso o do titular do CPF tenha falecido o campo retornará o ano do óbito no formato aaaa.
              
            

            

              

                qsa
                Array [objeto]
                Novidade
              

              
                QSA é a sigla para Quadro de Sócios e Administradores, que é a estrutura de propriedade de uma empresa. 
              

              

                

                  

                    
                  

                  

                    

                      
            

              

                qsa.cnpj
                string
                
              

              
                CNPJ no formato 00000000000000.
              
            

            

              

                qsa.razao_social
                string
                
              

              
                Razão social.
              
            

            

              

                qsa.matriz_filial
                objeto
                
              

              
                Tipo do CNPJ cadastrado na Receita federal.
              
            

            

              

                qualificacao
                objeto
                
              

              
                Qualificação do sócio.
              

              

                

                  

                    
                  

                  

                    

                      
            

              

                codigo
                string
                
              

              
                Código da qualificação do sócio.
              
            

            

              

                description
                string
                
              

              
                Descrição da qualificação do sócio.
              
            

                    

                  
 
                

              

            

            

              

                qsa.data_entrada
                string
                
              

              
                Data de entrada na empresa, no formato dd/mm/aaaa.
              
            

                    

                  
 
                

              

            
          

        

      

    

  


  

    

      

        
                 
          

            Retornos disponíveis
          

        

        

          

            

              

                
                  

                    Status Request
                    code
                    status
                    message
                  

                
                
                                      

                      
                        
                                                  
                        
                          200 OK                        
                      
                      
                        
                          0                        
                      
                      
                        
                          OK                        
                      
                      
                        
                          Pesquisa realizada com sucesso.                        
                      
                    

                                      

                      
                        
                                                  
                        
                          200 OK                        
                      
                      
                        
                          1                        
                      
                      
                        
                          OK                        
                      
                      
                        
                          Nenhum CPF encontrado na Receita Federal.                        
                      
                    

                                      

                      
                        
                                                  
                        
                          200 OK                        
                      
                      
                        
                          2                        
                      
                      
                        
                          ERROR                        
                      
                      
                        
                          CPF inválido.                        
                      
                    

                                      

                      
                        
                                                  
                        
                          401 Unauthorized                        
                      
                      
                        
                          3                        
                      
                      
                        
                          ERROR                        
                      
                      
                        
                          Token inválido.                        
                      
                    

                                      

                      
                        
                                                  
                        
                          200 OK                        
                      
                      
                        
                          4                        
                      
                      
                        
                          ERROR                        
                      
                      
                        
                          Usuário não contratou nenhum pacote de créditos.                        
                      
                    

                                      

                      
                        
                                                  
                        
                          200 OK                        
                      
                      
                        
                          5                        
                      
                      
                        
                          ERROR                        
                      
                      
                        
                          Os créditos contratados acabaram.                        
                      
                    

                                      

                      
                        
                                                  
                        
                          200 OK                        
                      
                      
                        
                          6                        
                      
                      
                        
                          ERROR                        
                      
                      
                        
                          Plugin não existe.                        
                      
                    

                                      

                      
                        
                                                  
                        
                          200 OK                        
                      
                      
                        
                          7                        
                      
                      
                        
                          ERROR                        
                      
                      
                        
                          Site da Receita Federal CPF está com instabilidade.                        
                      
                    

                                      

                      
                        
                                                  
                        
                          200 OK                        
                      
                      
                        
                          8                        
                      
                      
                        
                          ERROR                        
                      
                      
                        
                          Ocorreu um erro interno, por favor contatar o nosso suporte.                        
                      
                    

                                      

                      
                        
                                                  
                        
                          200 OK                        
                      
                      
                        
                          9                        
                      
                      
                        
                          OK                        
                      
                      
                        
                          Data de nascimento informada está divergente da base de dados da Receita Federal do Brasil.