Manual Integração API

Manual de Integração
versão 2.2.14
Histórico de revisões
Versão Data Descrição Responsável
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;
- 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;
1
- 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
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.
2
-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.
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”
3
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.
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
4
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
5
Sumário
1. Introdução 10
2. Padrão dos serviços 11
3. Segurança 12
4. Recebimento de dados pelos órgãos integrados 13
4.1. WS01 - Solicitação de consulta prévia 14
4.1.1. Descrição 14
4.1.2. Dados adicionais 14
4.1.3. Request 14
4.1.4. Response 19
4.1.4.1. Requisição Mal Formada 400 - (BAD REQUEST) 19
4.1.4.1.1. Response - Tabela de erros específicos do WS01 20
4.1.4.1.2. Response - Tabela de códigos de retorno comuns 20
4.1.4.2. Sucesso – 201 (Resource Created) 20
4.2. WS02 – Dados de empresas 20
4.2.3. Request 21
4.2.4. Response 32
4.3. WS03 – Mudança de status de documentos 33
4.3.3. Request 33
4.3.4. Response 34
4.4. WS04 - Solicitação de documentos 35
4.4.3. Request 36
4.4.4. Response 37
6
4.5. WS05 - Cancelamento de solicitação 38
4.5.3. Request 38
4.5.4. Response 39
4.6. WS06 - Retorno de exigências 40
4.6.3. Request 40
4.6.4. Response 41
5. Recebimento de dados pelo Integrador Estadual 43
5.1. WS20 - Resposta de consulta prévia 44
5.1.3. Request 44
5.1.4. Response 45
5.2. WS21 - Resposta de solicitação de documentos e baixa 46
5.2.3. Request 46
5.2.4. Response 48
5.3. WS22 - Andamento da solicitação 50
7
5.3.3. Request 50
5.3.4. Response 52
5.4. WS23 – Consulta dados DBE 53
5.4.3. Request 53
5.4.4. Response 53
5.4.4.2. Sucesso – 200 (success) 54
5.5. WS24 – Busca de arquivos 54
5.5.3. Request 55
5.5.4. Response 55
5.5.4.1.2. Response – Tabela de erros específicos do WS24 55
6. Serviços complementares fora do escopo da REDESIM 56
6.1. WS30 – Consulta de endereço 56
6.1.3. Request 57
6.1.4. Response 57
6.2. WS31 – Consulta dados do CRC 59
6.2.3. Request 59
6.2.4. Response 59
8
6.3. WS32 – Gerar documento de arrecadação 61
6.3.3. Request 62
6.3.4. Response 62
6.4. WS33 – Busca pagamentos 63
6.4.3. Request 64
6.4.4. Response 64
7. Tabelas 65
9
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 suporte@voxtecnologia.com.br ou através do telefone (83) 3031-0123.
10
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.
11
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.
12
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:
13
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
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
Request Body
Campo Tipo OB Descrição
14
Objeto contendo os campos de controle da
mensagem para identificação e validação dos
controle Controle S dados.
DadosConsultaP
dados_consulta_previa revia S Objeto contendo os dados da consulta prévia.
Controle

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

Número de identificação dos dados salvos pelo
serviço. Somente enviado no retorno Sucesso - 201
id Integer N pelo serviço.
Número do protocolo gerado pela solicitação no
co_protocolo_redesim String(13) S 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, indicada pelo
nu_cnpj_matriz String(14) N 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 e 210

opcoes_nome OpcaoNome[] N entrando na UF.
ds_objeto_social String(14000) S Descrição do objeto social.
Array de objetos do tipo Atividade, listando as
atividades Atividade[] S atividades da empresa.
EventoRedesim[ Array de objetos do tipo EventoRedesim, contendo
eventos ] S os eventos REDESIM solicitados.
Código da natureza jurídica da empresa da
co_natureza_juridica String(5) S solicitação. Ver tabela
co_enquadramento Integer S Código do enquadramento da empresa. Ver tabela
15
Array de objetos do tipo Socio listando os dados do
sócio, titular ou empresário.
Obrigatório para os eventos 101 e 210 entrando na

