Captura de Dados Cadastrais

As APIs aqui descritas tem por objetivo realizar a captura dos dados de emissores fiscais para facilitar o Onboarding do emissor. São elas:

• Captura de Dados Cadastrais
• Captura Opção de Simples ou MEI
• Captura Inscrição Estadual
• Captura Dados Cadastrais Completa 

Autenticação

Para utilizar a captura de CSC é necessário realizar autenticação da Solução Autenticação da Solução

Captura Dados Cadastrais

Esta API realiza a captura dos dados cadastrais dos emissores junto a Receita Federal do Brasil.

• Endpoint: /company/BrazilianFederalRevenue
• Método: GET
• Parâmetros
  • CNPJ: Cnpj da empresa
• Header:
  • Authorization: Token de autorização
  • Content-Type: application/json

Estrutura do Retorno

Campo	Descrição
taxId	Número do CNPJ sem pontuação
updated	Data da última atualização
name	Razão social
jurisdiction	Ente federativo responsável pelas informações. Ex: união, estado, município
equity	Capital social da empresa
nature	Informações da natureza jurídica
nature.id	Código da natureza jurídica conforme IBGE
nature.text	Descrição da natureza jurídica
size	Informações do porte da empresa
size.id	Código do porte da empresa. Opções: 1=Microempresa (ME) 3=Empresa de Pequeno Porte (EPP) 5=Demais.
size.acronym	Sigla do porte da empresa
size.text	Descrição do porte da empresa
alias	Nome fantasia
founded	Data de abertura da empresa
head	Indica se o estabelecimento é a Matriz
statusDate	Data da situação cadastral
status	Informações da situação cadastral
status.id	Código da situação cadastral. Opções: 1 = Nula 2 = Ativa 3 = Suspensa 4 = Inapta 8 = Baixada
status.text	Descrição da situação cadastral
reason	Informações do motivo da situação cadastral
reason.id	Código do motivo da situação cadastral
reason.text	Descrição do motivo da situação cadastral, conforme Receita Federal
specialDate	Data da situação especial
special	Informações da situação especial
special.id	Código da situação especial
special.text	Descrição da situação especial
address	Informações do endereço
address.municipality	Código do município conforme IBGE
address.street	Logradouro
address.number	Número
address.district	Bairro
address.city	Município
address.state	Sigla da Unidade Federativa: AC AL AM AP BA CE DF ES GO MA MG MS MT PA PB PE PI PR RJ RN RO RR RS SC SP SE TO
address.details	Complemento
address.zip	CEP
address.latitude	Latitude
address.longitude	Longitude
country	Informações do país
country.id	Código do país
country.name	Nome do país
phones	Lista de telefones
phones.type	Tipo do telefone. Opções: LANDLINE: Linha terrestre, telefone fixo MOBILE: Linha móvel, telefone celular.
phones.area	Código de DDD
phones.number	Número do telefone
emails	Lista de e-mails
emails.address	Endereço de e-mail
emails.domain	Domínio de registro
emails.ownership	Tipo de propriedade do e-mail. Opções: PERSONAL: Pessoal, registrado em provedor gratuito. CORPORATE: Corporativo, registrado em provedor privado. ACCOUNTING: Contabilidade, domínio remete a empresas de contadores.
mainActivity	Informações da atividade econômica principal
mainActivity.id	Código da atividade econômica principal conforme IBGE
mainActivity.text	Descrição da atividade econômica
sideActivities	Lista de atividades econômicas secundárias
sideActivities.id	Código da atividade econômica secundárias conforme IBGE
sideActivities.text	Descrição da atividade econômica secundárias
members	Quadro de sócios e administradores
members.since	Data de entrada na sociedade
members.role	Informações da qualificação
members.role.id	Código da qualificação conforme Receita Federal
members.role.text	Descrição da qualificação
members.person	Informações do sócio ou administrador
members.person.id	Código da pessoa.
members.person.type	Tipo da pessoa. Opções: • NATURAL: Pessoa física. • LEGAL: Pessoa jurídica. • FOREIGN: Pessoa residente no exterior. • UNKNOWN: Pessoa desconhecida.
members.person.name	Nome ou razão social
members.person.taxId	CPF ou CNPJ
members.person.age	Faixa etária
members.person.country	País de origem
members.person.country.id	Código do país
members.person.country.name	Nome do país
members.agent	Informações do representante legal
members.agent.person	Informações da pessoa representante legal
members.agent.role	Informações da qualificação do representante legal

---

Exemplo Payload de Retorno

{
  "address": {
     "city": "Horizontina",
     "country": {
        "id": 76,
        "name": "Brasil"
     },
   "details": null,
   "district": "Interior",
   "latitude": 0,
   "longitude": 0,
   "municipality": 4310207,
   "number": "S/N",
   "state": "RS",
   "street": "Rodovia BR 285 Km 244",
   "zip": "98920000"
  },
   "alias": "Lanchonete",
   "emails": [
    {
     "address": "teste@yahoo.com",
     "domain": "yahoo.com",
     "ownership": "PERSONAL"
     }
   ],
   "equity": 5000,
   "founded": "2023-04-18",
   "head": true,
   "jurisdiction": null,
   "mainActivity": {
      "id": 5611203,
      "text": "Lanchonetes, casas de chá, de sucos e similares"
     },
   "members": [],
   "name": "Nome responsável legal",
   "nature": {
     "id": 2135,
     "text": "Empresário (Individual)"
   },
   "phones": [
   {
     "area": "55",
     "number": "9999999",
     "type": "MOBILE"
    }
  ],
   "reason": null,
   "sideActivities": [
   {
    "id": 4723700,
    "text": "Comércio varejista de bebidas"
    }
  ],
   "size": {
     "acronym": "ME",
     "id": 1,
     "text": "Microempresa"
   },
   "special": null,
   "specialDate": null,
   "status": {
     "id": 2,
     "text": "Ativa"
    },
    "statusDate": "2023-04-18",
    "taxId": "99999999999999",
    "updated": "2025-03-22T00:00:00Z",
    "mensagem": null
 }

