Manual de Integração 2.2.28

Manual de Integração
versão 2.2.28
Histórico de revisões
Versão Data Descrição Responsável
2.2.28 16/06/2020 Novo serviço WS42 Erica Helena
WS15
Inclusão novos objeto:
Responsavel
EnderecoContabil
Inclusão novos campos no objeto Endereco:

nu_area_total
nu_area_producao
WS01
Novo Objeto
ClassificacaoRisco
Inclusão novo campo no objeto DadosConsultaPrevia

classificacao_risco
WS02
Novo Objeto
classificacao_risco
InscricaoAdicional
EnderecoSubstitutoTributario
DadosItcmd
DadosDoacao
Inclusão novo campo no objeto DadosSolicitacao

classificacao_risco
Inclusão novo campo no objeto Empresa

dados_itcmd
Inclusão novo campo no objeto NaturezaImovel

inscricao_adicional
Inclusão novo campo no objeto substitutoTributario

endereco
Retirada validação de obrigatoriedade para os campos

substituto_tributario
co_tipo_substituicao_tributaria
nu_convenio_substituicao
Alteração do tipo
nu_participacao_quotas para Integer
nu_valor_quotas alterar para Integer
Aumento do tamanho
ds_registro_cartorio para 100 caracteres
WS29
1
Inclusão de novos campos no objeto dados_resposta
id
co_tipo_modelo_documento
WS33
Incluída informação no limite de taxas retornadas.
2.2.27 10/02/2020 Novo Serviço WS15, WS29 Erica Helena
WS01
Alteração do Campos no objeto Endereco
nu_area_total String(11) para String(15)
nu_area_utilizada String(11) para String(15)
WS02
Inclusão no novo campos no objeto Empresa:
filiais
Novo Objeto Filiais

Com os campos:
nu_numero_registro
nu_cnpj
ds_uf
Alteração do Campos no objeto Endereco

nu_area_total String(11) para String(15)
nu_area_utilizada String(11) para String(15)
Alteração no objeto BensMovelImovel

Campo nu_area_imovel numeric para String
Alterado o objeto ArquivosRegistro

Campo ds_url_servico Text para String
WS02, WS04, WS06

Alteração do Campos no objeto Arquivo
ds_url_servico Text para String
WS04, WS06
Aumento do campo: ds_nome_arquivo para String(400)
WS32
Aumento do campo co_tributo para String(13)
Atualização das tabelas de apoio
UF
Atualizado o código da UF “MS “
Tipo de arquivo registro

Incluído o tipo: 29 – Ata
2
2.2.26 19/11/2019 Novos Serviços WS07, WS25 e WS26 Maxwell
Azevedo
WS02
- Adição de novos itens na tabela de apoio do campo
nu_tipo_arquivo:
4 - Capa de Processo - Enquadramento
5 - Capa de Processo - Requerimento Empresário
6 - Capa de Processo - Contrato Social
8 - Capa de Processo - Procuração
10 - Capa de Processo - Emancipação
11 - Consolidação
12 - Rerratificação
13 - Capa de Processo - Consolidação
14 - Capa de Processo - Rerratificação
15 - Documento de Extinção
16 - Distrato
17 - Ata de Liquidação
18 - Ata de Assembleia Geral de Constituição
20 - Ata de Extinção de Filial
21 - DTE
22 - Documento de Interesse
23 -Livro
24 - Termo de Autenticação
25 - Carta
26 - Balanço
27 - Comunicado
28 - Declaração
30 - Ofício Judicial
31 - Ofício Administrativo
32 - Revogação de Procuração
2.2.25 09/10/2019 Alteração e novos campos dos campos no WS02 Erica Helena
Atualizada a nomenclatura do clausula_contratuais no objeto

Empresa para clausula_contratual e do objeto
ClausulaContratuais para ClausulaContratual.
ClausulaContratual
dados_conselheiro passando a ser um array do objeto
Conselheiro.
IntegralizacaoCapital
bens_movel_imovel passando a ser um array do objeto
BensMovelImovel.
SimplesNacional
Foram removidos os campos dt_inclusao e dt_exclusao e
adicionados os campos periodo_simples, periodo_mei
ClausulaContratual
Ajusta nomenclatura do campo: integracalizacao_capital,
is_exlusao_reuniao_assembleia
3
Ajusta nomenclatura do objeto: IntegralizacaoCapital
Novos objetos
PeriodoSimples
- dt_inclusao
- dt_exclusao
PeriodoMei
- dt_inclusao
- dt_exclusao
2.2.24 09/09/2019 WS01 e WS02 Maxwell

- Adição de Evento REDESIM 696 - Alteração de Cláusulas Azevedo / Erica
Particulares na tabela de apoio do campo co_evento. Helena
WS02
- Adição de novo item na tabela de apoio do campo
co_tipo_pratica_comercio_exterior: 4 - Não pratica comércio
exterior
WS06
- Alteração do tamanho do campo ds_nome_arquivo;
- Alteração no tamanho ds_retorno_exigencia;
WS31
- Adição do objeto endereco para CRC no retorno da
requisição;
WS02
Removida a obrigatoriedade dos campos
DadosSolicitacao
- dt_solicitacao
- is_vinculado
- solicitante
DadosRegistro
- co_protocolo
- co_ato
- eventos
Empresa
- co_enquadramento
- co_tipo_unidade
- ds_objeto_social
- responsavel_legal
- dt_assinatura_ata
- dt_constituicao
- dt_inicio_atividades
4
Endereco, EnderecoResponsavelContabil
- co_cep
- co_tipo_logradouro
- ds_tipo_logradouro
- ds_endereco
- nu_numero
- ds_bairro
- co_municipio_tom
NaturezaImovel
- co_tipo_natureza
FormaAtuacao
- co_forma_atuacao
ResponsavelContabil
- co_cpf_cnpj
- ds_nome
- ds_email
- nu_ddd_telefone
- nu_telefone
- nu_ddd_celular
- nu_celular
- dados_conselho
- endereço
Responsavel
- nu_cpf
- ds_nome
- ds_email
- nu_ddd_telefone
- nu_telefone
- nu_ddd_celular
- nu_celular
- dados_conselho
- endereco
DadosConselho
- co_uf_crc
- nu_sequencia
- dt_registro
- co_tipo_classificacao_crc
- nu_tipo_crc
- nu_crc
Socio
- co_tipo_pessoa
- nu_cpf_cnpj
- ds_nome
- qualificacoes
5
PessoaFisica
- dt_nascimento
- co_nacionalidade
- co_sexo
EnderecoSocio
- co_pais
Removida as validações que tornava os seguintes campos

obrigatórios:
Empresa
- nu_cnpj_matriz
- nu_registro_matriz
Atividade
- is_exerce_no_endereco
ResponsavelContabil
- responsável
Socio
- dados_pessoa_fisica
- dados_pessoa_juridica
PessoaFisica
- co_estado_civil
EnderecoSocio
- co_municipio
- co_municipio_tom
- co_uf
- co_cep
- co_tipo_logradouro
- ds_tipo_logradouro
- ds_endereco
- nu_numero
- ds_bairro
- ds_endereco_completo
Naturezaimovel
- nu_inscricao
Aumentando os tamanhos dos seguintes campos:

Empresa
- ds_nome_empresarial de String(200) para String(400)
Empresa, ResponsavelContabil, Responsavel, Socio

- nu_ddd_telefone String(2) para String(4)
- nu_ddd_celular String(2) para String(4)
6
DadosRegistro
- nu_arquivamento String(11) para String(14)
Socio
- ds_nome String(200) para String(400)
Foram adicionados os campos:
EnderecoSocio
- ds_cidade_exterior
Empresa
- ds_caixa_postal
- nu_cnpj_sucessora
- simples_nacional
- dt_termino_exercicio_social
- dt_termino_integralizacao
- dt_inicio_integralizacao
- clausula_contratuais
PessoaFisica
- co_cpf_conjuge
- ds_nome_conjuge
SimplesNacional
- is_indicador_simples_nacional
- dt_inclusao
- dt_exclusao
- is_indicador_mei
ClausulaContratuais
- is_regencia_supletiva
- is_exclusao_extrajudicial
- is_exclusao_reuniao_assembleia
- is_foro_matriz
- is_foro_arbitral
- co_uf
- co_municipio_foro
- dt_termino_exercicio
- integralizacao_capital
- is_conselho_fiscal
- dados_conselheiro
- nu_capital_integralizado_dinheiro
- bens_movel_imovel
Conselheiro
7
- co_cpf_conselheiro
- ds_nome_conselheiro
- co_cpf_suplente
- ds_nome_suplente
BensMovelImovel
- ds_tipo_bem
- ds_descricao
- nu_valor
- co_cpf_cnpj_titular
- ds_nome_titular
- dt_aquisicao
- co_inscricao_municipal
- nu_area_imovel
- ds_registro_cartorio
- ds_nome_cartorio
- endereco
EnderecoImovel
- co_cep
- ds_endereco
- co_numero
- ds_complemento
- ds_bairro
- co_uf
- co_municipio
WS04
Removida obrigatoriedade dos campos
- ds_nome_empresarial
Aumentado o tamanho do campo:

- ds_nome_empresarial String(200) para String(400)
WS20
Aumentado o tamanho do campo:
- ds_nome_aprovado String(300) para String(400)
Adicionados novos códigos de erros:

- WS02 - 9920
- WS21 - 9921
WS21
Adcionada validações dos campos:
- dt_resposta
- dt_validade
2.2.23 13/08/2019 Alteração nos hiperlinks das tabelas de apoio. Maxwell

Azevedo
2.2.22 23/07/2019 WS02 Jafet Gomes
8
- Adição de momento de envio do recurso para cancelamento
do processo pela Junta Comercial, observar a descrição do
serviço;
WS01 e WS02
- Correção no tamanho no manual do campo ds_pergunta para
500 no objeto questionario;
WS03 e WS04
- Alteração no tamanho do campo ds_pergunta para 800 no
objeto questionario.
2.2.21 13/05/2019 WS04 e WS06 Maxwell

- Adição do campo ds_nome_arquivo no objeto de anexos. Azevedo
WS03
- Correção na regra de montagem do array de exigências onde
dizia co_situacao = 2 na verdade deve ser 3.
Adição das URLs do ambiente de teste.
2.2.20 06/03/2019 WS01 e WS02 Maxwell

- Adição de novas naturezas jurídicas na tabela de natureza Azevedo
do campo co_natureza_juridica.
WS02
- Alteração na validação do campo ds_endereco dentro do
objeto EnderecoSocio quando MEI.
WS21 – Tabela de erros específicos

- Alteração na tabela de transição de status.
2.2.19 03/01/2019 WS06

-Retirando a obrigatoriedade do campo Jafet Gomes
“ds_retorno_exigencia” do array “exigencias”.
2.2.18 21/12/2018 WS01 Marcus Bruno

- Retirando a obrigatoriedade do array de “Socios”;
- Ajustando o tamanho do campo “ds_nome” dentro dos arrays
“Solicitante” e “Socio” para 200 caracteres;
WS02
- Ajustando o tamanho dos campos “ds_nome_empresarial” de
144 para 200 caracteres;
“Solicitante”, “ResponsavelContabil”, “Responsavel”, “Socio” e
“ResponsavelLegal” de 100 para 200 caracteres;
WS04
9
- Ajustando o tamanho dos campos “ds_nome_empresarial”
de 144 para 200 caracteres;
WS31
“DadosCRC” e “Responsavel” de 100 para 200 caracteres;
WS32
- Ajustando o tamanho dos campos “ds_nome” de 100 para
200 caracteres;
2.2.17 21/11/2018 - Adicionado campo ds_url_taxa no response body do WS32; Maxwell

- Ajuste na URL do WS32 e WS33 para core string; *
- Ajuste no campo status_taxa de String para Integer e
nomenclatura para co_status_taxa no response body do
WS33; *
2.2.16 5/11/2018 WS01 Maxwell

- Ajuste na regra de envio do objeto socio do WS01 para Azevedo/
algumas naturezas; * Jafet Gomes
- Ajuste do tamanho do campo co_cnae_especializada para
17 no WS01 e WS02; *
- Adicionado os atributos co_municipio_tom e
ds_tipo_logradouro no Endereço do serviço WS01;
WS02
- Ajuste na regra para envio do campo nu_numero no objeto
de endereço da empresa e no endereço do sócio para o
serviço WS02 quando MEI; *
- Ajuste na descrição nu_valor_participacao no objeto
qualificação do WS02 de #############,## para
#############.##; *
- Ajuste no objeto documento_identificacao onde não será
mais obrigatório o objeto no WS02; *
- Ajuste do tamanho dos campos nu_registro,
nu_registro_matriz, nu_registro_anterior do objeto empresa
do WS02 e nu_registro do objeto dados_pessoa_juridica do
ws02; *
- Ajuste no tamanho do campo nu_cpf no objeto solicitante e
responsavel do WS02 para 11; *
- Ajuste no tipo do atributo endereço
EnderecoResponsavelEmpresa para
EnderecoResponsavelContabil no WS02, a alteração está
dentro do objeto responsavel -> responsavel_contabil do
ws02; *
- Ajuste no Tipo do nu_participacao_quotas e
nu_valor_quotas de Integer para Bigint no WS02; *
- Ajuste no tamanho do campo ds_complemento de 156 para
162 nos serviços WS01 e WS02; *
10
- Ajuste no tamanho e formato do campo nu_ano_registro, de
10 para 4 e no formato de YYY-MM-DD para YYYY no WS02;
*
- Adicionado o atributo ds_nome, nu_ddd_celular e
nu_celular dentro do objeto responsavel que está dentro
objeto responsavelContabil no WS02;
- Adicionado os atributos ds_email, nu_ddd_telefone,
nu_telefone, nu_ddd_celular, nu_celular para o
responsavelContabil no WS02;
- Adicionado os campos is_documento_provisorio e
dt_documento_validade dentro do objeto
documento_identificacao localizado no objeto PessoaFisica
do objeto Socio no WS02;
- Adicionado o campo is_espolio dentro do objeto
PessoaFisica no objeto Socio no WS02;
- Adicionado o campo co_enquadramento no objeto
PessoaJuridica dentro do objeto sócio no WS02;
WS21
- Ajuste nas situações permitidas para status resposta no
WS21; *
WS31
- Ajuste do objeto EnderecoResponsavelEmpresa para
EnderecoResponsavelContabil no ws31 e o tipo do atributo
endereço EnderecoResponsavelEmpresa para
EnderecoResponsavelContabil ws31; *
- Adicionado o campo ds_nome para o objeto
RESPONSAVEL, localizado dentro do objeto DadosCRC no
WS31;
WS32
- Ajuste no tipo nu_nosso_numero e nu_documento de
Integer para String no response body do WS32; *
- Adicionado os atributos co_tributo, co_ tributo_detalhe,
co_municipio, endereco_sacado, co_pais e
ds_endereco_completo no request do WS32 e alteração da
URL;
WS33
- Adicionado os atributos ds_observacao e status_taxa no
response do WS33;
Tabela de Erros
- Adicionado na tabela Tabela de erros específicos do WS um
código para Nosso número Inexistente;
- Adicionado novo erro 202 9010 Requisição já processada
na tabela de erros comuns;
11
- Adicionados novos erros específicos 9916, 9917 e 9918
para o WS21 na tabela de erros específicos;
OBS: Os ajustes(*) são algumas alterações nos campos que

já enviamos atualmente, são alterações realizadas para
minimizar alguns problemas atuais e futuros, as adições são
novos campos e deveram ser tratados a partir da data
estabelecida.
2.2.15.1 01/10/2018 - Ajustando regra para envio do is_exerce_no_endereco no Maxwell

objeto atividades, estado civil, co_tipo_logradouro e Azevedo
ds_tipo_logradouro no objeto socios quando MEI no ws02;
-Correção no nome do objeto dados_documento_documento

para dados_solicitacao_documento no ws04;
2.2.14 13/04/2018 - Adicionado atributo co_uf do responsável contábil no WS02 Jafet Gomes
e WS31.
2.2.13 29/03/2018 - Correção no tamanho do atributo nu_documento no WS03 e Jafet Gomes

WS21;
- Alteração no tamanho do atributo nu_inscricao_imobiliaria
no WS30 e nu_inscricao no WS01 e WS02;
- Retirado a obrigatoriedade do objeto formas_atuacao no
WS01;
- Alteração na descrição do código 9006 de retorno comum;
- Adicionado código 9009 de retorno comum.
2.2.12 14/03/2018 - Corrigidas alterações de obrigatoriedades dos campos Genison Ribeiro