socios Socio[] N uf.
Objeto contendo os dados de endereço da
endereco Endereco S 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.
formas_atuacao FormaAtuacao[] N Obrigatório quando o tipo de unidade for 0.
Objeto contendo dados referentes à utilização do
utilizacao_solo UtilizacaoSolo N solo.
Array de objetos do tipo Pergunta contendo as
perguntas e respostas da coleta adicional de dados
questionario Pergunta[] N da consulta prévia.
CNPJ da entidade de registro que empresa dará
entrada ao processo.
Obrigatório para naturezas jurídicas registradas em

nu_cnpj_entidade_registro String(14) N cartório.
nu_cnpj_entidade_registro_matri CNPJ da entidade de registro do estabelecimento
z String(14) N da matriz.
Solicitante
nu_cpf String(14) S CPF do solicitante (apenas números).

ds_nome String(100) 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.
ds_email String(150) N E-mail.
OpcaoNome

ds_opcao_nome String(300) S Opção de nome empresarial.
Atividade
16
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.
AtividadeEspe Array de objetos do tipo AtividadeEspecializada.
atividades_especializadas cializada[] N OBS: Uso exclusivo da prefeitura
AtividadeEspecializada

co_cnae_especializada String(12) S Código CNAE especializado da prefeitura.
- true;
- true;
is_exerce_no_endereco Boolean S - false.
Socio

ds_nome String(150) 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).
co_tipo_imovel Integer N Código do tipo do imóvel. Ver tabela
co_tipo_logradouro Integer S Código do tipo de logradouro. Ver tabela
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
ds_complemento String(156) N de 6 tipos de complementos. Ver tabela
17
Código do município (IBGE sem dígito
co_municipio Integer S verificador). Ver tabela
Área total do terreno da empresa (em

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

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

ds_ponto_referencia String(150) N o endereço.
Objeto do tipo NaturezaImovel contendo os

natureza_imovel NaturezaImovel N dados de inscrição imobiliária ou 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).
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
18
Número de autorização/permissão para utilização
nu_autorizacao String(40) S 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 Text S WS24
EventoRedesim
co_evento Integer S Código do evento da solicitação. Ver tabela
Pergunta

Código da pergunta respondida pelo solicitante no
momento da solicitação. O número da pergunta
está disponível na funcionalidade de “Perguntas” já
que são dados dinâmicos, definidos por cada
co_pergunta Integer S órgão integrado.
ds_pergunta String(300) S Descrição da pergunta cadastrada no sistema.
ds_resposta String(5000) S Resposta da pergunta.
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
19
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
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
4.2. WS02 – Dados de empresas
4.2.1. 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 e comunicação desta finalização
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.
20
¹ 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;
² 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.
URL: https://<url-do-orgao-integrado>/v1/integracao/empresas
Verbo HTTP: POST
4.2.3. Request
Request Body

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

Número identificador do órgão ao qual a mensagem é
nu_identificador_orgao Integer S direcionada.
DadosSolicitacao

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

ds_nome String(100) S Nome do solicitante.
Informa se é um contador:
- true;
is_contador Boolean S - false
nu_ddd_telefone String(2) N DDD do telefone.
nu_ramal String(4) N Ramal do telefone.
DadosRegistro
co_protocolo String(10) S Protocolo interno da entidade de registro.

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

arquivo.
ds_url_servico Text S O serviço utilizado na busca de arquivos será o WS24
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

nu_cnpj String(14) N órgãos diferentes de cartório e OAB.
Número de registro na entidade responsável pelo
nu_registro String(16) N registro da empresa.
Número de registro anterior nos casos em que existe
nu_registro_anterior String(16) N evento de alteração de natureza jurídica.
Número do sequencial da pessoa jurídica no sistema
nu_seq_pessoa Integer N da Junta Comercial (SIARCO).
ds_nome_empresarial String(144) S Nome empresarial sem partícula de porte.
ds_nome_fantasia String(150) N Nome fantasia.
Número do CNPJ da matriz.
Se o campo vier preenchido, significa que a empresa