Possíveis retornos HTTP

• 200 - Sucesso
• 400 – BadRequest
  • Caso tenha algum problema nas informações enviada ou não foi possível realizar a captura das informações;
• 401 - Unauthorized
• 404 – NotFound
• 429 - TooManyRequests
• 500 - InternalServerError
• 503 - Service Unavailable

Captura Opção Simples ou MEI

Esta API realiza a captura dos dados cadastrais dos emissores referente a opção do regime tributário: Simples Nacional ou MEI.

• Endpoint: /company/SimpleNational
• Método: GET
• Parâmetros
  • CNPJ: Cnpj da empresa
• Header:
  • Authorization: Token de autorização
  • Content-Type: application/json

Estrutura do Retorno

Campo	Descrição
taxId	Número do CNPJ sem pontuação
updated	Data da última atualização
simples	Informações da opção pelo Simples Nacional
simples.optant	Indica se optante ou enquadrado no regime do Simples Nacional
simples.since	Data de inclusão no regime do Simples Nacional
simples.history	Histórico de períodos anteriores
simei	Informações do enquadramento no MEI
simei.optant	Indica se optante ou enquadrado no MEI
simei.since	Data de inclusão no período vigente no regime MEI
simei.history	Histórico de períodos anteriores

---

Exemplo Payload de Retorno

{
 "simei": {
 "history": null,
 "optant": false,
 "since": null
 },
 "simples": {
 "history": null,
 "optant": true,
 "since": "2023-04-18"
 },
 "taxId": "99999999999999",
 "updated": "2025-03-22T00:00:00Z",
 "mensagem": null
}

Possíveis retornos HTTP

• 200 - Sucesso
• 400 – BadRequest
  • Caso tenha algum problema nas informações enviada ou não foi possível realizar a captura das informações;
• 401 - Unauthorized
• 404 – NotFound
• 429 - TooManyRequests
• 500 - InternalServerError
• 503 - Service Unavailable

---

Captura Inscrição Estadual

Esta API realiza a captura dos dados cadastrais dos emissores referente a Inscrição Estadual. 

• Endpoint: /company/StateRegistration 
• Método: GET
• Parâmetros
  • CNPJ: Cnpj da empresa
• Header:
  • Authorization: Token de autorização
  • Content-Type: application/json

Estrutura do Retorno

Campo	Descrição
taxId	Número do CNPJ sem pontuação
updated	Data da última atualização
originState	Unidade Federativa de origem
registrations	Inscrições Estaduais
enable	Indica se habilitada como contribuinte para a UF descrita
number	Número da Inscrição Estadual
state	UF de registro da Inscrição Estadual
status	Situação cadastral da Inscrição.
status.id	Situação cadastral da inscrição. Opções: 1= Sem restrição. 2 = Bloqueado como destinatário na UF. 3 = Vedada operação como destinatário na UF.
status.text	Descrição da situação cadastral
type	Tipo da Inscrição
type.id	Código do tipo. Opções: 1 = IE Normal. 2 = IE Substituto Tributário. 3 = IE Não Contribuinte (Canteiro de Obras, IE Virtual, outros). 4 = IE de Produtor Rural.
type.text	Descrição do tipo.
registrations.enabled	Indica se habilitada como contribuinte
registrations.statusDate	Data da situação cadastral

---

Exemplo Payload de Retorno

{
 "originState": "SP",
 "registrations": [
 {
 "enabled": true,
 "number": "111111111111",
 "state": "SP",
 "status": {
 "id": 1,
 "text": "Sem restrição"
 },
 "statusDate": "1985-07-03",
 "type": {
 "id": 1,
 "text": "IE Normal"
 }
 },
 {
 "enabled": false,
 "number": "283294060",
 "state": "MS",
 "status": {
 "id": 1,
 "text": "Sem restrição"
 },
 "statusDate": "2023-01-15",
 "type": {
 "id": 2,
 "text": "IE Substituto Tributário"
 }
 }
 ],
 "taxId": "99999999999999",
 "updated": "2025-04-08T21:40:31Z",
 "mensagem": null
}

Possíveis retornos HTTP

• 200 - Sucesso
• 400 – BadRequest
  • Caso tenha algum problema nas informações enviada ou não foi possível realizar a captura das informações;
• 401 - Unauthorized
• 404 – NotFound
• 429 - TooManyRequests
• 500 - InternalServerError
• 503 - Service Unavailable

---

Captura completa de Dados Cadastrais

Esta API realiza a captura dos dados cadastrais de forma completa, contemplando as 3 rotas acima descritas.

• Endpoint: /company/FullRegistrationData 
• Método: GET
• Parâmetros
  • CNPJ: Cnpj da empresa
• Header:
  • Authorization: Token de autorização
  • Content-Type: application/json