informados na versão 2.2.11;
- Adicionada observação de obrigatoriedade no atributo
nu_cnpj_entidade_registro do WS01;
- Adicionados atributos nu_ddd_ceular, nu_celular no objeto
Socio do WS02;
- Alteração do tipo dos atributos ds_url_servico para Text;
- Adicionado serviço WS32 – Geração de taxas;
- Adicionado serviço WS33 – Consulta pagamento de taxas;
- Adicionado código de erro 9801 no WS01;
2.2.11 23/02/2018 - Retirado os códigos de retorno de erro 9912, 9913 e 9914 Genison
da Tabela de erros específicos; Ribeiro/Jafet
- Alterado formato de autenticação dos serviços; Gomes
- Alteração em todos os objetos de envio de arquivo;
- Adicionado atributo arquivos_entidade_registro no WS02;
- Removidos serviços WS25 e WS26. O download de
arquivos será realizado através de serviço único WS24;
- Removida obrigatoriedade dos campos nu_ddd_telefone,
nu_telefone, ds_email do objeto Solicitante;
nu_telefone e nu_capital_social do objeto Empresa;
12
- Removida obrigatoriedade dos campos co_tipo_imovel,
nu_area_total, nu_area_utilizada e natureza_imovel do objeto
Endereço (da empresa);
- Removida obrigatoriedade do campo
is_exerce_no_endereco do objeto Atividade. Adicionada
observação sobre obrigatoriedade;
- Removida obrigatoriedade dos campos ds_email,
nu_ddd_telefone, nu_telefone do objeto Socio;
- Removida obrigatoriedade do campo endereco do objeto
Socio;
nu_telefone e ds_email do objeto ResponsavelLegal;
- Campo co_protocolo_registro alterado para envio de vários
protocolos no WS05;
2.2.10 14/02/2018 - Alterado tipo de dado do nu_ato_legal no WS02. Jafet Gomes
2.2.9 08/02/2018 - Alterado tipo de dado e formato do complemento no WS30. Genison Ribeiro
2.2.8 07/02/2018 -Alterado nome dos campos do response – 201 dos serviços Edmilson Mota /
WS01, WS02, WS03, WS04, WS05, WS06, WS20, WS21 e Jafet Gomes
WS22.
-Adicionado o parâmetro <co_protocolo_redesim> no request
do WS24, WS25 e WS26;
-Alterado o tipo do campo “nu_autorizacao” no WS01 e
WS02;
-Alterado do campo “nu_id” para “id” DadosConsultaPrevia -
WS01, DadosSolicitacao - WS02, DadosDocumento - WS03,
DadosSolicitacaoDocumento - WS04,
DadosCancelamentoSolicitacao - WS05 e
DadosRetornoExigencias - WS06;
-Retirado duplicidade de campos de co_uf_naturalidade no
WS02;
-Retirada a obrigatoriedade do campo “is_empresa_lider” do
WS02;
-Adicionada a obrigatoriedade nos campos “co_estado_civil”,
“dt_nascimento”, “co_nacionalidade”, co_sexo e no objeto
“documento_identificacao” do WS02;
-Adicionado objeto substituto_tributario no objeto Empresa do
WS02;
-Correção nome do campo de "dt_solicitacao" para
"is_vinculado" no objeto "DadosSolicitacao" do WS02.
-Alterado obrigatoriedade do campo “utilizacao_solo” de “S”
para “N”, caso seja informado “Não” na coleta de dados será
“Nulo”, ref. objeto “DadosConsultaPrevia” do WS01 e
“Empresa” do WS02.
-Alterado obrigatoriedade do campo “co_status_empresa” e
“co_situacao_empresa” de “S” para “N” e acrescentando a
observação “Exclusivo para Junta Comercial.” no objeto
13
2.2.7 30/01/2018 -Removendo os atributos (“co_situacao_empresa” e Edmilson Mota
“co_status_empresa” ) do array DadosRegistro do WS02.
-Adicionando os atributos “co_situacao_empresa” e
“co_status_empresa” no objeto “Empresa” do WS02.
-Adicionando “co_uf” no objeto “Endereco” do WS01.
-Alterado o nome do atributo “nu_seq_pessoa” do objeto
-Alterado o nome do atributo “co_utilizacao_solo” do objeto
“UtilizacaoSolo” do WS01.
-Alterado o nome do atributo “co_tipo_utilizacao_solo” , para
“co_utilizacao_solo” em WS01 E WS02 (só na coluna
“descrição”).
-Alterado o tipo do atributo “ds_orgao_expedidor” de Integer,
para String(30).
2.2.6 18/01/2018 - Correção nos códigos http dos retornos de erros 9005 e Jafet Gomes
9008.
- Alteração do tipo do objeto do questionário para o tipo
Pergunta, nos serviços WS01, WS02, WS03 e WS04.
- Adição do campo nu_id nos objetos DadosConsultaPrevia -
WS01, DadosSolicitacao - WS02, DadosDocumento - WS03,
DadosSolicitacaoDocumento - WS04,
DadosCancelamentoSolicitacao - WS05 e
DadosRetornoExigencias - WS06 para informar o campo
indicador do dado salvo na base do órgão integrado.
2.2.5 15/01/2018 -Ajustes em campos com letras maiúsculas, acentos e Jafet Gomes
caracteres especiais no WS01 (controle, solicitante,
atividades, eventos, socios, endereco).
-Correção do tipo do campo is_atividade_principal para
Boolean do objeto AtividadeEspecializada do WS01.
-Correção da url do WS30 com caractere especial.
-Adicionados tipos de retorno de erro específicos para os
serviços WS24, WS25, WS26, WS30 e WS31.
-Ajustes nas urls e descrição dos parâmetros de request dos
serviços de verbo HTTP GET.
-Adicionado o campo ds_orgao no objeto controle dos
serviços WS01, WS20, WS21 e WS22.
-Alteração no tipo de verbo HTTP para POST nos serviços
WS20, WS21 e WS22.
-Retirada do parâmetro nu_identificador_orgao do request e
acréscimo de um objeto de tipo array de detalhamentos do
cep dentro do objeto cep do WS30.
-Alteração no tipo de dado para String e adequado o nome do
campo para nu_latitude e nu_longitude no objeto Point dos
serviços WS01 e WS02.
2.2.4 11/01/2018 Criar o Objeto do tipo POINT (cordenadas geográficas). Edmilson Mota
O campo “co_tipo_modelo_documento” será obrigatório, caso
“is_retorno_documento” = true.
14
2.2.3 02/01/2018 Alterado o tipo de CAMPO para armazenamento das Marcus Bruno /
Coordenadas Geográficas (latitude e longitude), para o tipo Edmilson Mota /
POINT (Geometry 16 bytes); Philipe
Fernandes
Criação das tabelas específicas para Response (Específica e
Comum);
Remoção dos campos ds_latitude e ds_longitude (substituído
por coordenada_geografica);
Trocar “URL:HTTP” por “URL:HTTPS”;
Trocar “Verbo HTTP: PATCH” por “Verbo HTTP: PUT”
Remover o campo “ds_orgao” – Objeto Controle - WS01;
Removendo o array de sublotes do WS30;
Transformando em array o cep do WS30;
Adicionando os atributos co_situacao_empresa e
co_status_empresa no array DadosRegistro do WS02;
Removendo o atributo ds_atividade do array
AtividadeEspecializada do serviço WS02;
Incluir cochetes no tipo “Questionario[]” no serviço WS01
Trocar nome do objeto “Pergunta[]” por “Questionario[]” no
WS02;
Correção do tipo String(5) para Boolean, nos campos que
são lógicos (true / false).
Remover campo “ds_atividade” String(250) -Descrição da
atividade especializada.
Incluir observação “atividades_especializadas” OBS: Uso
exclusivo da prefeitura.
2.2.2 20/12/2017 Aumentando o tamanho dos campos do Objeto Social e do Marcus Bruno
nu_inscricao;
WS01 – Atributo: nu_cnpj_entidade_registro_matriz;
WS02 – Atributo: nu_cnpj_entidade_registro_matriz;
WS02 – Removendo atributo co_situacao_empresa;
Adicionando regra no atributo formas_atuacao;
Transformando os dados_entidade_registro em Array;
Padronizando o tamanho dos campos de e-mail para 150
caracteres;
2.2.1 14/12/2017 Código de sucesso alterado para os serviços que utilizam Genison Ribeiro
POST e PATCH
2.2.0 08/12/2017 Objetos contendo arquivos (tipo File) foram alterados; Genison Ribeiro
Adicionados serviços WS24, WS25 e WS26 responsáveis
pela disponibilização de arquivos anexados ao processo;
Objetos de retorno de todos os serviços alterados;
URI de serviços alteradas;
2.1.0 01/12/2017 Adicionados serviços complementares WS30 e WS31 Genison Ribeiro
2.0.10 30/11/2017 Alteração das URIs dos serviços disponibilizados no Genison Ribeiro
SIGFÁCIL.
15
2.0.9 22/11/2017 WS02 – Atributos is_empresa_satelite, Genison Ribeiro
nu_cnpj_operador_logistico, is_operador_logistico e
co_tipo_pratica_comercio_exterior adicionados ao objeto
Empresa.
2.0.8 21/11/2017 WS02 - Atributo co_uf adicionado ao endereço de empresa e Genison Ribeiro
sócio;
WS02 - Atributo dados_empresa passa a ser
dados_solicitacao;
WS02 - Objeto DadosEmpresa passa a ser DadosSolicitacao;
WS02 - Obrigatoriedades redefinidas no endereço dos sócios
(EnderecoSocio) para atender o envio de endereço de sócios
residentes no exterior;
WS02 - Atributo ds_endereco_completo adicionado no
endereço dos sócios (EnderecoSocio) para atender o envio
de endereço de sócios residentes no exterior;
WS02 - Atributo dados_ato_legal adicionado.
2.0.7 17/11/2017 WS04 - Atributos is_atividade_principal e Genison Ribeiro

is_exerce_no_endereco do objeto Atividade removidos.
2.0.6 16/11/2017 WS03, WS04 - Atributo co_cnpj alterados para nu_cnpj, Genison Ribeiro
utilizando o padrão dos demais serviços.
2.0.5 09/11/2017 WS02 - Atributo co_uf adicionado nos objetos Endereco da Genison Ribeiro
Empresa e Socio;
WS02 - Atributo dt_autenticacao adicionado no objeto
DadosEmpresas;
WS01, WS02: Atributo ds_latitude e ds_longitude
adicionados nos objetos de Endereco;
Adicionados verbos HTTP a serem utilizados em cada
recurso;
2.0.4 27/10/2017 WS02 - Remoção do atributo co_nacionalidade; Genison Ribeiro

WS02 - Atributo “co_tipo_documento” movido para objeto
DocumentoIdentificacao;
WS01, WS02 - Adicionado atributo ds_arquivo no objeto
UtilizacaoSolo;
WS02 - Alterada obrigatoriedade do atributo
“is_empresa_lider no objeto PessoaJuridica;
2.0.3 23/10/2017 WS01, WS02 - Adicionado atributo opcional Genison Ribeiro

atividades_especializadas.
2.0.2 20/10/2017 WS02 - Adicionado atributo opcional co_nacionalidade nos Genison Ribeiro
dados de pessoa física do objeto Socio.
2.0.1 16/10/2017 WS02, WS03 - Adicionado atributo opcional questionario. Genison Ribeiro
2.0.0 11/09/2017 Criação do documento. Genison Ribeiro
16
Sumário
1. Introdução 22
2. Padrão dos serviços 23
3. Segurança 24
4. Recebimento de dados pelos órgãos integrados 25
4.1. WS01 - Solicitação de consulta prévia 26
4.1.1. Descrição 26
4.1.2. Dados adicionais 26
4.1.3. Request 26
4.1.4. Response 32
4.1.4.1. Requisição Mal Formada 400 - (BAD REQUEST) 32
4.1.4.1.1. Response - Tabela de erros específicos do WS01 33
4.1.4.1.2. Response - Tabela de códigos de retorno comuns 33
4.1.4.2. Sucesso – 201 (Resource Created) 33
WS02 – Dados de empresas 33
4.1.7. Request 34
4.1.8. Response 51
4.2. WS03 – Mudança de status de documentos 52
4.2.3. Request 52
4.2.4. Response 53
4.3. WS04 - Solicitação de documentos 54
4.3.3. Request 54
4.3.4. Response 56
17
4.4. WS05 - Cancelamento de solicitação 57
4.4.3. Request 57
4.4.4. Response 58
4.5. WS06 - Retorno de exigências 59
4.5.3. Request 59
4.5.4. Response 61
4.6. WS07 – Dados Simples Nacional 62
4.6.3. Request 62
4.6.4. Response 63
4.7. WS15 – Dados Produtor Rural 65
4.7.3. Request 65
4.7.4. Response 70
5. Recebimento de dados pelo Integrador Estadual 71
5.1. WS20 - Resposta de consulta prévia 72
5.1.3. Request 73
18
5.1.4. Response 74
5.2. WS21 - Resposta de solicitação de documentos e baixa 75
5.2.3. Request 75
5.2.4. Response 77
5.3. WS22 - Andamento da solicitação 79
5.3.3. Request 80
5.3.4. Response 81
5.4. WS23 – Consulta dados DBE 82
5.4.3. Request 83
5.4.4. Response 83
5.4.4.2. Sucesso – 200 (success) 84
5.5. WS24 – Busca de arquivos 84
5.5.3. Request 84
5.5.4. Response 85
5.5.4.1.2. Response – Tabela de erros específicos do WS24 85
19
5.6. WS25 – Busca de dados Simples Nacional 86
5.6.3. Request 86
5.6.4. Response 86
5.7. WS26 – Marcação de CNPJ de interesse 88
5.7.3. Request 88
5.7.4. Response 89
5.8. WS29 – Envio Dados Processo 90
5.8.3. Request 90
5.8.4. Response 91
5.9. WS42 – Recupera Dados Empresa 92
5.9.3. Request 92
5.9.4. Response 92
5.9.4.2. Response Erro 98
6. Serviços complementares fora do escopo da REDESIM 98
6.1. WS30 – Consulta de endereço 99
20
6.1.3. Request 99
6.1.4. Response 99
6.1.4.2. Sucesso – 200 (success) 100
6.2. WS31 – Consulta dados do CRC 101
6.2.3. Request 101
6.2.4. Response 102
6.2.4.2. Sucesso – 200 (success) 102
6.3. WS32 – Gerar documento de arrecadação 104
6.3.3. Request 105
6.3.4. Response 105
6.3.4.2. Sucesso – 200 (success) 106
6.4. WS33 – Busca pagamentos 107
6.4.3. Request 107
6.4.4. Response 107
6.4.4.2. Sucesso – 200 (success) 108
7. Tabelas 108
21
1. Introdução
Com a implantação da REDESIM – Rede Nacional para a Simplificação do Registro e da

Legalização de Empresas e Negócios surge uma série de necessidades de comunicação
entre os órgãos responsáveis pelos processos de inscrição, alteração e baixa de
empresas. Para os órgãos que utilizam o SIGFÁCIL como ferramenta, o mesmo já
disponibiliza uma série de funcionalidades criadas com intuito de permitir esta
comunicação entre órgãos envolvidos no processo. Para os órgãos que possuem um
sistema próprio e que não desejam utilizar o SIGFÁCIL como ferramenta, foi criada uma
solução de comunicação através de serviços, tanto de envio de dados aos órgãos
integrados como de retorno dos órgãos integrados ao SIGFÁCIL.
A troca de dados é feita exclusivamente por serviços, de forma segura, utilizando

certificado digital assinado pela Vox Tecnologia. Desta forma, garantimos a autenticidade
das informações trafegadas.
O órgão integrado terá a responsabilidade de implementar e manter o conjunto de

serviços descritos no item 4. Serviços de envio de dados aos órgãos integrados de acordo
com a necessidade de cada órgão. Da mesma forma, a Vox Tecnologia terá a
responsabilidade de implementar e manter o conjunto de serviços descritos no item 5.
Serviços de envio de dados pelos órgãos integrados.
Para realização da implementação dos consumos aos serviços temos a disposição um

ambiente reservado para a criação de solicitações e andamento das mesmas:
http://demo.<nome_do_portal_do_estado>.<uf>.gov.br.
Este é um documento técnico, sendo necessário conhecimento da área de Tecnologia da