nu_cnpj_matriz String(14) N que está sendo reportada é uma filial.
Número de registro da Matriz.
Se o campo vier preenchido, significa que a empresa

nu_registro_matriz String(16) N que está sendo reportada é uma filial.
23
ds_email String(150) N Endereço de e-mail da empresa.
ds_sitio String(100) N Endereço do site da empresa.
co_natureza_juridica String(5) S Código da natureza jurídica da empresa. Ver tabela
co_enquadramento Integer S Código do enquadramento da empresa. Ver tabela
co_tipo_unidade Integer S Código do tipo de unidade. Ver tabela
Array de objetos do tipo FormaAtuacaoDto.
FormaAtuacao
formas_atuacao [] N Obrigatório quando o tipo de unidade for 0.
ds_objeto_social String(14000) S Objeto social da empresa.
atividades Atividade[] S Array de objetos do tipo 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 N Valor de quotas da empresa.
socios Socio[] N Array de objetos do tipo SocioDto.
ResponsavelL Objeto contendo os dados do responsável legal pela
responsavel_legal egal S empresa.
Data da assinatura da ata.
dt_assinatura_ata String(10) S Formato: YYYY-MM-DD
Data de constituição da empresa.
dt_constituicao String(10) S Formato: YYYY-MM-DD
Data de início das atividades da empresa.
dt_inicio_atividades String(10) S 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).
nu_cnpj_operador_logistico String(14) N Obrigatório se is_empresa_satelite = true.

Informa se é um operador logístico:
- true;
is_operador_logistico Boolean N - false
co_tipo_pratica_comercio_exte
rior Integer N Tipo de prática de comércio exterior. Ver tabela
ResponsavelC Objeto contendo os dados do responsável contábil
responsavel_contabil ontabil N pela empresa.
24
endereco Endereco S Objeto contendo os dados de endereço da empresa.
Objeto contendo os dados de utilização do solo pela
utilizacao_solo UtilizacaoSolo N 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 entidade de registro.
Ver tabela
co_status_empresa String(2) N Exclusivo para Junta Comercial.
Objeto contento os dados de substituição tributária.
SubstitutoTribu Obrigatório e enviado somente nos eventos de
substituto_tributario tario N substituição tributária.
Endereco
co_cep String(8) S Código do CEP da empresa.

co_tipo_imovel Integer N Código do tipo do imóvel. Ver tabela
ds_tipo_logradouro String(100) S Descrição do tipo de logradouro.
ds_endereco String(100) S Descrição do logradouro (sem o tipo de logradouro).
Lista de complementos do endereço da empresa,
separados por ";" com o máximo de 6 complementos.
ds_complemento String(156) N Ver tabela
Código do município (IBGE sem dígito verificador).
co_municipio Integer S Ver tabela
co_municipio_tom Integer S Código do município (TOM). Ver tabela
co_uf Integer N Código da UF. Ver tabela
nu_area_total String(11) N Área total do imóvel.
nu_area_utilizada String(13) N Área utilizada pelo estabelecimento.
ds_ponto_referencia String(150) 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) 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) N co_tipo_natureza = 2.
25
Point

nu_latitude String(20) S ##.################ (positivo).
nu_longitude String(20) S ##.################ (positivo).
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 utilização do
nu_autorizacao String(40) S 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 S tabela
Atividade

- true;
- true;
is_exerce_no_endereco Boolean N - false.
AtividadeEspe
atividades_especializadas cializada[] N Array de objetos do tipo AtividadeEspecializada.
AtividadeEspecializada
26
co_cnae_especializada String(12) S Código CNAE especializado da prefeitura.
- true;
- true;
is_exerce_no_endereco Boolean S - false.
ResponsavelContabil