Informação para melhor entendimento do conteúdo descrito neste manual. O documento
é direcionado aos órgãos que desejam realizar a integração do SIGFÁCIL com o sistema
próprio do órgão.
Problemas identificados na integração ou em serviços específicos devem ser reportados

através da nossa ferramenta de bugtracker (http://mantis.voxtecnologia.com.br).
Dúvidas sobre o processo devem ser direcionadas a nossa equipe técnica, através do e-
mail [email protected] ou através do telefone (83) 3031-0123.
22
2. Padrão dos serviços
Os serviços descritos abaixo deverão ser serviços RESTful. Todas as orientações acerca
de validações e endpoints devem ser implementados de acordo com o que consta neste
manual.
Como padrão, para os requests e retornos dos serviços deverá ser utilizado JSON
(JavaScript Object Notation).
Os serviços de envio de dados aos órgãos integrados deverão ser implementados de
forma que se algum parâmetro adicional for passado, o mesmo não seja rejeitado. Isto é
necessário para que os órgãos recebam as informações normalmente mesmo se campos
adicionais forem adicionados pela Vox Tecnologia ao longo do avanço dos leiautes de
integração.
23
3. Segurança
Para o envio ou recebimento de mensagens, será utilizada autenticação através de token.

Cada órgão receberá UM token para envio de dados e UM token para recebimento de
dados. O token será uma string de 128 caracteres, gerada em SHA512.
Ao enviar uma requisição para os serviços disponibilizados na ponta do SIGFÁCIL, o

órgão deverá adicionar ao HEADER da requisição uma chave “auth-token” que terá como
valor a string do token (de envio de dados) fornecido pela Vox Tecnologia. Da mesma
forma, ao enviar dados para o órgão integrado, o SIGFÁCIL irá enviar no HEADER da
requisição a mesma chave “auth-token”, contendo o segundo token (de recebimento de
dados) fornecido ao órgão pela Vox Tecnologia.
Cada um dos ambientes utilizados, de demonstração e produção, terá um par de tokens

diferentes.
Os tokens e configuração de autorização dos serviços permitidos pelo órgão deverão ser
solicitados à Vox Tecnologia previamente.
24
4. Recebimento de dados pelos órgãos integrados
Sempre que existir necessidade de informação aos órgãos integrados sobre solicitações
de consulta prévia e documentos ou de atualização do órgão sobre o andamento pelos
outros órgãos interessados no processo ou pelo cliente, será disparado consumo a um
dos serviços listados abaixo, cujo desenvolvimento e manutenção são de
responsabilidade do órgão integrado.
Todos os dados enviados através dos serviços são os dados atualizados da empresa.
No caso do serviço WS01 – Solicitação de consulta prévia são os dados consolidados de
inscrição ou alteração da empresa. Por exemplo, se uma empresa solicita a remoção de
atividades exercidas, as atividades enviadas serão o conjunto final após a alteração ser
realizada.
No caso do serviço WS02 – Dados de empresas, os dados enviados serão os atualizados,
exceto o quadro societário, que indicará a data de saída do
sócio/representante/administrador que foi realizada naquele evento.
Figura 1 - Serviços de envio de dados aos órgãos integrados
Para garantir a compatibilidade do Integrador Estadual com todos os órgãos integrados é

estritamente necessário que os serviços sejam desenvolvidos seguindo exatamente as
instruções fornecidas neste manual. Caso alguma necessidade de alteração seja
encontrada pelo órgão integrado, a mesma deverá ser solicitada a nós através de caso
no Mantis, para que seja discutida e acordada com os demais órgãos integrados e
planejada a mudança.
Cada órgão integrado irá utilizar um conjunto de serviços diferentes de acordo com sua
responsabilidade e necessidades no processo. É possível verificar a utilização dos
serviços de acordo com o perfil do órgão conforme tabela abaixo:
25
PERFIL
SERVIÇO Meio Junta
Prefeitura Bombeiros VISA SEFAZ Cartório OAB
Ambiente Comercial
WS01 -
Solicitação de x x x
consulta prévia
WS02 - Dados de
x x x x x x x x
empresas
WS03 - Mudança
de status de x x x x x
documentos
WS04 -
Solicitação de x x x x x
documentos
WS05 -
Cancelamento de x x x x
solicitação
WS06 - Retorno
x x x x x
de exigências
WS07 – Dados
x x x x x
Simples Nacional
Tabela 1 – Serviços de envio de dados aos órgãos integrados x necessidade por perfil
4.1. WS01 - Solicitação de consulta prévia
4.1.1. Descrição
Serviço que possui a finalidade de informar ao órgão responsável pelas análises de
viabilidade (nome e localização) que uma solicitação foi realizada no Integrador
Estadual. A fila para envio através deste serviço será incrementada sempre que uma
solicitação de evento que necessite consulta de viabilidade for realizada.
Após a análise da viabilidade, os órgãos responsáveis pela análise de nome e de

endereço deverão informar a resposta ao Integrador Estadual através do serviço WS
Resposta de consulta prévia.
4.1.2. Dados adicionais
URL: https://<url-do-orgao-integrado>/v1/integracao/consultas-previas
Verbo HTTP: POST
4.1.3. Request
26
Request Body
Campo Tipo Tamanho OB Descrição

Objeto contendo os campos de controle
da mensagem para identificação e
controle Controle - S validação dos dados.
Objeto contendo os dados da consulta
dados_consulta_previa DadosConsultaPrevia - S prévia.
Controle

Número identificador do órgão ao qual a
nu_identificador_orgao Integer - S mensagem é direcionada.
Nome do órgão ao qual a mensagem é
ds_orgao String 200 S direcionada.
DadosConsultaPrevia

Número de identificação dos dados salvos
pelo serviço. Somente enviado no retorno
id Integer - N Sucesso - 201 pelo serviço.
Número do protocolo gerado pela
co_protocolo_redesim String 13 S solicitação no Integrador Estadual.
Data da solicitação no Integrador
Estadual.
dt_solicitacao String 19 S Formato: YYYY-MM-DD HH:MM:SS
CNPJ da empresa (matriz ou filial) que
está solicitando o evento (apenas
números).
nu_cnpj String 14 N Obrigatório para os eventos de alteração.

CNPJ da matriz (apenas números).
Se o campo vier preenchido, a empresa
que está solicitando a consulta de nome,
nu_cnpj_matriz String 14 N indicada pelo campo nu_cnpj, é uma filial.
Identifica se a consulta prévia é apenas
para atualização na Receita Federal:
- true;
is_atualizacao_receita Boolean - S - false
solicitante Solicitante - S Objeto contendo os dados do solicitante.
Array de objeto OpcaoNome contendo as
opções de nome empresarial.
Obrigatório para os eventos 101, 102, 220

opcoes_nome OpcaoNome[] - N e 210 entrando na UF.
ds_objeto_social String 14000 S Descrição do objeto social.
27
Array de objetos do tipo Atividade,
atividades Atividade[] - S listando as atividades da empresa.
Array de objetos do tipo EventoRedesim,
contendo os eventos REDESIM
eventos EventoRedesim[] - S solicitados.
Código da natureza jurídica da empresa
co_natureza_juridica String 5 S da solicitação. Ver tabela
Código do enquadramento da empresa.
co_enquadramento Integer - S Ver tabela
Array de objetos do tipo Sócio listando os
socios Socio[] - N dados do sócio, titular ou empresário.
Objeto contendo os dados de endereço
endereco Endereco - S da empresa.
co_tipo_unidade Integer - S Código do tipo de unidade. Ver tabela
Array de objetos do tipo
FormaAtuacaoDto, listando as formas de
atuação da empresa.
Obrigatório quando o tipo de unidade for
formas_atuacao FormaAtuacao[] - N 0.
Objeto contendo dados referentes à
utilizacao_solo UtilizacaoSolo - N utilização do solo.
Array de objetos do tipo Pergunta
contendo as perguntas e respostas da
coleta adicional de dados da consulta
questionario Pergunta[] - N prévia.
CNPJ da entidade de registro que
empresa dará entrada ao processo.
Obrigatório para naturezas jurídicas

nu_cnpj_entidade_registro String 14 N registradas em cartório.
CNPJ da entidade de registro do
nu_cnpj_entidade_registro_matriz String 14 N estabelecimento da matriz.
Objeto contento informações sobre a
classificacao_risco ClassificacaoRisco - N classificação de risco.
Solicitante
nu_cpf String 11 S CPF do solicitante (apenas números).

ds_nome String 200 S Nome do solicitante.
Informa se é um contador:
- true;
is_contador Boolean - S - false
DDD do telefone.
Obrigatório para todos os eventos de natureza

nu_ddd_telefone String 2 N diferente de MEI.
nu_telefone String 10 N Número do telefone (apenas números).
nu_ramal String 4 N Ramal do telefone.
28
ds_email String 150 N E-mail.
OpcaoNome

ds_opcao_nome String 300 S Opção de nome empresarial.
Atividade

co_cnae String 12 S Código CNAE. Ver tabela
Indica se é a atividade principal:
- true;
is_atividade_principal Boolean - S - false.
Indica se a atividade é exercida no
endereço:
- true;
is_exerce_no_endereco Boolean - N - false.
AtividadeEspecializada. OBS: Uso
atividades_especializadas AtividadeEspecializada[] - N exclusivo da prefeitura
AtividadeEspecializada

co_cnae_especializada String 17 S Código CNAE especializado da prefeitura.
- true;
Indica se a atividade é exercida no endereço:
- true;
is_exerce_no_endereco Boolean - S - false.
Socio

ds_nome String 200 S Nome do sócio, titular ou empresário.
CPF ou CNPJ do sócio, titular ou empresário
nu_cpf_cnpj String 14 S (apenas números).
ds_nome_mae String 150 N Nome da mãe do sócio, titular ou empresário.
Endereco

co_uf Integer. - N Código da UF. Ver tabela
co_cep String 8 S CEP do endereço (apenas números).
29
co_tipo_imovel Integer - N Código do tipo do imóvel. Ver tabela
Código do tipo de logradouro. Ver

co_tipo_logradouro Integer - S tabela
ds_tipo_logradouro String 100 S Descrição do tipo de logradouro.
Descrição do logradouro (sem o tipo de

ds_endereco String 100 S logradouro).
nu_numero String 7 S Número.
ds_bairro String 50 S Bairro.
Lista de complementos do endereço da

empresa, separados por ";" com o
máximo de 6 tipos de complementos.
ds_complemento String 162 N Ver tabela
Código do município (IBGE sem dígito

co_municipio Integer - S verificador). Ver tabela
co_municipio_tom Integer - S Código do município (TOM). Ver tabela
Área total do terreno da empresa (em

metros quadrados).
nu_area_total String 15 N Formato: NNNNNNNNNN.NN
Área utilizada pela empresa (em metros

quadrados).
nu_area_utilizada String 15 N Formato: NNNNNNNNNN.NN
Descrição de um ponto de referência

ds_ponto_referencia String 150 N para o endereço.
Objeto do tipo NaturezaImovel contendo

os dados de inscrição imobiliária ou
natureza_imovel NaturezaImovel - N rural.
Objeto contendo as coordenadas

coordenadas_geograficas Point - N geográficas (latitude, longitude).
FormaAtuacao

Código das formas de atuação da empresa. Ver
co_forma_atuacao Integer - S tabela
Point

Formato: -##.################ (negativo) ou
nu_latitude String 20 S ##.################ (positivo).
30
nu_longitude String 20 S ##.################ (positivo).
NaturezaImovel

co_tipo_natureza String 1 S Tipo de natureza do imóvel. Ver tabela
Número de inscrição (urbana ou rural).
Obrigatório quando co_tipo_natureza = 1 ou

nu_inscricao String 30 S co_tipo_natureza = 2.
UtilizacaoSolo

co_utilizacao_solo Integer - S Código do tipo de utilização do solo. Ver tabela
Número de autorização/permissão para
nu_autorizacao String 40 S utilização do solo.
ds_arquivo Arquivo[] - N Array de objetos do tipo Arquivo.
Arquivo

URL do serviço a ser consumido para recuperar
o arquivo.
O serviço utilizado na busca de arquivos será o

ds_url_servico String - S WS24
EventoRedesim
co_evento Integer - S Código do evento da solicitação. Ver tabela
Pergunta

Código da pergunta respondida pelo solicitante
co_pergunta Integer - S no momento da solicitação. O número da
31
pergunta está disponível na funcionalidade de
“Perguntas” já que são dados dinâmicos,
definidos por cada órgão integrado.
ds_pergunta String 500 S Descrição da pergunta cadastrada no sistema.
ds_resposta String 5000 S Resposta da pergunta.
ClassificacaoRisco

Risco definido de acordo com as
ds_tipo_risco String 20 S atividades e respostas.
PerguntaClassificacaoRisco
contendo as perguntas e respostas
da coleta para a classificação de
pergunta_classificacao_risco PerguntaClassificacaoRisco[] - S risco da empresa.

Identificador da pergunta respondida pelo
solicitante no momento da solicitação. Ver
co_identificador_pergunta String 20 S tabela
4.1.4. Response
4.1.4.1. Requisição Mal Formada 400 - (BAD REQUEST)
Response
erros Erro[] - S Array de objetos de erro.
Erro
co_retorno String 4 S Código de erro Interno (Item 4.1.4.1.1)
ds_retorno String 2000 S Descrição do erro Interno
32
ds_valor String 2000 S Valor inválido
4.1.4.1.1. Response - Tabela de erros específicos do WS01
HTTP Code Código Descrição Observação
O município possui
Atividade CNAE possui especialização especialização de CNAE e o
400 9801
e apenas a raiz foi informada serviço não enviou este
detalhamento
4.1.4.1.2. Response - Tabela de códigos de retorno comuns
4.1.4.2. Sucesso – 201 (Resource Created)
Response body
Tipo OB Descrição
Recurso WS01, incluindo o ID de registro no

DadosConsultaPrevia S banco
WS02 – Dados de empresas
4.1.5. Descrição
Serviço responsável por informar aos órgãos interessados na solicitação todos os
dados atualizados¹ da empresa que realizou eventos de inscrição, alteração² ou
baixa, independente do tipo de evento que foi realizado.
Após a finalização do processo no órgão de registro ou quando houver um
cancelamento³ do processo e feita comunicação desse procedimento ao Integrador
Estadual, a instrução para envio dos dados será inserida em fila para distribuição a
todos os órgãos interessados.
Caso existam documentos que são emitidos automaticamente pelo sistema próprio do
órgão ou nos casos de deferimento de baixa automaticamente, o processo de emissão
deste documento ou baixa deve iniciar logo após o recebimento destas informações
da empresa e respondido ao integrador estadual através do WS21 – Resposta de
solicitação de documentos e baixa.
¹ Se o evento a ser realizado for evento de alteração de quadro societário, o

sócio/titular/administrador/representante removidos serão enviados com data de
término de mandato ou data de saída da sociedade;
33
² Se o evento realizado for alteração de endereço entre municípios ou entre estados,
os órgãos integrados de origem receberão registro de uma empresa que não está
localizada no seu município ou estado. Nestas situações, a solicitação deverá ser
tratada como uma baixa pelo órgão de origem. Os órgãos de destino tratarão como
uma inscrição.
³ Esse recurso pode enviar o cancelamento do processo no órgão de registro quando

o mesmo for feito por oficio ou em analise posterior a um deferimento automático,
desse modo o serviço do órgão integrado não deve criticar o recebimento de outro
recurso com mesmo protocolo redesim com uma situação empresa Cancelada.
URL: https://<url-do-orgao-integrado>/v1/integracao/empresas
Verbo HTTP: POST
4.1.7. Request
Request Body

Objeto contendo os campos de controle da
mensagem para identificação e validação dos
controle Controle - S dados.
dados_solicitacao DadosSolicitacao - S Objeto contendo os dados da solicitação.
Controle

DadosSolicitacao

Data da solicitação no Integrador Estadual.
dt_solicitacao String 19 N Formato: YYYY-MM-DD HH:MM:SS
34
Data de autenticação do processo na
entidade de registro. Formato: YYYY-MM-
dt_autenticacao String 19 N DD HH:MM:SS
co_recibo_dbe String 10 N Código do recibo do DBE.
Código de identificação do DBE (apenas
nu_identificacao_dbe String 14 N números).
Código do tipo de entidade de registro
responsável pelo registro da empresa. Ver
co_tipo_entidade_registro Integer - S tabela
Número do CNPJ da entidade de registro
nu_cnpj_entidade_registro String 14 N responsável pelo registro da empresa.
CNPJ da entidade de registro do
nu_cnpj_entidade_registro_matriz String 14 N estabelecimento da matriz.
Campo indicando se é um processo
vinculado:
- true;
is_vinculado Boolean - N - false.
solicitante Solicitante - N Objeto contendo os dados do solicitante.
Array de objetos contendo os dados
referentes a atos e eventos utilizados pela
dados_entidade_registro DadosRegistro[] - N entidade de registro.
Array de objetos contendo os arquivos
arquivos_entidade_registro ArquivosRegistro[] - N autenticados pelo órgão de registro.
Array de objetos EventoRedesimDto
contendo os eventos realizados para a
eventos_redesim EventoRedesim[] - S empresa naquela solicitação
empresa Empresa - S Objeto contendo os dados da empresa.
dados_ato_legal DadosAtoLegal - N Objeto contendo os dados de ato legal.
Objeto contendo dados de questionários
adicionais coletados pelos diversos órgãos
questionario Pergunta[] - N envolvidos no processo.
Objeto contendo informações sobre a
classificação_risco ClassificacaoRisco - N classificação de risco.
Solicitante

- true;
nu_ddd_telefone String 2 N DDD do telefone.
35
DadosRegistro
co_protocolo String 10 N Protocolo interno da entidade de registro.

nu_arquivamento String 14 N Número de arquivamento.
co_ato String 3 N Código do ato. Ver tabela
Array de objetos Evento contendo os eventos
eventos Evento[] - N realizados pela empresa no processo
ArquivosRegistro
nu_tipo_arquivo Integer - S Código do tipo de arquivo. Ver tabela

URL do serviço a ser consumido para recuperar o
arquivo.

Evento
co_evento String 3 S Código do evento. Ver tabela

Quantidade de vezes que o evento é realizado no
nu_quantidade Integer - S processo.
EventoRedesim
co_evento Integer - S Código do evento da solicitação. Ver tabela
Empresa

CNPJ da empresa (matriz ou filial)
que está solicitando o evento
(apenas números).
Campo obrigatório quando consumo

é realizado para órgãos diferentes
nu_cnpj String 14 N de cartório e OAB.
Número de registro na entidade
responsável pelo registro da
nu_registro String 40 N empresa.
36
Número de registro anterior nos
casos em que existe evento de
nu_registro_anterior String 40 N alteração de natureza jurídica.
Número do sequencial da pessoa
jurídica no sistema da Junta
nu_seq_pessoa Integer - N Comercial (SIARCO).
Nome empresarial sem partícula de
ds_nome_empresarial String 400 S porte.
ds_nome_fantasia String 150 N Nome fantasia.
Número do CNPJ da matriz.
nu_cnpj_matriz String 14 N
nu_registro_matriz String 40 N Número de registro da Matriz.
Número do telefone (apenas
nu_telefone String 10 N números).
ds_email String 150 N Endereço de e-mail da empresa.
ds_sitio String 100 N Endereço do site da empresa.
Código da natureza jurídica da
co_natureza_juridica String 5 S empresa. Ver tabela
Código do enquadramento da
co_enquadramento Integer - N empresa. Ver tabela
Código do tipo de unidade. Ver
co_tipo_unidade Integer - N tabela
FormaAtuacaoDto.
Obrigatório quando o tipo de unidade

formas_atuacao FormaAtuacao[] - N for 0.
ds_objeto_social String 14000 N Objeto social da empresa.
atividades Atividade[] - S AtividadeDto.
Valor do capital social da empresa.
nu_capital_social Numeric 15.2 N Formato: #############.##
Valor do capital integralizado da
empresa.
nu_capital_integralizado Numeric 15.2 N Formato: #############.##
Valor do destaque do capital para a
filial.
nu_destaque_capital Numeric 15.2 N Formato: #############.##
nu_valor_quotas Integer 20 N Valor de quotas da empresa.
Array de objetos do tipo SocioDto.
socios Socio[] - N
Objeto contendo os dados do
responsavel_legal ResponsavelLegal - N responsável legal pela empresa.
Data da assinatura da ata.
dt_assinatura_ata String 10 N Formato: YYYY-MM-DD
Data de constituição da empresa.
dt_constituicao String 10 N Formato: YYYY-MM-DD
37
Data de início das atividades da
empresa.
dt_inicio_atividades String 10 N Formato: YYYY-MM-DD
Data de término de atividades da
empresa.
dt_termino_atividades String 10 N Formato: YYYY-MM-DD
Data de último arquivamento de
processo para a empresa.
dt_ultimo_arquivamento String 10 N Formato: YYYY-MM-DD
Informa se é uma empresa satélite:
- true;
is_empresa_satelite Boolean - N - false
CNPJ do operador logístico (apenas
números).
Obrigatório se is_empresa_satelite =
nu_cnpj_operador_logistico String 14 N true.
Informa se é um operador logístico:
- true;
is_operador_logistico Boolean - N - false
Tipo de prática de comércio exterior.
co_tipo_pratica_comercio_exterior Integer - N Ver tabela
responsavel_contabil ResponsavelContabil - N responsável contábil pela empresa.
Objeto contendo os dados de
endereco Endereco - N endereço da empresa.
utilizacao_solo UtilizacaoSolo - N utilização do solo pela empresa.
Descreve a situação da empresa na
entidade de registro. Ver tabela
co_situacao_empresa String 2 N Exclusivo para Junta Comercial.
Descreve o status da empresa na
co_status_empresa String 2 N Exclusivo para Junta Comercial.
Objeto contento os dados de
substituição tributária.
Obrigatório e enviado somente nos
substituto_tributario SubstitutoTributario - N eventos de substituição tributária.
nu_cnpj_sucessora String 14 N CNPJ da empresa sucessora.
Objeto contendo informações se a
empresa é optante pelo Simples
simples_nacional SimplesNacional - N nacional.
ds_caixa_postal String 20 N Caixa postal da empresa
Data do término do exercício social
da empresa.
dt_termino_exercicio_social String 10 N Formato: YYYY-MM-DD
Data de início da integralização do
capital.
dt_inicio_integralizacao String 10 N Formato: YYYY-MM-DD
Data de término da integralização do
dt_termino_integralizacao String 10 N capital.
38
Formato: YYYY-MM-DD
dados_itcmd DadosItcmd - N Imposto ITCMD da empresa.
Objeto contendo os dados referente
clausula_contratual ClausulaContratual - N a clausula contratual.
Array de objeto do tipo filiais,
filiais Filial[] - N contendo dados das filiais da matriz.
Endereco
co_cep String 8 N Código do CEP da empresa.

co_tipo_imovel Integer - N Código do tipo do imóvel. Ver tabela
co_tipo_logradouro Integer - N Código do tipo de logradouro. Ver tabela
ds_tipo_logradouro String 100 N Descrição do tipo de logradouro.
ds_endereco String 100 N logradouro).
nu_numero String 7 N Número.
ds_bairro String 50 N Bairro.
Lista de complementos do endereço da empresa,
separados por ";" com o máximo de 6
ds_complemento String 162 N complementos. Ver tabela
co_municipio Integer - S verificador). Ver tabela
co_municipio_tom Integer - N Código do município (TOM). Ver tabela
co_uf Integer - N Código da UF. Ver tabela
nu_area_total String 15 N Área total do imóvel.
nu_area_utilizada String 15 N Área utilizada pelo estabelecimento.
ds_ponto_referencia String 300 N Ponto de referência.
natureza_imovel NaturezaImovel - N Objeto do tipo NaturezaImovelDto.
Objeto contendo as coordenadas geográficas
coordenadas_geograficas Point - N (latitude, longitude).
NaturezaImovel
co_tipo_natureza String 1 N Tipo de natureza do imóvel. Ver tabela

nu_inscricao String 30 N Número de inscrição (urbana ou rural).
- Array de objeto contendo informações das
inscrições imobiliárias adicionais.
Campo exclusivo para os eventos de inscrição
inscricao_adicional InscricaoAdicional[] N no município.
Point
39
UtilizacaoSolo
co_utilizacao_solo Integer - S Código do tipo de utilização do solo. Ver tabela

40 Número de autorização/permissão para utilização
nu_autorizacao String S do solo.
ds_arquivo Arquivo[] - N Array de objetos do tipo Arquivo.
Arquivo

arquivo.
FormaAtuacao

Código das formas de atuação da empresa. Ver
co_forma_atuacao Integer - N tabela
Atividade

- true;
Indica se a atividade é exercida no
endereço:
- true;
is_exerce_no_endereco Boolean - N - false.
atividades_especializadas AtividadeEspecializada[] - N AtividadeEspecializada.
AtividadeEspecializada
40
co_cnae_especializada String 17 S Código CNAE especializado da prefeitura.
- true;
Indica se a atividade é exercida no endereço:
- true;
is_exerce_no_endereco Boolean - S - false.
ResponsavelContabil

CPF ou CNPJ do responsável contábil
co_cpf_cnpj String 14 N (apenas números).
ds_nome String 200 N Nome do responsável contábil.
E-mail do responsável pela empresa de
ds_email String 150 N contabilidade.
DDD do telefone do responsável pela
nu_ddd_telefone String 4 N empresa de contabilidade.
Telefone do responsável pela empresa
nu_telefone String 10 N de contabilidade.
DDD do celular do responsável pela
nu_ddd_celular String 4 N empresa de contabilidade.
Celular do responsável pela empresa
nu_celular String 10 N de contabilidade.
Tipo de pessoa do responsável
contábil:
1 = Pessoa física;
nu_tipo_pessoa Integer - S 2 = Pessoa jurídica;
Objeto contendo os dados do contador
responsável pela empresa de
responsavel Responsavel - N contabilidade.
Objeto contendo dados do conselho de
dados_conselho DadosConselho - N classe (CRC) do responsável contábil.
Objeto contendo dados do endereço do
endereco EnderecoResponsavelContabil - N responsável contábil.
Responsavel

CPF do responsável pela empresa de
nu_cpf String 11 N contabilidade.
E-mail do responsável pela empresa de
ds_email String 150 N contabilidade.
DDD do telefone do responsável pela
nu_ddd_telefone String 4 N empresa de contabilidade.
41
Telefone do responsável pela empresa
nu_telefone String 10 N de contabilidade.
DDD do celular do responsável pela
nu_ddd_celular String 4 N empresa de contabilidade.
Celular do responsável pela empresa
nu_celular String 10 N de contabilidade.
Objeto contendo os dados do conselho
de classe (CRC) do contador
dados_conselho DadosConselho - N contabilidade.
contador responsável pela empresa de
endereco EnderecoResponsavelContabil - N contabilidade.
DadosConselho
co_uf_crc Integer - N Código da UF do CRC. Ver tabela

nu_sequencia String 10 N Número sequencial do CRC.
dt_registro String 10 N Data do registro no CRC. Formato: YYYY-MM-DD
co_tipo_classificacao_crc Integer - N Tipo de classificação no CRC. Ver tabela
nu_tipo_crc Integer - N Tipo de CRC. Ver tabela
nu_crc String 10 N Número do CRC.
EnderecoResponsavelContabil
co_cep String 8 N CEP.

Código do município (IBGE sem dígito verificador).
co_municipio Integer - N Ver tabela
co_uf Integer - N Código da UF do município Ver tabela
Socio

Tipo de pessoa do sócio:
co_tipo_pessoa Integer - N 1 = Pessoa física;
42
2 = Pessoa jurídica;
Número do CPF ou CNPJ do sócio (apenas
nu_cpf_cnpj String 14 N números).
ds_nome String 400 N Nome (empresarial ou de pessoa física).
ds_email String 150 N Endereço de e-mail.
nu_telefone String 10 N Telefone.
nu_ddd_celular String 4 N DDD do celular.
nu_celular String 10 N Celular.
endereco EnderecoSocio - N Objeto contendo dados de endereço
qualificacoes Qualificacao[] - N Array de objetos do tipo QualificacaoDto.
dados_pessoa_fisica PessoaFisica - N Objeto contendo dados referentes à pessoa física.
Objeto contendo dados referentes à pessoa
dados_pessoa_juridica PessoaJuridica - N jurídica.
PessoaFisica
co_estado_civil Integer - N Estado civil. Ver tabela

co_regime_bens Integer - N Código do regime de bens. Ver tabela
Data de nascimento. Formato: YYYY-MM-
dt_nascimento String 10 N DD
Código da nacionalidade da pessoa física
(titular, sócio, representante ou
co_nacionalidade Integer - N administrador). Ver tabela
Código do município de naturalidade
co_municipio_naturalidade Integer - N (IBGE sem dígito verificador). Ver tabela
Código da UF referente à naturalidade.
co_uf_naturalidade Integer - N Ver tabela
Código do sexo:
1 = Masculino;
co_sexo Integer - N 2 = Feminino;
Objeto contendo os dados do documento
documento_identificacao DocumentoIdentificacao - N de identificação da pessoa.
ds_cargo String 300 N Descrição do cargo.
ds_mae String 100 N Nome da mãe.
ds_pai String 100 N Nome do pai.
Indica se pessoa é emancipada (true ou
is_emancipado Boolean - N false)
Código do motivo da emancipação. Ver
co_motivo_emancipacao Integer - N tabela
Informa se o sócio é um espolio (true ou
is_espolio Boolean - N false)
43
co_cpf_conjuge String 11 N CPF do cônjuge
ds_nome_conjuge String 200 N Nome do cônjuge.
DocumentoIdentificacao

Código do tipo de documento de identificação. Ver
co_tipo_documento Integer - N tabela
nu_documento_identificacao String 30 N Número do documento de identificação
Descrição do órgão expedidor do documento de
ds_orgao_expedidor String 30 N identificação.
Data de emissão do documento de identificação.
dt_documento_emissao String 10 N Formato: YYYY-MM-DD

Código da UF do órgão emissor do documento de
co_uf_emissor Integer - N identificação. Ver tabela
is_documento_provisorio Boolean - N Indica se o documento é provisório (true ou false)
Data de validade do documento provisório.
dt_documento_validade String 10 N Formato: YYYY-MM-DD
PessoaJuridica
nu_registro String 40 N Número de registro da empresa.

Data do ano de registro da empresa.
nu_ano_registro String 4 N Formato: YYYY.

CNPJ da entidade responsável pelo registro da
nu_cnpj_entidade_registro String 14 N empresa.
Indica se é uma empresa lider de consórcio:
- true;
is_empresa_lider Boolean - N - false.
Código da natureza jurídica do sócio Pessoa
co_natureza_juridica String 5 N Jurídica. Ver tabela
Código do tipo de entidade de registro responsável
co_tipo_entidade_registro Integer - N pelo registro da empresa. Ver tabela
co_enquadramento Integer - N Código do enquadramento da empresa. Ver tabela
EnderecoSocio
co_pais Integer - N Código do país. Ver tabela

44
co_municipio_tom Integer - N Código do município (TOM). Ver tabela
co_uf Integer - N Código da UF. Ver tabela
co_cep String 8 N CEP (apenas números).
ds_tipo_logradouro String 100 N Descrição do tipo de logradouro.

ds_endereco_completo String 200 N Endereço completo de sócio residente no exterior.
ds_cidade_exterior String 55 N Cidade do sócio residente no exterior.
Qualificacao

Código do tipo de qualificação de acordo com
co_tipo_qualificacao_rfb Integer - N tabela da Receita Federal. Ver tabela
Código do tipo de qualificação de acordo com
co_tipo_qualificacao_registro Integer - N entidade de registro. Ver tabela
Data de início da qualificação.
dt_inicio_qualificacao String 10 S Formato: YYYY-MM-DD
Data de fim da qualificação Formato: YYYY-MM-
dt_fim_qualificacao String 10 N DD
CPF ou CNPJ do representado.
Obrigatório indicar representado caso a

nu_cpf_cnpj_representado String 14 N qualificação seja de representante.
Valor da participação no capital social.
nu_valor_participacao Numeric 15.2 N Formato: #############.##
nu_porcentagem_participacao String 10 N Porcentagem da participação no capital social.
Número de quotas que o sócio possui na
nu_participacao_quotas Integer 20 N empresa.
ResponsavelLegal
nu_cpf String 11 S CPF do responsável legal (apenas números).

ds_nome String 200 S Nome do responsável legal.
ds_ddd_telefone String 2 N DDD do telefone.
45
Pergunta

Código da pergunta respondida pelo solicitante no
co_pergunta Integer - S momento da solicitação de consulta prévia.
DadosAtoLegal