CPF ou CNPJ do responsável contábil (apenas
co_cpf_cnpj String(14) S números).
ds_nome String(100) S Nome do responsável contábil.
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 contabilidade.
Obrigatório quando o campo co_cpf_cnpj possuir mais

responsavel Responsavel N de 11 dígitos.
DadosConselh Objeto contendo dados do conselho de classe (CRC)
dados_conselho o S do responsável contábil.
EnderecoResp
onsavelContab Objeto contendo dados do endereço do responsável
endereco il S contábil.
Responsavel
nu_cpf String(11) S CPF do responsável pela empresa de contabilidade.

ds_email String(150) S E-mail do responsável pela empresa de contabilidade.
DDD do telefone do responsável pela empresa de
nu_ddd_telefone String(2) S contabilidade.
Telefone do responsável pela empresa de
nu_telefone String(10) S contabilidade.
Objeto contendo os dados do conselho de classe
DadosConselh (CRC) do contador responsável pela empresa de
dados_conselho o S contabilidade.
**
EnderecoResp
onsavelEmpre Objeto contendo dados do endereço do contador
endereco sa S responsável pela empresa de contabilidade.
27
DadosConselho
co_uf_crc Integer S Código da UF do CRC. Ver tabela

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

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

Tipo de pessoa do sócio:
1 = Pessoa física;
co_tipo_pessoa Integer S 2 = Pessoa jurídica;
nu_cpf_cnpj String(14) S Número do CPF ou CNPJ do sócio (apenas números).
ds_nome String(100) S 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(2) N DDD do celular.
nu_celular String(10) N Celular.
endereco EnderecoSocio N Objeto contendo dados de endereço
qualificacoes Qualificacao[] S Array de objetos do tipo QualificacaoDto.
28
Objeto contendo dados referentes à pessoa física.
dados_pessoa_fisica PessoaFisica N Obrigatório caso co_tipo_pessoa = 1.

Objeto contendo dados referentes à pessoa jurídica.
dados_pessoa_juridica PessoaJuridica N Obrigatório caso co_tipo_pessoa = 2.
PessoaFisica
co_estado_civil Integer S Estado civil. Ver tabela

co_regime_bens Integer N Código do regime de bens. Ver tabela
dt_nascimento String(10) S Data de nascimento. Formato: YYYY-MM-DD
Código da nacionalidade da pessoa física (titular,
co_nacionalidade Integer S sócio, representante ou administrador). Ver tabela
Código do município de naturalidade (IBGE sem dígito
co_municipio_naturalidade Integer N verificador). Ver tabela
co_uf_naturalidade Integer N Código da UF referente à naturalidade. Ver tabela
Código do sexo:
1 = Masculino;
co_sexo Integer S 2 = Feminino;
DocumentoIde Objeto contendo os dados do documento de
documento_identificacao ntificacao S 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.
is_emancipado Boolean N Indica se pessoa é emancipada (true ou false)
co_motivo_emancipacao Integer N Código do motivo da emancipação. Ver tabela
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
PessoaJuridica
29
nu_registro String(16) N Número de registro da empresa.

Data do ano de registro da empresa.
nu_ano_registro String(10) N Formato: YYYY-MM-DD.

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 Jurídica.
co_natureza_juridica String(5) N Ver tabela
Código do tipo de entidade de registro responsável
co_tipo_entidade_registro Integer N pelo registro da empresa. Ver tabela
EnderecoSocio
co_pais Integer S Código do país. Ver tabela

Código do município (IBGE sem dígito verificador).
Ver tabela
co_municipio Integer N Obrigatório caso co_pais = 105 (Brasil).

Código do município (TOM). Ver tabela
co_municipio_tom Integer N Obrigatório caso co_pais = 105 (Brasil).

Código da UF. Ver tabela
co_uf Integer N Obrigatório caso co_pais = 105 (Brasil).