co_tipo_ato_legal Integer - S Código do tipo de ato legal. Ver tabela
nu_ato_legal String 50 S Número do ato legal
Data do ato legal.
dt_ato_legal String 10 S Formato: YYYY-MM-DD
SubstitutoTributario

Código do tipo de Substituição
Tributária
1 – Normal
co_tipo_substituicao_tributaria Integer - N 2 – DIFAL
nu_convenio_substituicao String - N Número do convenio tributário.
Objeto contendo endereço do
endereco EnderecoSubstitutoTributario - N substituto tributário.
SimplesNacional

Indica se a empresa é optante pelo Simples
Nacional:
- true;
is_indicador_simples_nacional Boolean - N - false.
Array contendo dados do objeto
periodo_simples PeriodoSimples[] - N PeriodoSimples.
Indicação de inscrição da empresa no MEI:
- true;
is_indicador_mei Boolean - N - false.
46
periodo_mei PeriodoMei[] - N Array contendo dados do objeto PeriodoMei.
PeriodoSimples

Data de inclusão no simples nacional.
dt_inclusao String 10 N Formato: YYYY-MM-DD
Data de exclusão no simples nacional.
dt_exclusao String 10 N Formato: YYYY-MM-DD
PeriodoMei

Data de inclusão MEI.
Data de exclusão MEI.
ClausulaContratual

Indicação se a sociedade será de
regência supletiva:
- true;
is_regencia_supletiva Boolean - N - false.
Indicação da exclusão extrajudicial do
sócio minoritário:
- true;
is_exclusao_extrajudicial Boolean - N - false.
Indicação do tipo de exclusão:
- true;
is_exclusao_reuniao_assembleia Boolean - N - false.
indicação se o foro será no endereço da
Matriz:
- true;
is_foro_matriz Boolean - N - false.
Indicação se o foro será arbitral:
- true;
is_foro_arbitral Boolean - N - false.
co_uf String 2 N Código da UF. Ver tabela
co_municipio_foro Integer - N verificador). Ver tabela
47
Data de término do exercício contratuais.
dt_termino_exercicio String 10 N Formato: YYYY-MM-DD
Objeto contendo dados da integralização
integralizacao_capital IntegralizacaoCapital - N do capital social.
Indicador se a empresa terá conselho
fiscal:
- true;
is_conselho_fiscal Boolean - N - false.
Array do objeto contendo os dados dos
dados_conselheiro Conselheiro[] - N conselheiros.

Valor em dinheiro da integralização do
capital.
nu_capital_integralizado_dinheiro Numercic 15.2 N Formato: #############.##
Array do objeto contendo os dados dos
bens_movel_imovel BensMovelImovel[] - N bens moveis e imóveis.
Conselheiro

co_cpf_conselheiro String 11 N CPF do conselheiro.
ds_nome_conselheiro String 200 N Nome do conselheiro.
co_cpf_suplente String 11 N CPF do suplente
ds_nome_suplente String 200 N Nome do suplenete
BensMovelImovel

Descrição do tipo dos bens:
- Móvel
ds_tipo_bem String 6 N - Imóvel
ds_descricao String 300 N Descrição do bem móvel ou imóvel.
Valor do bem móvel ou imóvel.
nu_valor Numeric 15.2 N Formato: #############.##
CPF ou CNPJ do titular do bem móvel ou
co_cpf_cnpj_titular String 14 N imóvel.
Nome do titular físico ou Jurídico do bem móvel
ou imóvel.
ds_nome_titular String 200 N
Data da aquisição do bem imóvel.
dt_aquisicao String 10 N Formato: YYYY-MM-DD
48
Número inscrição municipal ou rural do bem
co_inscricao_municipal String 30 N imóvel.
Área total do bem imóvel.
nu_area_imovel String 15 N Formato: NNNNNNNNNN.NN
Número de registro no cartório para o bem
ds_registro_cartorio String 100 N imóvel.
Nome do cartório onde se encontra cadastrado
ds_nome_cartorio String 200 N o bem imóvel.
endereco EnderecoImovel - N Objeto contendo dados do endereço do imóvel.
EnderecoImovel

co_cep String 8 N Cep do imóvel.
ds_endereco String 300 N Descrição do logradouro do imóvel.
co_numero String 10 N Número.
ds_complemento String 162 N Complemento.
co_uf String 2 N Código da UF. Ver tabela
co_municipio Integer - N verificador). Ver tabela
Filial

Número de registro da filial na entidade de
nu_numero_registro String 40 N registro.
nu_cnpj String 14 S CNPJ da filial.
ds_uf String 2 N UF da filial.
ClassificacaoRisco

Risco definido de acordo com as
ds_tipo_risco String 20 S atividades e respostas.
contendo as perguntas e respostas
da coleta para a classificação de
pergunta_classificacao_risco PerguntaClassificacaoRisco[] - S risco da empresa.
49

Identificador da pergunta respondida pelo
solicitante no momento da solicitação. Ver
co_identificador_pergunta String 20 S tabela
InscricaoAdicional
co_inscricao_adicional String 30 S Número da Inscrição Imobiliária Adicional.
EnderecoSubstitutoTributario
co_cep String 8 S CEP do endereço.
ds_endereco String 300 S Endereço completo.
ds_complemento String 500 N Complemento do endereço.
DadosItcmd

Indicador se a empresa possui doação de
cotas:
- true;
is_possui_doacao_cotas Boolean - S - false.
Código informando o tipo da doação de cotas:
1 – Onerosa
co_tipo_doacao_cotas Numeric - S 2 – Não Onerosa
Array de objeto contendo os dados a doação
dados_doacao DadosDoacao[] - N não onerosa.
DadosDoacao
co_cpf_socio_doador String 11 S CPF do sócio doador.

50
co_cpf_socio_donatario String 11 S CPF do sócio donatário.
ds_nome_socio_donatario String 200 S Nome do sócio donatário.

Valor monetário da cota doada.
nu_valor_doacao Numeric 15.2 S Formato: #############.##
Data da doação.
dt_doacao String 10 S Formato: YYYY-MM-DD
4.1.8. Response
Response
Erro
Response body
Tipo OB Descrição
DadosSolicitacao S Recurso WS02, incluindo o ID de registro no banco
51
4.2. WS03 – Mudança de status de documentos
4.2.1. Descrição
Serviço que possui a finalidade de informar aos órgãos que possuem interesse em
determinado processo a mudança de status de documentos de emissão automática
do próprio órgão ou de todos os documentos dos demais órgãos que possuem
interesse e emitem documento para o processo.
URL: https://<url-do-orgao-integrado>/v1/integracao/status-documentos
Verbo HTTP: POST
4.2.3. Request
Request Body

dados_documento DadosDocumento - S Objeto contendo os dados do documento.
Controle

DadosDocumento

Número de identificação dos dados salvos pelo
serviço. Somente enviado no retorno Sucesso -
id Integer - N 201 pelo serviço.
nu_cnpj String 14 S CNPJ da empresa (apenas números).
Número do protocolo gerado pela solicitação no
co_protocolo_redesim String 13 S Integrador Estadual.
52
Data do evento.
dt_evento String 10 S Formato: YYYY-MM-DD.
Data de validade do documento emitido.
dt_validade String 10 N Formato: YYYY-MM-DD.
Tipo de documento que teve a situação alterada.
co_tipo_modelo_documento Integer - S Ver tabela
co_situacao Integer - S Situação do documento. Ver tabela
Número do documento.
nu_documento String 30 N Obrigatório caso o campo co_situacao = 5.

URL para o documento, caso o mesmo seja
ds_url String 2000 N emitido por sistema próprio do órgão.
Observação do processo. Utilizado caso o órgão
integrado deseje uma maior transparência na
tramitação interna para o solicitante, informando
toda a tramitação pelos setores através deste
ds_observacao String 2000 N campo.
Array de objetos do tipo Exigencia.
exigencias Exigencia[] - N Obrigatório caso o campo co_situacao = 3.

URL da taxa gerada pelo sistema próprio do
ds_url_taxa String 2000 N órgão.
questionario Pergunta[] - N Array de objetos do tipo Pergunta.
Exigencia

co_exigencia Integer - S Código do motivo de exigência. Ver tabela
ds_motivo_exigencia String 1000 S Descrição do motivo da exigência.
Pergunta

co_pergunta Integer - S momento da solicitação do documento.
4.2.4. Response
53
Response
Erro
Response body
Tipo OB Descrição
DadosDocumento S Recurso WS03, incluindo o ID de registro no banco
4.3. WS04 - Solicitação de documentos
4.3.1. Descrição
Serviço que possui a finalidade de informar sobre a solicitação de um documento pelo
usuário para determinado órgão.
Sempre que houver solicitação de documento, no acompanhamento de solicitação, o
órgão será notificado através deste serviço. Após o processamento do consumo, a
resposta do órgão integrado para este documento deverá ocorrer através do WS21 -
Resposta de solicitação de documentos e baixa.
URL: https://<url-do-orgao-integrado>/v1/integracao/solicitacoes-documentos
Verbo HTTP: POST
4.3.3. Request
54
Request Body

Objeto contendo os campos de
controle da mensagem para
controle Controle - S identificação e validação dos dados.
dados_solicitacao_documento DadosSolicitacaoDocumento - S documento.
Controle

DadosSolicitacaoDocumento

Data da solicitação do documento no Integrador
Estadual.
dt_solicitacao String 19 S Formato: YYYY-MM-DD HH:MM:SS.
co_tipo_modelo_documento Integer - S Ver tabela
Array de objetos do tipo Pergunta contendo as
perguntas e respostas da coleta adicional de
questionario Pergunta[] - N dados da consulta prévia.
empresa Empresa - S Campos relativos a empresa.
atividades Atividade[] - N Array de objetos do tipo Atividade contendo as
atividades selecionadas pelo usuário no
momento em que foi solicitado o documento.
OBS: Este campo só será preenchido para

órgãos que possuem implementação específica
55
de seleção de atividades para o documento
solicitado. Nestes casos, a primeira atividade
preenchida no array será a atividade principal
selecionada pelo usuário.
anexos Arquivo[] - N Array de objetos do tipo Arquivo, com os
documentos anexados referentes a solicitação de
licenciamento.
Empresa

ds_nome_empresarial String 400 N Nome empresarial.
nu_cnpj String 14 S CNPJ da empresa (apenas números).
Pergunta

momento da solicitação do documento. O código da
pergunta está disponível na funcionalidade de
“Perguntas” já que são dados dinâmicos, definidos
co_pergunta Integer - S por cada órgão integrado.
Atividade

Arquivo

ds_nome_arquivo String 400 S Nome do arquivo
arquivo.

4.3.4. Response

56
Response
Erro
Response body
Tipo OB Descrição
DadosSolicitacaoDocumento S Recurso WS04, incluindo o ID de registro no banco
4.4. WS05 - Cancelamento de solicitação
4.4.1. Descrição
Este serviço será acionado sempre que houver o cancelamento de uma solicitação
no Integrador Estadual, informando a todos os órgãos interessados no processo
sobre o cancelamento.
URL: https://<url-do-orgao-integrado>/v1/integracao/cancelamentos-solicitacao
Verbo HTTP: POST
4.4.3. Request
Request Body
57
identificação e validação dos
dados_cancelamento_solicitacao DadosCancelamentoSolicitacao - S cancelamento da solicitação.
Controle

DadosCancelamentoSolicitacao

Número do protocolo gerado pela solicitação
co_protocolo_redesim String 13 S no Integrador Estadual.
Data do cancelamento da solicitação.
dt_cancelamento String 19 S Formato: YYYY-MM-DD HH:MM:SS
protocolo_registro ProtocoloRegistro[] - N Array de objetos do tipo ProtocoloRegistro.
ds_motivo_cancelamento String 250 S Motivo de cancelamento da solicitação.
ProtocoloRegistro

Número do protocolo do sistema legado da
co_protocolo_registro String 32 S entidade de registro
4.4.4. Response
Response
58
Erro
Response body
Tipo OB Descrição
DadosCancelamentoSolicitacao S Recurso WS05, incluindo o ID de registro no banco
4.5. WS06 - Retorno de exigências
4.5.1. Descrição
Este serviço possui a finalidade de informar ao órgão que colocou um documento ou
solicitação de baixa em exigência de que o solicitante já realizou a resposta a esta
exigência.
O retorno será dado sempre que houver uma resposta de exigência, de documentos
ou baixa, pelo solicitante no acompanhamento de processo.
URL: https://<url-do-orgao-integrado>/v1/integracao/retorno-exigencias
Verbo HTTP: POST
4.5.3. Request
Request Body

59
Objeto contendo os dados do retorno da
dados_retorno_exigencias DadosRetornoExigencias - S exigência informados pelo solicitante.
Controle

DadosRetornoExigencias

Número do protocolo gerado para o processo
co_protocolo_redesim String 13 S pela solicitação no Integrador Estadual.
Data do retorno.
dt_retorno String 19 S Formato: YYYY-MM-DD HH:MM:SS.
Se retorno de exigência é de documento:
- true;
is_retorno_exigencia_documento Boolean - S - false.
Tipo do modelo de documento. Ver tabela
Obrigatório caso o campo

co_tipo_modelo_documento Integer - N is_retorno_exigencia_documento = 1.
exigencias Exigencia[] - S Array de objetos do tipo Exigencia.
Exigencia

Retorno da exigência informada pelo usuário
ds_retorno_exigencia String 20000 N externo.
Array de objetos do tipo Arquivo, com os
documentos anexados pelo solicitante na resposta
anexos Arquivo[] - N de exigência.
Arquivo
60
ds_nome_arquivo String 400 S Nome do arquivo
arquivo.
Os serviços de busca para cada tipo de arquivo

estão descritos nos serviços disponibilizados pelo
ds_url_servico String - S SIGFÁCIL.
4.5.4. Response
Response
Campo Tipo OB Descrição
Erro
Response body
Tipo OB Descrição
DadosRetornoExigencias S Recurso WS06, incluindo o ID de registro no banco
61
4.6. WS07 – Dados Simples Nacional
4.6.1. Descrição
Este serviço possui a finalidade de informar aos órgãos interessados sobre os dados
do simples nacional.
URL: https://<url-do-orgao-integrado>/v1/integracao/dados-simples-nacional
Verbo HTTP: POST
4.6.3. Request
Request Body

Objeto contendo os dados do retorno do
dados_simples_nacional DadosSimplesNacional - S simples nacional.
Controle

DadosSimplesNacional

nu_cnpj String 14 S CNPJ da empresa.
Nacional:
-true;
62
-true;
PeriodoSimples

PeriodoMei

4.6.4. Response
Response
Erro
63
Response body
Tipo OB Descrição
DadosSimplesNacional S Recurso WS07, incluindo o ID de registro no banco
64
4.7. WS15 – Dados Produtor Rural
4.7.1. Descrição
Este serviço possui a finalidade de informar aos órgãos interessados sobre os dados
do produtor rural.
URL: https://<url-do-orgao-integrado>/v1/integracao/dados-produtor-rural
Verbo HTTP: POST
4.7.3. Request
Request Body

dados_solicitacao DadosSolicitacao - S Objeto contendo os dados da solicitação.
Controle

DadosSolicitacao

Data da solicitação no Integrador Estadual.
dt_solicitacao String 19 S Formato: YYYY-MM-DD HH:MM:SS
solicitante Solicitante - S Objeto contendo os dados do solicitante.
dados_produtor_rural DadosProdutorRural - S Objeto contendo os dados do produtor rural.
questionario Questionario - S Objeto contendo os dados do questionário.
Array de objeto do tipo Evento contendo os
evento Evento[] - S dados do evento realizado no processo.
65
Array de objeto do tipo Atividade, contendo
atividade Atividade[] - S as atividade do processo.
Array de objeto contendo dados do arquivo
anexo Arquivo[] - N anexados.
Solicitante

- true;
contador ResponsavelContabil - N solicitante.
ResponsavelContabil

CPF ou CNPJ do responsável contábil
co_cpf_cnpj String 14 N (apenas números).
contábil:
1 = Pessoa física;
nu_tipo_pessoa Integer - S 2 = Pessoa jurídica;
responsavel Responsavel - N contabilidade.
Objeto contendo dados do conselho de
dados_conselho DadosConselho - N classe (CRC) do responsável contábil.
endereco EnderecoContabil - N responsável contábil.
Responsavel

CPF do responsável pela empresa de
nu_cpf String 11 N contabilidade.
66
Objeto contendo os dados do conselho
de classe (CRC) do contador
dados_conselho DadosConselho - N contabilidade.
DadosConselho
co_uf_crc Integer - N Código da UF do CRC. Ver tabela

nu_sequencia String 10 N Número sequencial do CRC.
dt_registro String 10 N Data do registro no CRC. Formato: YYYY-MM-DD
co_tipo_classificacao_crc Integer - N Tipo de classificação no CRC. Ver tabela
nu_tipo_crc Integer - N Tipo de CRC. Ver tabela
nu_crc String 10 N Número do CRC.
EnderecoContabil
co_cep String 8 N CEP.

co_uf Integer - N Código da UF do município Ver tabela
DadosProdutorRural

ds_nome String 200 S Nome do Produtor rural.
Data de nascimento. Formato: YYYY-
dt_nascimento String 10 S MM-DD.
documento Documento - S documento pessoal.
Descrição da escolaridade do produtor
ds_escolaridade String(50) 50 S rural.
ds_email String(200) 200 S E-mail do produtor rural.
67
Número DDD do telefone do produtor
nu_ddd Integer - S rural.
Número do telefone do produtor rural
nu_telefone Integer - S (apenas número).
dados_imovel DadosImovel - S Objeto contendo os dados do imóvel.
Campo para informar se será utilizado o
mesmo endereço da propriedade como
correspondência.
- True;
is_utilizada_mesmo_endereco Boolean - S - False.
Objeto contendo os dados do Endereço
de correspondência.
Campo obrigatório quando o
endereco_correspondencia EnderecoCorrespondencia - N is_utilizada_mesmo_endereco for false.
Documento

Código do tipo de documento de identificação do
co_tipo_documento String 50 S produtor rural. Ver tabela
Número do documento de identificação
nu_documento String 30 S selecionado.
ds_orgao_emissor String S Descrição do órgão emissor do documento de
30 identificação
co_uf_orgao_emissor Integer S Código da UF do órgão emissor do documento.
- Ver tabela
DadosImovel
nu_inscricao_rural String 30 N Número da inscrição rural.

nu_car String 30 N Número do Cadastro Ambiental Rural.
nu_ccir String N Número do Certificado de Cadastro de Imóvel
30 Rural.
nu_sigef String N Número do cadastro do Sistema de Gestão
30 Fundiária.
endereco Endereco - S Objeto contendo os dados do endereço da
propriedade
Endereco
co_cep String 8 S CEP do endereço (apenas números)

co_tipo_logradouro Integer - S Código do tipo de logradouro. Ver tabela
68
ds_endereco String 100 S Endereço, sem a indicação do tipo de logradouro
nu_numero String 7 S Número do endereço
ds_bairro String 50 S Bairro do produtor rural
ds_complemento String 156 N Complemento do endereço
co_municipio Integer S Código IBGE do município (sem dígito verificador).
- Ver tabela
co_uf Integer S Código da UF do endereço do produtor rural. Ver
- tabela
ds_ponto_referencia String 300 N Ponto de referência.
nu_area_total String S Área total do imóvel.
15 Formato: ############.##
nu_area_producao String S Área de uso do imóvel.
15 Formato: ############.##
coordenadas_geograficas Point - S Objeto contendo as coordenadas geográficas.
Point

EnderecoCorrespondencia
co_cep String 8 S CEP do endereço (apenas números)

ds_endereco String 100 S Endereço, sem a indicação do tipo de logradouro
nu_numero String 7 S Número do endereço
ds_bairro String 50 S Bairro do produtor rural
ds_complemento String 156 N Complemento do endereço
co_municipio Integer - S Código IBGE do município (sem dígito verificador).
Ver tabela
co_uf Integer - S Código da UF do endereço do produtor rural. Ver
tabela
69
Questionario
co_pergunta Integer - S Código da pergunta respondida na solicitação.

Evento
co_evento Integer - S Código do evento da solicitação.
Atividade

co_cnae String 12 S Código CNAE. Ver tabela.
is_atividade_principal Boolean - S Indica se é a atividade principal:
- true;
- false.
is_exerce_no_endereco Boolean - S Indica se a atividade é exercida no endereço:
- true;
- false
Arquivo
ds_nome_arquivo String 400 S Nome do arquivo anexado ao processo.

ds_url_servico String - S URL do serviço a ser consumido para recuperar o
arquivo.
WS24
4.7.4. Response
4.7.4.1. Requisição Mal Formada 400 – BAD REQUEST
Response
70
Erro
co_retorno String 200 S Código de erro interno (Item 4.8.4.1.1)

ds_retorno String 2000 S Descrição do erro interno.
ds_valor String 2000 S Valor inválido.
Response body
Tipo OB Descrição
Recurso enviado do serviço WS15, incluindo o ID

DadosProdutorRural S de registro no banco
5. Recebimento de dados pelo Integrador Estadual
Sempre que houver necessidade de resposta ao SIGFÁCIL e, consequentemente, ao

solicitante, a mesma será dada através de consumo a um dos webservices abaixo, cujo
desenvolvimento e manutenção são de responsabilidade da Vox Tecnologia.
Figura 2 - Serviços de envio de dados pelos órgãos integrados
Para garantir a compatibilidade do Integrador Estadual com todos os órgãos integrados

disponibilizaremos o manual atualizado com as alterações que serão realizadas
antecipadamente, para que todos os órgãos integrados realizem as alterações
71
necessárias. Caso seja identificado pelo órgão alguma necessidade de alteração, a
mesma deverá ser solicitada a nós através de caso no Mantis, para que seja discutida e
acordada com os demais órgãos integrados e planejada a mudança.
responsabilidade e necessidades no processo. É possível verificar a utilização dos
serviços de acordo com o perfil do órgão conforme tabela abaixo:
PERFIL
SERVIÇOS Meio Junta
Ambiente Comercial
WS20 - Resposta
de consulta x x x
prévia
WS21 - Resposta
de solicitação de
x x x x x
documentos e
baixa
WS22 -
Andamento da x x
solicitação
WS23 – Consulta
x x
dados DBE
WS24 – Busca de
x x x x x x x x
arquivos
WS25 – Busca de
dados simples x x x x x
nacional
WS26 –
Marcação CNPJ x
de interesse
WS29 – Envio
x x x x x x X
dados processo
WS42 – Busca
x x x x x x x x
Dados Empresa
Tabela 2 – Serviços de envio de dados pelos órgãos integrados x necessidade por perfil
5.1. WS20 - Resposta de consulta prévia
5.1.1. Descrição
Serviço que possui a finalidade de receber a resposta das análises de viabilidade
(nome e localização) realizadas pelos órgãos responsáveis.
URI PROD: https://integracao.voxtecnologia.com.br/v1/integracao/resposta-

consultas-previas
URI DEMO: https://demo-integracao.voxtecnologia.com.br/v1/integracao/resposta-
consultas-previas
72
Verbo HTTP: POST
5.1.3. Request
Mensagem

Objeto contendo os campos
de controle da mensagem
para identificação e
Objeto contendo os dados
de resposta da consulta
dados_resposta_consulta_previa DadosRespostaConsultaPrevia - S prévia.
Controle

Número identificador do órgão que está realizando
nu_identificador_orgao Integer - S a resposta de consulta prévia.
DadosRespostaconsultaPrevia

Data em que ocorreu deferimento ou
indeferimento.
dt_evento String 19 S Formato: YYYY-MM-DD HH:MM:SS.
co_tipo_consulta Integer - S Tipo de análise (1 – Nome, 2 – Endereço)
Resposta da consulta prévia. (2 – Deferido, 3 –
co_situacao_consulta Integer - S Indeferido, 7 – Análise especial).
Nome aprovado.
Obrigatório caso co_tipo_consulta = 1 e

ds_nome_aprovado String 400 N nu_situacao_consulta = 2.
Data em que ocorreu o evento de reserva de
nome.
Formato: YYYY-MM-DD.
dt_reserva String 10 N
73
Obrigatório caso co_tipo_consulta = 1 e
nu_situacao_consulta = 2
Código do motivo de indeferimento. Ver tabela
co_motivo_indeferimento Integer - N Obrigatório caso nu_situacao_consulta = 3.

Observações da resposta da análise de consulta
prévia.
Obrigatório quando co_motivo_indeferimento =

ds_observacao String(2000) 2000 N 99.
5.1.4. Response
Response
Erro

Nova situação
(co_situacao_consulta) de
consulta prévia não permitida.
As transições permitidas são:
Nova situação da consulta não
400 9908
permitida. Em análise -> Deferida;
Em análise -> Indeferida;
Em análise -> Análise especial;
Análise especial -> Deferida;
Análise especial -> Indeferida;
74
O código de órgão enviado não
corresponde ao órgão
401 9909 Órgão não responde consulta prévia
responsável pela resposta de
consulta prévia.
Response body
Tipo OB Descrição
DadosRespostaconsultaPrevia S Recurso WS20, incluindo o ID de registro no banco
5.2. WS21 - Resposta de solicitação de documentos e baixa
5.2.1. Descrição
Serviço que possui a finalidade de receber a resposta das solicitações de documentos
ou de baixa.
Através deste serviço será possível responder às solicitações, permitindo as
alterações de situação dos documentos solicitados, assim como as solicitações de
baixa de empresa.
Também é possível através deste serviço realizar apenas andamento na solicitação,

atualizando a mesma sem a mudança de status.
URL PROD: https://integracao.voxtecnologia.com.br/v1/integracao/resposta-

documentos-baixa
URL DEMO: https://demo-integracao.voxtecnologia.com.br/v1/integracao/resposta-
documentos-baixa
Verbo HTTP: POST
5.2.3. Request
Request Body
75
Objeto contendo os dados do andamento da
dados_resposta DadosResposta - S solicitação.
Controle

nu_identificador_orgao Integer - S o consumo ao serviço.
DadosResposta

Código de processo do sistema próprio do órgão
co_processo_sistema_proprio String 100 N integrado.
Data do evento.
Formato: YYYY-MM-DD HH:MM:SS.
dt_resposta String 19 S Hora enviada deve ser diferente 00:00:00.

Número do documento.
nu_documento String 30 N Obrigatório caso o campo co_situacao = 5.