CEP (apenas números).
co_cep String(8) N Obrigatório caso co_pais = 105 (Brasil).

Código do tipo de logradouro. Ver tabela
co_tipo_logradouro Integer N Obrigatório caso co_pais = 105 (Brasil).

Descrição do tipo de logradouro.
ds_tipo_logradouro String(100) N Obrigatório caso co_pais = 105 (Brasil).
Descrição do logradouro (sem o tipo de logradouro).
ds_endereco String(100) N Obrigatório caso co_pais = 105 (Brasil).

Número.
nu_numero String(7) N Obrigatório caso co_pais = 105 (Brasil).

Bairro.
ds_bairro String(50) N Obrigatório caso co_pais = 105 (Brasil).
30
Endereço completo de sócio residente no exterior.
Obrigatório caso co_pais seja diferente de 105

ds_endereco_completo String(200) N (Brasil).
Qualificacao

Código do tipo de qualificação de acordo com tabela
co_tipo_qualificacao_rfb Integer N 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
dt_fim_qualificacao String(10) N Data de fim da qualificação Formato: YYYY-MM-DD
CPF ou CNPJ do representado.
Obrigatório indicar representado caso a qualificação

nu_cpf_cnpj_representado String(14) N 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.
nu_participacao_quotas Integer N Número de quotas que o sócio possui na empresa.
ResponsavelLegal
nu_cpf String(11) S CPF do responsável legal (apenas números).

ds_nome String(100) S Nome do responsável legal.
ds_ddd_telefone String(2) N DDD do telefone.
Pergunta

co_pergunta Integer S momento da solicitação de consulta prévia.
DadosAtoLegal
31
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
2 – DIFAL
Obrigatório e enviado somente nos eventos de
co_tipo_substituicao_tributaria Integer N substituição tributária.
Número do convenio tributário.
Obrigatório e enviado somente nos eventos de
nu_convenio_substituicao String N substituição tributária.
4.2.4. Response
Response
Erro
Response body
32
Tipo OB Descrição
DadosSolicitacao S Recurso WS02, incluindo o ID de registro no banco
4.3. WS03 – Mudança de status de documentos
4.3.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.3.3. Request
Request Body

controle Controle S mensagem para identificação e validação dos dados.
DadosDocume
dados_documento nto S Objeto contendo os dados do documento.
Controle

DadosDocumento

33
nu_cnpj String(14) S CNPJ da empresa (apenas números).
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. Ver
co_tipo_modelo_documento Integer S 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 emitido
ds_url String(2000) N 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
ds_observacao String(2000) N a tramitação pelos setores através deste campo.
Array de objetos do tipo Exigencia.
exigencias Exigencia[] N Obrigatório caso o campo co_situacao = 2.

ds_url_taxa String(2000) N URL da taxa gerada pelo sistema próprio do ó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.3.4. Response

34
Response
Erro
Response body
Tipo OB Descrição
DadosDocumento S Recurso WS03, incluindo o ID de registro no banco
4.4. WS04 - Solicitação de documentos
4.4.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
35
4.4.3. Request
Request Body

DadosSolicitac
dados_documento aoDocumento S Objeto contendo os dados do documento.
Controle

Número identificador do órgão ao qual a mensagem
nu_identificador_orgao Integer S é direcionada.
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 tabela
Array de objetos do tipo Pergunta contendo as
perguntas e respostas da coleta adicional de dados
questionario Pergunta[] N da consulta prévia.
empresa Empresa S Campos relativos a empresa.
atividades Atividade[] 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 de seleção
de atividades para o documento solicitado. Nestes
casos, a primeira atividade preenchida no array será
N a atividade principal selecionada pelo usuário.
36
anexos Arquivo[] Array de objetos do tipo Arquivo, com os
documentos anexados referentes a solicitação de
N licenciamento.
Empresa