Data de validade do documento emitido.
Formato: YYYY-MM-DD HH:MM:SS.
dt_validade String( 19 N Hora enviada deve ser diferente 00:00:00.

Se retorno é de documento:
- true;
- false.
Caso seja false, trata-se de um retorno de

is_retorno_documento Boolean - S solicitação de baixa.
Ver tabela
co_tipo_modelo_documento Integer - N Obrigatório caso is_retorno_documento = true.
Situação da solicitação. Ver tabela
Caso is_retorno_documento = false, apenas os

co_situacao Integer - S status 2, 3 e 5 são válidos.
Array de objetos do tipo Exigencia.
exigencias Exigencia[] - N Obrigatório caso o campo co_situacao = 3.

Observação sobre a alteração de status do
ds_observacao String 2000 N documento. Caso o documento esteja entrando
76
em exigência, o campo é utilizado para
informações mais precisas sobre o motivo da
exigência.
Caso seja apenas um caso de andamento com
documento em análise em mudança de status,
este campo irá informar ao solicitante a
tramitação interna da solicitação do documento
(andamento entre setores, gerências, etc).
co_atividades Atividade[] - N Array de objetos do tipo Atividade.
URL para taxa gerada, caso a mesma seja
ds_url_dam_proprio String 2000 N emitida por sistema próprio do órgão.
URL para o documento, caso o mesmo seja
ds_url String 2000 N emitido por sistema próprio do órgão.
Exigencia

ds_motivo_exigencia String 1000 S Descrição do motivo da exigência.
Atividade

5.2.4. Response
Response
Erro
co_retorno String(4) 4 S Código de erro Interno (Item 5.2.4.1.1)
77
Nova situação (co_situacao) de

documentos não permitida. As
transições permitidas são:
Aguardando solicitação -> Em

análise;
Aguardando solicitação ->
Emitido;
exigência;
Em análise -> Emitido;

Em análise -> Em exigência;
Em análise -> Em análise
(apenas para atualizar
andamento da solicitação);
400 9904 Nova situação não permitida
Em exigência -> Em análise;

Em exigência -> Emitido;
Emitido -> Revogado;

Emitido -> Cassado;
Emitido -> Anulado;
Emitido -> Suspenso.
Emitido -> Indeferido (apenas
quando não houver mais
recursos para o documento).
Revogado -> Em análise

Cassado -> Em análise
Anulado -> Em análise
Suspenso -> Em análise
A data de emissão informada é

400 9905 Data de emissão inválida maior ou igual a data de
validade.
Nenhum modelo de documento

Tipo de documento inválido para o ativo foi encontrado na lista de
400 9906
processo documentos possíveis para esta
solicitação.
Uma das atividades CNAE

Código CNAE inexistente para a enviadas não está na lista
400 9907
empresa atividades exercidas pela
empresa.
78
Response body
Tipo OB Descrição
DadosResposta S Recurso WS21, incluindo o ID de registro no banco
5.3. WS22 - Andamento da solicitação
5.3.1. Descrição
Através deste serviço será possível informar ao integrador estadual todo o andamento
do processo no órgão de registro.
De acordo com o status da solicitação passado, no campo co_status_solicitacao, o

SIGFÁCIL irá realizar consumo de serviço da Receita Federal:
• Em análise: será realizado consumo do serviço S05, bloqueando a solicitação

na Receita Federal para que o usuário não possa alterar enquanto a mesma
está sendo analisada pelo órgão de registro;
• Autenticado: será realizado consumo do serviço S06, retornando o campo
nu_cnpj preenchido de acordo com a resposta da Receita Federal ao serviço.
Também é através deste serviço será possível indeferir à solicitação junto à Receita
Federal, utilizando o campo is_indefere_dbe. Se este campo for preenchido no
consumo, o SIGFÁCIL irá realizar consumo do serviço S06 na Receita Federal,
solicitando o indeferimento da solicitação no aplicativo de coleta web (DBE).
O seguinte fluxo pode ser seguido utilizando o serviço WS22 – Andamento da

solicitação:
Figura 3 - Fluxo de status do processo
79
URL PROD: https://integracao.voxtecnologia.com.br/v1/integracao/andamento-

solicitacao
URL DEMO: https://demo-
integracao.voxtecnologia.com.br/v1/integracao/andamento-solicitacao
Verbo HTTP: POST
5.3.3. Request
Request Body

identificação e validação dos
dados_andamento_solicitacao DadosAndamentoSolicitacao - S andamento da solicitação.
Controle

Número identificador do órgão que está
nu_identificador_orgao Integer - S realizando o consumo ao serviço.
DadosAndamentoSolicitacao
Número do protocolo gerado pela solicitação

co_protocolo_redesim String 13 S no Integrador Estadual.
Data em que a resposta foi dada no sistema

próprio da entidade de registro.
dt_evento String 19 S Formato: YYYY-MM-DD HH:MM:SS.
Código de status possível para a solicitação.

co_status_solicitacao Integer - S Ver tabela
Número de registro no cartório.
nu_numero_registro String 18 N Obrigatório quando co_status_solicitacao = 4.
is_indefere_dbe Boolean - N Indica se o DBE será indeferido:
80
- true;
- false.
Obrigatório quando co_status_solicitacao = 2

ou co_status_solicitacao = 3.
Descrição da exigência do processo.
ds_motivo_exigencia_processo String 3000 N Obrigatório se co_status_solicitacao = 2.
Descrição do motivo de indeferimento do

processo.
ds_motivo_indeferimento_processo String 3000 N Obrigatório se co_status_solicitacao = 3.
CPF do responsável do andamento do

nu_cpf String 11 S processo.
Link para o contrato chancelado.
Obrigatório quando o co_status_solicitacao =

ds_link_contrato_social String 2083 N 5.
5.3.4. Response
Response
Erro

81
Novo status da solicitação não
permitido. As transições
permitidas são:
Em análise;
Novo status da solicitação não Em análise -> Indeferido;
400 9901
permitido Em análise -> Em exigência;
Em análise -> Deferido;
Deferido -> Autenticado;
Em exigência -> Em exigência
(apenas indeferindo DBE);
Erro no consumo do S05 - Erro no consumo do serviço

500 9902
<mensagem_de_erro> S05 na Receita Federal.
Erro no consumo do S06 - Erro no consumo do serviço

500 9903
<mensagem_de_erro> S06 na Receita Federal.
Response body
Tipo OB Descrição
DadosAndamentoSolicitacao S Recurso WS22, incluindo o ID de registro no banco
5.4. WS23 – Consulta dados DBE
5.4.1. Descrição
Através deste serviço será possível ao órgão de registro verificar os dados

preenchidos pelo solicitante no aplicativo de coleta da Receita Federal.
O retorno deste serviço conterá um campo em que será retornado XML exatamente
no formato de retorno do consumo ao S35 da Receita Federal. Toda a descrição de
dados (tamanho, tipo, ocorrências, obrigatoriedade) contidas no XML de retorno
seguem a documentação da Receita Federal.
82
URL PROD: https://integracao.voxtecnologia.com.br/v1/integracao/consulta-dados-
dbe/<nu_identificador_orgao>/<co_recibo_solicitacao>/<nu_identificacao_solicitacao
>
URL DEMO: https://demo-integracao.voxtecnologia.com.br/v1/integracao/consulta-
dados-
dbe/<nu_identificador_orgao>/<co_recibo_solicitacao>/<nu_identificacao_solicitacao
>
Verbo HTTP: GET
5.4.3. Request
Por se tratar de um método GET os parâmetros serão informados na url.

Número identificador do órgão que está
nu_identificador_orgao Integer - S realizando o consumo ao serviço.
co_recibo_solicitacao String 10 S Código de recibo da solicitação.
nu_identificacao_solicitacao String 14 S Número de identificação da solicitação.
5.4.4. Response
Response
Erro
83
Erro ao consumir S35 na
Erro no consumo do S35 - Receita Federal pelos motivos
500 9910
<mensagem_de_erro> indicados na mensagem de
erro.
5.4.4.2. Sucesso – 200 (success)
Response body
ds_dados_dbe Text - S XML contendo todos os dados retornados do

consumo ao S35.
5.5. WS24 – Busca de arquivos
5.5.1. Descrição
Serviço que irá retornar os arquivos de todos os demais serviços de entrega.
Atenção: O serviço de busca de arquivos retorna um binário do arquivo solicitado em

caso de sucesso. Em caso de erro, um erro HTTP será retornado.
URL PROD: https://integracao.voxtecnologia.com.br/v1/integracao/

arquivo/<nu_identificador_orgao>/<hash >
URL DEMO: https://demo-integracao.voxtecnologia.com.br/v1/integracao/
arquivo/<nu_identificador_orgao>/<hash >
Verbo HTTP: GET
5.5.3. Request
84
nu_identificador_orgao Integer - S o consumo ao serviço.
Hash contendo informações do arquivo que está
hash Text - S sendo recuperado.
5.5.4. Response
Response
Erro
5.5.4.1.2. Response – Tabela de erros específicos do WS24
404 9912 Arquivo não encontrado Arquivo não encontrado.
Response body
Campo Tipo OB Descrição
arquivo binary S Arquivo digitalizado.
85
5.6. WS25 – Busca de dados Simples Nacional
5.6.1. Descrição
Serviço que irá retornar as informações do período simples nacional da empresa

solicitada.
URL PROD: https://integracao.voxtecnologia.com.br/v1/integracao/simples-

nacional/<nu_cnpj>
URL DEMO: https://demo-integracao.voxtecnologia.com.br/v1/integracao/simples-
nacional/<nu_cnpj>
Verbo HTTP: GET
5.6.3. Request

nu_cnpj Integer - S o consumo ao serviço.
5.6.4. Response
Response
Erro
86
404 Empresa não encontrada Empresa não encontrada.
Response body
Array de objetos do tipo Dados

dados_simples_nacional DadosSimplesNacional[] - N Simples Nacional.
DadosSimplesNacional

nu_cnpj String 14 S CNPJ da empresa.
Nacional:
-true;
-true;
PeriodoSimples

PeriodoMei
87
dt_inclusao String(10) 10 N Formato: YYYY-MM-DD
dt_exclusao String(10) 10 N Formato: YYYY-MM-DD
5.7. WS26 – Marcação de CNPJ de interesse
5.7.1. Descrição
Serviço que possui a finalidade de receber o interesse dos órgãos em CNPJs.
URL PROD: https://integracao.voxtecnologia.com.br/v1/integracao/marcacao-

interesse
URL DEMO: https://demo-integracao.voxtecnologia.com.br/v1/integracao/marcacao-
interesse
Verbo HTTP: POST
5.7.3. Request
Mensagem

Objeto contendo os dados dos CNPJs
marcacao_interesse MarcacaoInteresse - S de interesse
Controle

nu_identificador_orgao Integer - S a resposta de consulta prévia.
MarcacaoInteresse
88
Array de objetos contendo os dados das empresas
Empresa Empresa[] - S de interesse do órgão.
Empresa
CNPJ da empresa (matriz ou filial) de interesse

nu_cnpj String 13 S (apenas números).
Identifica se o órgão tem ou não interesse no
CNPJ:
- true;
is_interesse Boolean - S - false
5.7.4. Response
Response
Erro
Response body
Tipo OB Descrição
MarcacaoInteresse S Recurso WS26, incluindo o ID de registro no banco
89
5.8. WS29 – Envio Dados Processo
5.8.1. Descrição
Serviço que possui a finalidade de reenviar os dados do WS02.
URL PROD: https://integracao.voxtecnologia.com.br/v1/integracao/envio-dados-

processo
URL DEMO: https://demo-integracao.voxtecnologia.com.br/v1/integracao/ envio-
dados-processo
Verbo HTTP: POST
5.8.3. Request

mensagem para identificação e validação
controle Controle - S dos dados.
Objeto contendo os dados de resposta da
dados_resposta DadosResposta - S consulta prévia.
Controle

Número identificador do órgão que está realizando a
nu_identificador_orgao Integer - S resposta de consulta prévia.
ds_orgao String 200 S Nome do órgão ao qual a mensagem é direcionada.
DadosResposta
id Integer - N Número de identificação dos dados salvos pelo

serviço.
Somente enviado no retorno Sucesso - 201 pelo
serviço.
S Array de objeto contendo os protocolos.

solicitacoes Protocolo[] -
S Código do serviço a ser reenviado. Ver tabela.

co_servico Integer -
90
N Código do tipo de modelo de documento.
co_tipo_modelo_do Ver tabela
cumento Integer - Obrigatório para os co_servico: 3, 4 e 6.
Data do envio.
dt_envio String 19 S Formato: YYYY-MM-DD HH:MM:SS.
Protocolo
co_protocolo String 20 S Protocolo a ser reenviado.
5.8.4. Response
Response
Erro
Response body
Tipo OB Descrição
MarcacaoInteresse S Recurso WS26, incluindo o ID de registro no banco
91
5.9. WS42 – Recupera Dados Empresa
5.9.1. Descrição
Serviço que possui a finalidade de retornar os dados da Empresa.
URL PROD: https://integracao.voxtecnologia.com.br/v1/integracao/recupera-dados-

empresa?nu_cnpj=<nu_cnpj>&nu_registro=<nu_registro>&ds_uf=<ds_uf>&co_entidad
e_registro=<co_entidade_registro>
URL DEMO: https://demo-integracao.voxtecnologia.com.br/v1/integracao/recupera-
dados-
empresa?nu_cnpj=<nu_cnpj>&nu_registro=<nu_registro>&ds_uf=<ds_uf>&co_entidad
e_registro=<co_entidade_registro>
Verbo HTTP: GET
Por se tratar de serviço tipo GET, os parâmetros devem ser enviados na URL.
Ao enviar a requisição, deve ser acrescentado ao header o auth-orgao com o
Código do órgão solicitante.
5.9.3. Request
Request Body

CNPJ da empresa. Apenas número
Obrigatório quando não for
nu_cnpj String 14 N informado o nu_registro.
empresa.
Obrigatório quando não for
nu_registro String 40 N informado o nu_cnpj.
ds_uf String 2 S Sigla da UF da empresa.
Código da entidade de registro da
co_entidade_registro Number - S empresa. Ver tabela.
5.9.4. Response
92
Objeto contendo os dados da
empresa Empresa - S empresa.
controle

Número identificador do órgão ao
nu_identificador_orgao Number - S qual a mensagem é direcionada.
Nome do órgão ao qual a
ds_orgao String 200 S mensagem é direcionada.
Empresa

CNPJ da empresa (matriz ou filial)
que está solicitando o evento
(apenas números).
Campo obrigatório quando

consumo é realizado para órgãos
nu_cnpj String 14 N diferentes de cartório e OAB.
nu_registro String 40 N empresa.
Nome empresarial sem partícula de
ds_nome_empresarial String 400 S porte.
ds_nome_fantasia String 150 N Nome fantasia.
Número do CNPJ da matriz.
nu_cnpj_matriz String 14 N
nu_registro_matriz String 40 N Número de registro da Matriz.
Número do telefone (apenas
nu_telefone String 10 N números).
ds_email String 150 N Endereço de e-mail da empresa.
Código da natureza jurídica da
co_natureza_juridica String 5 S empresa. Ver tabela
Código do enquadramento da
co_enquadramento Number - N empresa. Ver tabela
93
Objeto contendo o tipo de unidade
co_tipo_unidade Number - N da empresa. Ver tabela
formas_atuacao FormaAtuacao[] - N FormaAtuacao.
ds_objeto_social String 14000 N Objeto social da empresa.
atividades Atividade[] - S Array de objetos do tipo Atividade.
Valor do capital social da empresa.
nu_capital_social Number 15.2 N Formato: #############.##
Valor do capital integralizado da
empresa.
nu_capital_integralizado Number 15.2 N Formato: #############.##
Valor do destaque do capital para a
filial.
nu_destaque_capital Number 15.2 N Formato: #############.##
Array de objetos do tipo Socio.
socios Socio[] - N
responsavel_legal ResponsavelLegal - N responsável legal pela empresa.
Data de constituição da empresa.
dt_constituicao String 10 N Formato: YYYY-MM-DD
Data de início das atividades da
empresa.
dt_inicio_atividades String 10 N Formato: YYYY-MM-DD
Data de término de atividades da
empresa.
dt_termino_atividades String 10 N Formato: YYYY-MM-DD
endereco Endereco - N endereço da empresa.
Descreve a situação da empresa na
co_situacao_empresa String 2 N Exclusivo para Junta Comercial.
Descreve o status da empresa na
co_status_empresa String 2 N Exclusivo para Junta Comercial.
FormaAtuacao

formas de atuação da empresa. Ver
co_forma_atuacao Number - S tabela
Endereco
94
co_cep String 8 N Código do CEP da empresa.
Descrição do logradouro (sem o
ds_endereco String 100 N tipo de logradouro).
Lista de complementos do
endereço da empresa, separados
por ";" com o máximo de 6
Código do município (TOM). Ver
co_municipio_tom Number - N tabela
co_uf Number - N Código da UF. Ver tabela
Atividade

- true;
Socio

Tipo de pessoa do sócio:
1 = Pessoa física;
co_tipo_pessoa Number - N 2 = Pessoa jurídica;
Número do CPF ou CNPJ do sócio
nu_cpf_cnpj String 14 N (apenas números).
Nome (empresarial ou de pessoa
ds_nome String 400 N física).
ds_email String 150 N Endereço de e-mail.
nu_telefone String 10 N Telefone.
nu_ddd_celular String 4 N DDD do celular.
nu_celular String 10 N Celular.
Objeto contendo dados de
endereco EnderecoSocio - N endereço
qualificacoes Qualificacao[] - N QualificacaoDto.
dados_pessoa_fisica PessoaFisica - N pessoa física.
95
dados_pessoa_juridica PessoaJuridica - N pessoa jurídica.
PessoaFisica

co_estado_civil Number - N Estado civil. Ver tabela
Código do regime de bens. Ver
co_regime_bens Number - N tabela
Data de nascimento. Formato:
dt_nascimento String 10 N YYYY-MM-DD
Código da nacionalidade da pessoa
física (titular, sócio, representante
co_nacionalidade Number - N ou administrador). Ver tabela
Código da UF referente à
co_uf_naturalidade Number - N naturalidade. Ver tabela
Código do sexo:
1 = Masculino;
co_sexo Number - N 2 = Feminino;
documento de identificação da
documento_identificacao DocumentoIdentificacao - N pessoa.
ds_cargo String 300 N Descrição do cargo.
Indica se pessoa é emancipada
is_emancipado Boolean - N (true ou false)
DocumentacaoIdentificacao

Número do documento de
nu_documento_identificacao String 30 N identificação
Descrição do órgão expedidor do
ds_orgao_expedidor String 30 N documento de identificação.
Código da UF do órgão emissor do
documento de identificação. Ver
co_uf_emissor Number - N tabela
Data de validade do documento
dt_documento_validade String 10 N provisório. Formato: YYYY-MM-DD
PessoaJuridica
96
nu_registro String 40 N Número de registro da empresa.
EnderecoSocio

co_pais Number - N Código do país. Ver tabela
Código do município (TOM). Ver
co_municipio_tom Number - N tabela
co_cep String 8 N CEP (apenas números).
ds_endereco String 100 N Descrição do logradouro.
Lista de complementos do
endereço da empresa, separados
por ";" com o máximo de 6
Qualificacao

Código do tipo de qualificação de
acordo com tabela da Receita
co_tipo_qualificacao_rfb Number - N Federal. Ver tabela
Código do tipo de qualificação de
acordo com entidade de
co_tipo_qualificacao_registro Number - N registro. Ver tabela
Data de início da qualificação.
dt_inicio_qualificacao String 10 S Formato: YYYY-MM-DD
Data de fim da qualificação
dt_fim_qualificacao String 10 N Formato: YYYY-MM-DD
CPF ou CNPJ do representado.
Obrigatório indicar representado

caso a qualificação seja de
nu_cpf_cnpj_representado String 14 N representante.
Valor da participação no capital
social.
nu_valor_participacao Number 15.2 N Formato: #############.##
ResponsavelLegal
97
CPF do responsável legal (apenas
nu_cpf String 11 S números).
ds_nome String 200 S Nome do responsável legal.
5.9.4.2. Response Erro
Response
Erro
6. Serviços complementares fora do escopo da REDESIM
Os serviços a seguir não se encontram no escopo da REDESIM. São serviços

complementares que podem ser contratados de forma separada pelos órgãos envolvidos nos
processos relacionados à REDSIM.
responsabilidade e necessidades no processo. É possível verificar a utilização dos serviços
de acordo com o perfil do órgão conforme tabela abaixo:
PERFIL
SERVIÇOS Meio Junta
Ambiente Comercial
WS30 – Consulta
x
de endereço
WS31 – Consulta
x
dados do CRC
98
WS32 – Gerar
documento de x x x x x x x x
arrecadação
WS33 – Busca
x x x x x x x x
pagamentos
Tabela 3 – Serviços de coleta de dados nos órgãos integrados x necessidade por perfil
6.1. WS30 – Consulta de endereço
6.1.1. Descrição
Serviço disponibilizado pelas Prefeituras para a busca de dados do endereço pelo

SIGFÁCIL. Ao preencher uma consulta prévia, o usuário irá informar o número da
inscrição imobiliária e o SIGFÁCIL irá buscar o endereço a partir deste serviço,
passando a inscrição imobiliária como parâmetro.
URL: https://<url-do-orgao-integrado
>/v1/integracao/endereco/<nu_inscricao_imobiliaria>
Verbo HTTP: GET
6.1.3. Request
nu_inscricao_imobiliaria String 30 S Número da inscrição imobiliária. Sem mascará.
6.1.4. Response
Response
Erro
99
Erro ao consultar a inscrição

400 9911 Inscrição Imobiliária Inexistente
imobiliária.
Response body
endereco Endereco[] - S Array de objetos do tipo Endereco.
Endereco

Código de sublote.
Obrigatório para diferenciar os sublotes se atributo

endereco do Retorno possuir mais de um item no
co_sublote String 6 N array.
ceps Ceps[] - N Array de CEP do endereço (apenas números).

ds_endereco String 100 S logradouro).
Lista de complementos do endereço da

complemento Complemento[] - N empresa. Máximo de 6 ocorrências.
Descrição de um ponto de referência para o

ds_ponto_referencia String 150 N endereço.
Complemento
100
ds_tipo_complemento String 6 S Descrição do tipo de complemento. Ver tabela
ds_complemento String 20 S Descrição do complemento.
Ceps
co_cep String 8 S Número do CEP da empresa.
detalhamento_cep detalhamentos[] - N Array de detalhamento do CEP
Detalhamentos
ds_detalhamento_cep String 200 N Detalhamento do CEP
6.2. WS31 – Consulta dados do CRC
6.2.1. Descrição
Serviço disponibilizado pelos Conselhos Regionais de Contabilidade para consulta de

dados do contabilista pelo SIGFÁCIL, nos momentos de coleta destes dados
cadastrais.
>/v1/integracao/contabilista/<nu_identificador_orgao>/<nu_registro_crc>
Verbo HTTP: GET
6.2.3. Request

nu_registro_crc String 14 S Número do CRC para pesquisa.
101
6.2.4. Response
Response
Erro
Erro ao consultar o Código de

400 9915 Código CRC Inexistente
registro do contabilista.
Response body
Objeto contendo os dados recuperados do CRC.

dados_crc DadosCRC - N Obrigatório caso co_retorno = 3200.
DadosCRC
CPF ou CNPJ do responsável

co_cpf_cnpj String 14 S contábil (apenas números).
102
ds_nome String 200 S Nome do responsável contábil.

contábil.
1 = Pessoa física;
nu_tipo_pessoa Integer - S 2 = Pessoa jurídica

contador responsável pela empresa
de contabilidade.
Obrigatório quando o campo

co_cpf_cnpj possuir mais de 11
responsavel Responsavel - N dígitos.
Objeto contendo dados do conselho

de classe (CRC) do responsável
dados_conselho DadosConselho - S contábil.
Objeto contendo dados do

endereco EnderecoResponsavelContabil - S endereço do contador.
Responsavel
CPF do responsável pela empresa

nu_cpf String 11 S de contabilidade.
ds_nome String 100 S Nome do responsável contábil.
E-mail do responsável pela

ds_email String 150 S empresa de contabilidade.
DDD do telefone do responsável

nu_ddd_telefone String 2 S pela empresa de contabilidade.
Telefone do responsável pela

nu_telefone String 10 S empresa de contabilidade.

conselho de classe (CRC) do
contador responsável pela
dados_conselho DadosConselho - S empresa de contabilidade.
Objeto contendo dados do

endereço do contador responsável
endereco EnderecoResponsavelContabil - S pela empresa de contabilidade.
DadosConselho
co_uf_crc Integer - S Código da UF do CRC.
103
nu_sequencia String 10 S Número sequencial do CRC.
Data do registro no CRC. Formato: YYYY-MM-

dt_registro String 10 S DD
co_tipo_classificacao_crc Integer - S Tipo de classificação no CRC.
nu_tipo_crc Integer - S Tipo de CRC.
nu_crc String 10 S Número do CRC.
EnderecoResponsavelContabil
co_cep String 8 S CEP.
co_tipo_logradouro Integer - S Tipo de logradouro. Ver tabela
ds_endereco String 100 S Descrição do logradouro.
Lista de complementos do endereço, separados

ds_complemento String 162 N por ";". Ver tabela.
co_municipio Integer - S Código do município. Ver tabela
co_uf Integer - S Código da UF do município Ver tabela
6.3. WS32 – Gerar documento de arrecadação
6.3.1. Descrição
Serviço disponibilizado pelos órgãos que necessitam da integração do SIGFÁCIL com

sistema próprio (fiscal/tributário) para controle das taxas. Será utilizado pelo
SIGFÁCIL para gerar taxas de forma integrada com o órgão.
URL:https://<url-do-orgao-integrado>/v1/integracao/gerar-
dar?nu_identificador_orgao=<nu_identificador_orgao>&nu_tipo_operacao=<nu_tipo
_operacao>&co_protocolo=<co_protocolo>&co_cpf_cnpj=<co_cpf_cnpj>&ds_nome=
<ds_nome>&nu_valor_taxa=<nu_valor_taxa>&co_tributo=<co_tributo>&co_tributo_d
etalhe=<co_tributo_detalhe>&dt_vencimento=<dt_vencimento>&co_municipio=<co_
municipio>&co_pais=<co_pais>&endereco_sacado=<endereco_sacado> OU
ds_endereco_completo=<ds_endereco_completo>
104
Verbo HTTP: GET
6.3.3. Request

Tipo de operação para a geração de taxa:
1 = Cálculo automático de valor;

nu_tipo_operacao String 2 S 2 = Cálculo manual de valor;
co_protocolo String 13 S Número do protocolo.
co_cpf_cnpj Integer - S CPF ou CNPJ do sacado (apenas números).
ds_nome String 200 S Nome do sacado.
Valor da taxa.
nu_valor_taxa Numeric 12.2 N Obrigatório se nu_tipo_operacao = 2.

co_tributo String 13 N Código do tributo. Apenas números.
Especialização do código do tributo. Apenas
co_tributo_detalhe String 4 N números.
co_pais Integer - S Código do país. Ver tabela
Data de vencimento da taxa.
dt_vencimento String 10 N Formato: AAAA-MM-DD
Objeto contendo dados do endereço do sacado:
- Descrição tipo logradouro. Ver tabela
- Logradouro
- Número
- Bairro
- Município
- UF. Ver tabela
- CEP
Caso co_pais seja diferente de 105 (Brasil) o

endereco_sacado String 1000 N sistema deve enviar o ds_endeco_completo
ds_endereco_completo String 200 N Endereço completo de sócio residente no exterior.
6.3.4. Response
Response
105

Erro
Response body
taxas Taxa[] - S Array de objetos do tipo Taxa.
Taxa
nu_nosso_numero String 100 S Nosso número.
nu_documento String 100 N Número do documento.
nu_linha_digitavel String 150 S Linha digitável.
nu_representacao_numerica String 150 S Representação numérica do código de barras.
nu_valor_juros Numeric 12.2 N Valor de juros calculado.
nu_valor_multa Numeric 12.2 N Valor de multa calculada.
nu_valor_correcao Numeric 12.2 N Valor de correção calculada.
Valor da taxa de serviços administrativos

nu_valor_tsa Numeric 13.2 N calculada.
Valor total da taxa (com juros, multa e

nu_valor_total Numeric 12.2 N correção).
Data de vencimento.
dt_vencimento String 10 S Formato: YYYY-MM-DD
Número da parcela. Se vazio, significa que é

nu_parcela String 2 N cota única.
106
ds_tributo String 40 N Descrição do tributo.
URL da taxa gerada pelo sistema próprio do

ds_url_taxa String 2000 N órgão.
6.4. WS33 – Busca pagamentos
6.4.1. Descrição
Serviço disponibilizado pelos órgãos que necessitam da integração do SIGFÁCIL com

sistema próprio (fiscal/tributário) para controle das taxas. Será utilizado pelo
SIGFÁCIL para buscar os pagamentos realizados de taxas que foram geradas através
de integração utilizando o WS32.
Limite no retorno de 1000 taxas por requisição.
Busca lista de pagamentos

>/v1/integracao/pagamentos?nu_convenio=<nu_convenio>
Verbo HTTP: GET
Busca pagamento específico

>/v1/integracao/pagamentos?nu_convenio=<nu_convenio>&nu_nosso_numero=<nu
_nosso_numero>
Verbo HTTP: GET
6.4.3. Request
nu_convenio Integer - N Número do convênio do cedente.

nu_nosso_numero Integer - N Nosso número.
6.4.4. Response
107
Response

Erro
Response body
pagamentos Pagamento[] - N Array de objetos do tipo Pagamento.
Pagamento
nu_nosso_numero Integer 30 S Nosso número.
nu_valor_pago Numeric 12.2 S Valor total pago pelo solicitante.
Data de vencimento.
dt_pagamento String 10 S Formato: YYYY-MM-DD
Código de autenticação do pagamento no

co_autenticacao String 50 S banco.
Observação da taxa. Utilizado para informar ao

usuário uma observação a respeito da situação
ds_observacao String 100 N da taxa.
Utilizado para informar o status da taxa no

co_status_taxa Integer 2 N momento. Ver tabela
7. Tabelas
7.1. Tabela 1 – Response – Tabela de códigos de retorno comuns
108
Este valor é muito longo. Deve ter

400 9001 <LIMITE> caracteres ou menos. -
<CAMPO>
Este valor é muito curto. Deve ter

400 9002 <LIMITE> caracteres ou mais. -
<CAMPO>
O campo informado no código

Este valor não deve ser nulo.
400 9003 de erro é de preenchimento
<CAMPO>
obrigatório.
O campo informado no código

400 9004 Este valor não é válido. <CAMPO> de erro está sendo enviado com
formato inválido.
404 9005 Registro não encontrado -
Acesso não autorizado. Token

401 9006 -
Inválido.
400 9007 Pesquisa por campo inválido -
Arquivo não encontrado e/ou

404 9008 Arquivo não encontrado
localizado
Acesso não autorizado. Serviço

401 9009
indisponível para o órgão.
202 9010 Requisição já processada -
7.2. Tabela 2 - Response – Tabela de erros específicos do WS
HTTP Código WS Descrição Observação

Code
Novo status da solicitação não

permitido. As transições permitidas
são:
Novo status da solicitação não Em análise;

400 9901 WS22
permitido Em análise -> Indeferido;
Em análise -> Em exigência;
Em análise -> Deferido;
Deferido -> Autenticado;
109
Em exigência -> Em exigência
(apenas indeferindo DBE);
Erro no consumo do S05 - Erro no consumo do serviço S05

500 9902 WS22
<mensagem_de_erro> na Receita Federal.
Erro no consumo do S06 - Erro no consumo do serviço S06

500 9903 WS22
<mensagem_de_erro> na Receita Federal.
Nova situação (co_situacao) de

documentos não permitida. As
transições permitidas são

análise
Aguardando solicitação -> Emitido
exigência
Aguardando solicitação ->
Indeferido
Em análise -> Emitido

Em análise -> Em análise (apenas
para atualizar andamento da
solicitação);
Em análise -> Em exigência
Em análise -> Indeferido
400 9904 WS21 Nova situação não permitida
Em exigência -> Em análise
Em exigência -> Emitido
Em exigência -> Revogado
Em exigência -> Cassado
Em exigência -> Anulado
Em exigência ->Suspenso
Em exigência ->Indeferido
Emitido -> Revogado

Emitido -> Cassado
Emitido -> Anulado
Emitido -> Suspenso
Emitido -> Indeferido (apenas
quando não houver mais recursos
para o documento)
Revogado -> Em análise

Cassado -> Em análise
Anulado -> Em análise
Suspenso -> Em análise
110
Indeferido -> Em análise
Indeferido -> Emitido
Indeferido -> Em exigência
Indeferido -> Revogado
Indeferido -> Cassado
Indeferido -> Anulado
Indeferido -> Suspenso
Revogado -> Cassado

Revogado -> Anulado
Revogado -> Suspenso
Cassado -> Revogado

Cassado -> Anulado
Cassado -> Suspenso
Anulado -> Revogado

Anulado -> Cassado
Anulado -> Suspenso
Suspenso -> Revogado

Suspenso -> Cassado
Suspenso -> Anulado
400 9905 WS21 Data de emissão inválida -
Tipo de documento inválido para

400 9906 WS21 -
o processo
Código CNAE inexistente para a

400 9907 WS21 -
Empresa
Nova situação
(co_situacao_consulta) de consulta
prévia não permitida. As transições
permitidas são:
Nova situação da consulta não
400 9908 WS20
permitida Em análise -> Deferida;
Em análise -> Indeferida;
Em análise -> Análise especial;
Análise especial -> Deferida;
Análise especial -> Indeferida;
O código de órgão enviado não

Órgão não responde consulta
401 9909 WS20 corresponde ao órgão responsável
prévia
pela resposta de consulta prévia.
Erro ao consumir S35 na Receita

Erro no consumo do S35 -
500 9910 WS23 Federal pelos motivos indicados na
<mensagem_de_erro>
mensagem de erro.
111
Erro ao consultar a inscrição
404 9911 WS30 Inscrição Imobiliária Inexistente
imobiliária.
Erro ao consultar o Código de

404 9915 WS31 Código CRC Inexistente
registro do contabilista.
Exigência inexistente para o Código da exigência não

400 9916 WS21
órgão cadastrado para o órgão
As atividades da empresa não

Atividade(s) inexistente para o
400 9917 WS21 estão configuradas para o órgão
órgão
informado.
As atividades da empresa não

Atividade(s) inexistente para o
400 9918 WS21 estão configuradas para o tipo de
documento
documento informado.
Erro ao consultar o nosso número

404 9919 WS33 Nosso número Inexistente
de identificação da taxa
Erro ao salvar a requisição no

400 9920 WS02 Erro interno
banco de dados.
400 9921 WS21 Código de exigência duplicado. -
112

Manual de Integração 2.2.28

Enviado por

Direitos autorais:

Formatos disponíveis

Manual de Integração 2.2.28

Enviado por

Dados do documento

Descrição original:

Direitos autorais

Formatos disponíveis

Compartilhar este documento

Compartilhar ou incorporar documento

Opções de compartilhamento

Você considera este documento útil?

Este conteúdo é inapropriado?

Direitos autorais:

Formatos disponíveis

Manual de Integração 2.2.28

Enviado por

Direitos autorais:

Formatos disponíveis

Manual de Integração

Versão Data Descrição Responsável

2.2.28 16/06/2020 Novo serviço WS42 Erica Helena

Inclusão novos campos no objeto Endereco:

Inclusão novo campo no objeto DadosConsultaPrevia

Inclusão novo campo no objeto DadosSolicitacao

Inclusão novo campo no objeto Empresa

Inclusão novo campo no objeto NaturezaImovel

Inclusão novo campo no objeto substitutoTributario

Retirada validação de obrigatoriedade para os campos

2.2.27 10/02/2020 Novo Serviço WS15, WS29 Erica Helena

Novo Objeto Filiais

Alteração do Campos no objeto Endereco

Alteração no objeto BensMovelImovel

Alterado o objeto ArquivosRegistro

WS02, WS04, WS06

Atualização das tabelas de apoio

Tipo de arquivo registro

Atualizada a nomenclatura do clausula_contratuais no objeto

2.2.24 09/09/2019 WS01 e WS02 Maxwell

Removida as validações que tornava os seguintes campos

Aumentando os tamanhos dos seguintes campos:

Empresa, ResponsavelContabil, Responsavel, Socio

Foram adicionados os campos:

Aumentado o tamanho do campo:

Adicionados novos códigos de erros:

2.2.23 13/08/2019 Alteração nos hiperlinks das tabelas de apoio. Maxwell

2.2.22 23/07/2019 WS02 Jafet Gomes

2.2.21 13/05/2019 WS04 e WS06 Maxwell

Adição das URLs do ambiente de teste.

2.2.20 06/03/2019 WS01 e WS02 Maxwell

WS21 – Tabela de erros específicos

2.2.19 03/01/2019 WS06

2.2.18 21/12/2018 WS01 Marcus Bruno

2.2.17 21/11/2018 - Adicionado campo ds_url_taxa no response body do WS32; Maxwell

2.2.16 5/11/2018 WS01 Maxwell

OBS: Os ajustes(*) são algumas alterações nos campos que

2.2.15.1 01/10/2018 - Ajustando regra para envio do is_exerce_no_endereco no Maxwell

-Correção no nome do objeto dados_documento_documento

2.2.13 29/03/2018 - Correção no tamanho do atributo nu_documento no WS03 e Jafet Gomes

2.2.12 14/03/2018 - Corrigidas alterações de obrigatoriedades dos campos Genison Ribeiro

2.2.10 14/02/2018 - Alterado tipo de dado do nu_ato_legal no WS02. Jafet Gomes

2.1.0 01/12/2017 Adicionados serviços complementares WS30 e WS31 Genison Ribeiro

2.0.7 17/11/2017 WS04 - Atributos is_atividade_principal e Genison Ribeiro

2.0.4 27/10/2017 WS02 - Remoção do atributo co_nacionalidade; Genison Ribeiro

2.0.3 23/10/2017 WS01, WS02 - Adicionado atributo opcional Genison Ribeiro

2.0.0 11/09/2017 Criação do documento. Genison Ribeiro

Com a implantação da REDESIM – Rede Nacional para a Simplificação do Registro e da

A troca de dados é feita exclusivamente por serviços, de forma segura, utilizando

O órgão integrado terá a responsabilidade de implementar e manter o conjunto de

Para realização da implementação dos consumos aos serviços temos a disposição um

Este é um documento técnico, sendo necessário conhecimento da área de Tecnologia da

Problemas identificados na integração ou em serviços específicos devem ser reportados

Para o envio ou recebimento de mensagens, será utilizada autenticação através de token.

Ao enviar uma requisição para os serviços disponibilizados na ponta do SIGFÁCIL, o

Cada um dos ambientes utilizados, de demonstração e produção, terá um par de tokens

Figura 1 - Serviços de envio de dados aos órgãos integrados

Para garantir a compatibilidade do Integrador Estadual com todos os órgãos integrados é

4.1. WS01 - Solicitação de consulta prévia