ds_nome_empresarial String(144) S 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 por
co_pergunta Integer S cada órgão integrado.
Atividade

Arquivo

arquivo.
4.4.4. Response
Response
37
Erro
Response body
Tipo OB Descrição
DadosSolicitacaoDocumento S Recurso WS04, incluindo o ID de registro no banco
4.5. WS05 - Cancelamento de solicitação
4.5.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.5.3. Request
Request Body
Objeto contendo os campos de controle da mensagem

controle Controle S para identificação e validação dos dados.
DadosCancel
amentoSolicit Objeto contendo os dados do cancelamento da
dados_cancelamento_solicitacao acao S solicitação.
38
Controle

DadosCancelamentoSolicitacao

serviço. Somente enviado no retorno Sucesso -
id Integer N 201 pelo serviço.
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 entidade
co_protocolo_registro String(32) S de registro
4.5.4. Response
Response
Erro

39
Response body
Tipo OB Descrição
DadosCancelamentoSolicitacao S Recurso WS05, incluindo o ID de registro no banco
4.6. WS06 - Retorno de exigências
4.6.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.6.3. Request
Request Body
Objeto contendo os campos de controle da mensagem

controle Controle S para identificação e validação dos dados.
DadosRetorno Objeto contendo os dados do retorno da exigência
dados_retorno_exigencias Exigencias S informados pelo solicitante.
Controle

40
DadosRetornoExigencias

Número do protocolo gerado para o processo pela
co_protocolo_redesim String(13) S 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

ds_retorno_exigencia String(1000) S Retorno da exigência informada pelo usuário externo.
Array de objetos do tipo Arquivo, com os documentos
anexos Arquivo[] N anexados pelo solicitante na resposta de exigência.
Arquivo

arquivo.
Os serviços de busca para cada tipo de arquivo estão

descritos nos serviços disponibilizados pelo
ds_url_servico Text S SIGFÁCIL.
4.6.4. Response
Response
41
Erro
Response body
Tipo OB Descrição
DadosRetornoExigencias S Recurso WS06, incluindo o ID de registro no banco
42
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
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
43
WS24 – Busca
x x x x x x x x
de arquivos
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: https://integracao.voxtecnologia.com.br/v1/integracao/resposta-consultas-
previas
Verbo HTTP: POST
5.1.3. Request
Mensagem

DadosRespost
aConsultaPrev Objeto contendo os dados de resposta da consulta
dados_resposta_consulta_previa ia S prévia.
Controle

Número identificador do órgão que está realizando a
nu_identificador_orgao Integer S 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)
44
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(300) N nu_situacao_consulta = 2.
Data em que ocorreu o evento de reserva de nome.
Formato: YYYY-MM-DD.
Obrigatório caso co_tipo_consulta = 1 e

dt_reserva String(10) N 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.
ds_observacao String(2000) N Obrigatório quando co_motivo_indeferimento = 99.
5.1.4. Response
Response
Erro

Nova situação
Nova situação da consulta não (co_situacao_consulta) de
400 9908
permitida. consulta prévia não permitida.
As transições permitidas são:
45
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

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: https://integracao.voxtecnologia.com.br/v1/integracao/resposta-documentos-
baixa
Verbo HTTP: POST
5.2.3. Request
Request Body
46

Objeto contendo os dados do andamento da
dados_resposta DadosResposta S solicitação.
Controle

Número identificador do órgão que está realizando o
nu_identificador_orgao Integer S 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.
dt_resposta String(19) S Formato: YYYY-MM-DD HH:MM:SS.
Número do documento.
nu_documento String(30) N Obrigatório caso o campo co_situacao = 5.

Data de validade do documento emitido.
dt_validade String(19) N Formato: YYYY-MM-DD HH:MM:SS.
Se retorno é de documento:
- true;
- false.
Caso seja false, trata-se de um retorno de solicitação

is_retorno_documento Boolean S de baixa.
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
documento. Caso o documento esteja entrando 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
ds_observacao String(2000) N documento em análise em mudança de status, este
47
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 emitida
ds_url_dam_proprio String(2000) N por sistema próprio do órgão.
URL para o documento, caso o mesmo seja emitido
ds_url String(2000) N 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
48
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;

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

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

Emitido -> Cassado;
Emitido -> Anulado;
Emitido -> Suspenso.
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.
Response body
Tipo OB Descrição
DadosResposta S Recurso WS21, incluindo o ID de registro no banco
49
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
URL: https://integracao.voxtecnologia.com.br/v1/integracao/andamento-solicitacao
Verbo HTTP: POST
5.3.3. Request
Request Body
50
DadosAndame Objeto contendo os dados do andamento da
dados_andamento_solicitacao ntoSolicitacao S solicitação.
Controle

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

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. Ver
co_status_solicitacao Integer S tabela
Número de registro no cartório.
nu_numero_registro String(18) N Obrigatório quando co_status_solicitacao = 4.

Indica se o DBE será indeferido:
- true;
- false.
Obrigatório quando co_status_solicitacao = 2 ou

is_indefere_dbe Boolean N 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.

nu_cpf String(11) S CPF do responsável do andamento do processo.
Link para o contrato chancelado.
ds_link_contrato_social String(2083) N Obrigatório quando o co_status_solicitacao = 5.
51
5.3.4. Response
Response
Erro

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
52
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.
URL: https://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á realizando
nu_identificador_orgao Integer S 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
53
Erro
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.
54
URL: https://integracao.voxtecnologia.com.br/v1/integracao/
arquivo/<nu_identificador_orgao>/<hash >
Verbo HTTP: GET
5.5.3. Request

Número identificador do órgão que está realizando o
nu_identificador_orgao Integer S 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.
55
Response body
arquivo binary S Arquivo digitalizado.
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
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
56
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
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.
57
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).
Lista de complementos do endereço da empresa.

complemento Complemento[] N 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
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
58
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.
6.2.4. Response
Response
Erro
59
Erro ao consultar o Código de

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

Obrigatório caso co_retorno = 3200.
DadosCRC
CPF ou CNPJ do responsável contábil (apenas

co_cpf_cnpj String(14) S números).
ds_nome String(100) S Nome do responsável contábil.
nu_tipo_pessoa Integer S Tipo de pessoa do responsável contábil. Ver tabela
Objeto contendo os dados do contador

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

responsavel Responsavel N mais de 11 dígitos.
DadosConselh Objeto contendo dados do conselho de classe

dados_conselho o S (CRC) do responsável contábil.
Responsavel
CPF do responsável pela empresa de

nu_cpf String(11) S contabilidade.
E-mail do responsável pela empresa de

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

nu_ddd_telefone String(2) S contabilidade.
60
Telefone do responsável pela empresa de
nu_telefone String(10) S contabilidade.
Objeto contendo os dados do conselho de classe

DadosConsel (CRC) do contador responsável pela empresa de
dados_conselho ho S contabilidade.
EnderecoRes
ponsavelEmp Objeto contendo dados do endereço do contador
endereco resa S responsável pela empresa de contabilidade.
DadosConselho
co_uf_crc Integer S Código da UF do CRC.
nu_sequencia String(10) S Número sequencial do CRC.
dt_registro String(10) S Data do registro no CRC. Formato: YYYY-MM-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.
EnderecoResponsavelEmpresa
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 por

ds_complemento String(156) N ";". 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
61
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_tipo_operacao>/<co_protocolo>/<co_cpf_cnpj>/<
ds_nome>/<nu_valor_taxa>/><co_tributo>/<dt_vencimento>
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(100) S Nome do sacado.
Valor da taxa.
nu_valor_taxa Numeric(12,2) N Obrigatório se nu_tipo_operacao = 2.

co_tributo String(4) N Código do tributo.
Data de vencimento da taxa.
dt_vencimento String(10) N Formato: AAAA-MM-DD
6.3.4. Response
Response

Erro
62
Response body
taxas Taxa[] S Array de objetos do tipo Taxa.
Taxa
nu_nosso_numero Integer S Nosso número.
nu_documento Integer 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.
nu_valor_total Numeric(12.2) N Valor total da taxa (com juros, multa e correção).
Data de vencimento.
dt_vencimento String(10) S Formato: YYYY-MM-DD
Número da parcela. Se vazio, significa que é cota

nu_parcela String(2) N única.
ds_tributo String(40) N Descrição do tributo.
6.4. WS33 – Busca pagamentos
6.4.1. Descrição
63
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.
Busca lista de pagamentos

URL: https://<url-do-orgao-integrado >/v1/integracao/pagamentos/<nu_convenio>
Verbo HTTP: GET
Busca pagamento específico

>/v1/integracao/pagamentos/<nu_convenio>/<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
Response

Erro
64
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
co_autenticacao String(50) S Código de autenticação do pagamento no banco.
7. Tabelas
7.1. Tabela 1 – Response – Tabela de códigos de retorno comuns
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.
65
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.
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:
Em análise;
Novo status da solicitação não Em análise -> Indeferido;
400 9901 WS22
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 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;
400 9904 WS21 Nova situação não permitida Aguardando solicitação -> Em
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);
66
Em exigência -> Emitido;
Emitido -> Revogado;

Emitido -> Cassado;
Emitido -> Anulado;
Emitido -> Suspenso.
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.
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.
67

Manual Integração API

Загружено:

Сведения о документе

Исходное описание:

Оригинальное название

Авторское право

Доступные форматы

Поделиться этим документом

Поделиться или встроить документ

Параметры публикации

Этот документ был вам полезен?

Это неприемлемый материал?

Авторское право:

Доступные форматы

Manual Integração API

Загружено:

Авторское право:

Доступные форматы

Manual de Integração

Versão Data Descrição Responsável

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.2.7 30/01/2018 -Removendo os atributos (“co_situacao_empresa” e Edmilson Mota

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

2.0.9 22/11/2017 WS02 – Atributos is_empresa_satelite, 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

Após a análise da viabilidade, os órgãos responsáveis pela análise de nome e de

4.1.2. Dados adicionais

Campo Tipo OB Descrição

Campo Tipo OB Descrição

Campo Tipo OB Descrição

nu_cnpj String(14) N Obrigatório para os eventos de alteração.

Obrigatório para os eventos 101, 102, 220 e 210

Obrigatório para os eventos 101 e 210 entrando na

Obrigatório para naturezas jurídicas registradas em

Campo Tipo OB Descrição

nu_cpf String(14) S CPF do solicitante (apenas números).

Obrigatório para todos os eventos de natureza

Campo Tipo OB Descrição

Campo Tipo OB Descrição

Campo Tipo OB Descrição

Campo Tipo OB Descrição

ds_nome_mae String(150) N Nome da mãe do sócio, titular ou empresário.

Campo Tipo OB Descrição

co_tipo_logradouro Integer S Código do tipo de logradouro. Ver tabela

Descrição do logradouro (sem o tipo de

nu_numero String(7) S Número.

ds_bairro String(50) S Bairro.

Lista de complementos do endereço da

Área total do terreno da empresa (em

Área utilizada pela empresa (em metros

Descrição de um ponto de referência para

Objeto do tipo NaturezaImovel contendo os

Objeto contendo as coordenadas

Campo Tipo OB Descrição

Campo Tipo OB Descrição

Campo Tipo OB Descrição

Obrigatório quando co_tipo_natureza = 1 ou

Campo Tipo OB Descrição

ds_arquivo Arquivo[] N * Array de objetos do tipo Arquivo.

Campo Tipo OB Descrição

O serviço utilizado na busca de arquivos será o

Campo Tipo OB Descrição

co_evento Integer S Código do evento da solicitação. Ver tabela