Projeto Nota Fiscal de Consumidor Eletrnica

NT-NFCe 2014/001 Web Service de Gerenciamento do CSC

Projeto Nota Fiscal de Consumidor Eletrnica

Manual Tcnico de Utilizao do Web Service de

Administrao do Cdigo de Segurana do
Contribuinte - CSC

Verso 1.00
19 de Agosto de 2014
Pgina 1/9

Projeto Nota Fiscal de Consumidor Eletrnica

NT-NFCe 2014/001 Web Service de Gerenciamento do CSC

Controle de Verses
Verso
1.00

Data
23/05/2014 AM

Pgina 2/9

Projeto Nota Fiscal de Consumidor Eletrnica

NT-NFCe 2014/001 Web Service de Gerenciamento do CSC

Identificao e vigncia do Manual

Verso do manual
Data de divulgao do manual
Pacote de liberao de Schemas XML
Data de incio de vigncia no ambiente de homologao
Data de incio de vigncia no ambiente de produo

1.00
A definir
PL_001a
A definir
A definir

Verses de leiautes do PL_001a

Leiaute

verso

Schema XML

admCscNFCe

1.00

admCscNFCe_v1.00.xsd

retAdmCscNFCe

1.00

retAdmCscNFCe_v1.00.xsd

Observao
Mensagem de solicitao de consulta,
gerao ou revogao de nmero(s) de CSC
NFC-e.
Mensagem de retorno da solicitao de
consulta, gerao ou revogao de nmero(s)
de CSC NFC-e.

Pgina 3/9

Projeto Nota Fiscal de Consumidor Eletrnica

NT-NFCe 2014/001 Web Service de Gerenciamento do CSC

1. Introduo
Este manual objetiva definir as especificaes e critrios tcnicos necessrios para que as
empresas emissoras de Nota Fiscal de Consumidor Eletrnica - NFC-e - possam efetuar o
gerenciamento dos nmeros de CSC NFC-e por meio do uso de Web Service. Esse servio
poder ser usado como alternativa s solues j existentes de gerenciamento do CSC NFC-e
por meio de pgina web. O CSC NFC-e e seu respectivo nmero de identificao constituem
informaes fundamentais para a correta gerao do QR-Code que dever ser impresso no
DANFE NFC-e. Mais informaes sobre a forma de utilizao do CSC podero ser obtidas em
manual especfico.

2. Descrio Simplificada do Modelo Operacional

A empresa emissora de NFC-e dever gerar um arquivo eletrnico em formato XML
obedecendo leiaute especfico. O Web Service de manuteno do CSC NFC-e oferecer trs
funcionalidades distintas: consulta de cdigos de segurana ativos, revogao de cdigo de
segurana ativo e requisio de novo cdigo de segurana.
O arquivo eletrnico gerado pelo contribuinte ser transmitido pela Internet, para o ambiente
autorizador, que far uma pr-validao do arquivo e devolver uma mensagem eletrnica com
o resultado da validao.
Cada contribuinte (CNPJ Raiz) poder manter at dois CSC ativos simultaneamente. O Web
Service far o controle para garantir que esta regra seja respeitada. Na hiptese de haver dois
CSC ativos, s ser aceita a requisio de novo CSC aps a revogao de um deles.
A funcionalidade de consulta de CSC ativos poder ser usada a qualquer tempo sem nenhum
tipo de restrio.

3. Modelo operacional
As funcionalidades (mtodos) do Web Service de administrao do CSC NFC-e obedecero ao
padro sncrono de comunicao, ou seja, o retorno do servio solicitado ser dado ao
contribuinte pela mesma conexo usada para realizar a solicitao.

Servio
Manuteno do CSC NFC-e

Mtodo
Administrar CSC NFC-e

Implementao
Sncrona

Pgina 4/9

Projeto Nota Fiscal de Consumidor Eletrnica

NT-NFCe 2014/001 Web Service de Gerenciamento do CSC

4. Web Service
O Web Service disponibiliza os servios que sero utilizados pelos aplicativos dos emissores de
NFC-e. O mecanismo de utilizao do Web Service segue as seguintes premissas:
a) Ser disponibilizado apenas um Web Service, com um nico mtodo, que atender todos os
servios;
b) O envio da solicitao e a obteno do retorno sero realizados na mesma conexo, pelo
mesmo mtodo.
c) A URL do Web Service de cada ambiente autorizador de NFC-e ser publicada no portal
nacional da Nota Fiscal Eletrnica. Acessando a URL o contribuinte poder obter o WSDL (Web
Service Description Language) do servio.
d) O processo de utilizao do Web Service sempre iniciado pelo emissor de NFC-e, enviando
uma mensagem nos padres XML e SOAP (verso 1.2), por meio do protocolo SSL com
autenticao mtua.
e) A ocorrncia de qualquer erro na validao dos dados recebidos interrompe o processo com
a disponibilizao de uma mensagem contendo o cdigo e a descrio do erro.

Pgina 5/9

Projeto Nota Fiscal de Consumidor Eletrnica

NT-NFCe 2014/001 Web Service de Gerenciamento do CSC

5. Servio de Manuteno do CSC NFC-e

O Servio de Manuteno do CSC NFC-e o servio oferecido pelo Web Service da SEFAZ
autorizadora para atualizao do repositrio de CSC NFC-e. A utilizao de cada uma das
funcionalidades oferecidas pelo servio dever ser feita por meio da especificao do tipo de
operao no XML de requisio.
Contribuinte

Secretaria de Fazenda Estadual

Web Service:
CscNFCe
Proc.
admCscNFCe

Envio
Cliente NFCe

Ret.

Processamento

Retorno
Aplicao
Ambiente
Autorizador

5.1. Mtodo admCscNFCe

Funo: servio destinado s opes de consulta, requisio e revogao dos nmeros de
CSC NFC-e.
Processo: sncrono.

5.1.1. Leiaute Mensagem de Entrada

Entrada: Estrutura XML com os dados para a administrao de CSC NFC-e.
Schema XML: admCscNFCe _v9.99.xsd
AP01
AP02
AP03

admCscNFCe
versao
tpAmb

Raiz
A
E

AP01
AP01

C
N

1-1
1-1

4
1

AP04

indOp

AP01

1-1

AP05

raizCNPJ

AP01

1-1

AP06
AP07

dadosCsc
idCsc

G
E

CP01
CP05

0-1
1-1

AP08

codigoCsc

CP05

1-1

16

TAG raiz
Verso do leiaute - "1.00"
Identificao do tipo de ambiente:
1 Produo; 2 - Homologao
Identificador do tipo de operao:
1 - Consulta CSC Ativos;
2 - Solicita novo CSC;
3 - Revoga CSC Ativo
Raiz do CNPJ do contribuinte que
est efetuando a consulta.
Dados do CSC a ser revogado
Nmero identificador do CSC a
ser revogado
Cdigo alfanumrico do CSC a
ser revogado

Pgina 6/9

Projeto Nota Fiscal de Consumidor Eletrnica

NT-NFCe 2014/001 Web Service de Gerenciamento do CSC

5.1.2. Leiaute Mensagem de Retorno

Retorno: Estrutura XML com a mensagem de retorno da solicitao de administrao do CSC
NFC-e.
Schema XML: retAdmCscNFCe _v9.99.xsd
#
Campo
AR01 retAdmCscNFCe
AR02 versao

Ele
Pai Tipo Ocorr Tam.
Raiz
A AR01
C
1-1
4

AR03 tpAmb

AR01

1-1

AR04 indOp

AR01

1-1

AR05 cStat

AR01

1-1

AR06 xMotivo

AR01

1-1

AR07 dadosCsc

AR01

AR08 idCsc

AR07

1-1

AR09 codigoCsc

AR07

1-1

0-2

Dec. Descrio/Observao
TAG Raiz
Verso do leiaute - "1.00"
Identificao do tipo de ambiente:
1
1 Produo; 2 Homologao.
Identificador do tipo de operao:
1 - Consulta CSC Ativos;
1
2 - Requisita novo CSC;
3 - Revoga CSC Ativo
Cdigo do resultado do
3
processamento da solicitao.
Descrio literal do resultado do
1-255
processamento da solicitao.
Tag de grupo para retorno dos dados
de at dois CSC.
Nmero sequencial do CSC na base
6
de dados do rgo autorizador.
16
Cdigo alfanumrico do CSC.

5.1.3. Tabela de Regras de Validao do Servio de Consulta de CSC Ativos:

#
A01
A02
A03
A04
A05
A06
A07
A08
A09
A10
A11
A12
A13
A14
A15
A16
A17

Regras de Validao do Servio

Regra de Validao
Validar schema XML
Validar verso do arquivo XML no suportada
Validar cabealho
Validar ambiente informado diverge do Ambiente de
recebimento
Validar certificado Transmissor invlido
Validar certificado Transmissor Data Validade
Validar certificado Transmissor sem CNPJ
Validar certificado Transmissor - erro Cadeia de
Certificao
Validar certificado Transmissor revogado
Validar certificado Transmissor difere ICP-Brasil
Validar certificado Transmissor erro no acesso a LCR
Validar XML da rea de dados com codificao
diferente de UTF-8
Validar uso de prefixo de namespace no permitido
Validar campo cUF no elemento nfeCabecMsg do
SOAP Header
Validar UF informada no campo cUF
Validar campo versaoDados no elemento
nfeCabecMsg do SOAP Header
Validar solicitante no autorizado para a consulta

Aplic.
Obrig
Obrig
Obrig
Obrig

Msg

215
239
242
252

Efeito
Rej.
Rej.
Rej.
Rej.

Obrig
Obrig
Obrig
Obrig

280
281
282
283

Rej.
Rej.
Rej.
Rej.

Obrig
Obrig
Obrig
Obrig

284
285
286
402

Rej.
Rej.
Rej.
Rej.

Obrig
Obrig

404
409

Rej.
Rej.

Obrig
Obrig

410
411

Rej.
Rej.

Obrig

695

Rej.

Pgina 7/9

Projeto Nota Fiscal de Consumidor Eletrnica

NT-NFCe 2014/001 Web Service de Gerenciamento do CSC

5.1.4. Final do Processamento da Solicitao

A validao da solicitao poder resultar em:

Rejeio devoluo da mensagem com o motivo da falha informado no cStat;

Atendimento com CSC ativos devoluo dos CSC ativos (cStat=150) caso o
indicador da operao seja de consulta (indOp=1);
Atendimento sem CSC ativo no h CSC ativo (cStat=151) caso o indicador da
operao seja consulta (indOp=1)
Atendimento com novo CSC a requisio retornar um novo CSC (cStat=152) caso
o indicador da operao seja requisio (indOp=2);
Atendimento com CSC revogado a requisio retornar que o CSC foi revogado
(cStat=153) caso o indicador da operao seja revogao (indOp=3);

5.2.3. Tabela de Regras de Validao do Servio de Requisio de Novo CSC:

#
A01
A02
A03
A04
A05
A06
A07
A08
A09
A10
A11
A12
A13
A14
A15
A16
A17
A18

Regras de Validao do Servio

Regra de Validao
Validar schema XML
Validar verso do arquivo XML no suportada
Validar cabealho
Validar ambiente informado diverge do Ambiente de
recebimento
Validar certificado Transmissor invlido
Validar certificado Transmissor Data Validade
Validar certificado Transmissor sem CNPJ
Validar certificado Transmissor - erro Cadeia de
Certificao
Validar certificado Transmissor revogado
Validar certificado Transmissor difere ICP-Brasil
Validar certificado Transmissor erro no acesso a LCR
Validar XML da rea de dados com codificao
diferente de UTF-8
Validar uso de prefixo de namespace no permitido
Validar campo cUF no elemento nfeCabecMsg do
SOAP Header
Validar UF informada no campo cUF
Validar campo versaoDados no elemento
nfeCabecMsg do SOAP Header
Validar solicitante no autorizado para a consulta
Validar se contribuinte possui nmero mximo de
CSC

Aplic.
Obrig
Obrig
Obrig
Obrig

Msg

215
239
242
252

Efeito
Rej.
Rej.
Rej.
Rej.

Obrig
Obrig
Obrig
Obrig

280
281
282
283

Rej.
Rej.
Rej.
Rej.

Obrig
Obrig
Obrig
Obrig

284
285
286
402

Rej.
Rej.
Rej.
Rej.

Obrig
Obrig

404
409

Rej.
Rej.

Obrig
Obrig

410
411

Rej.
Rej.

Obrig
Obrig

695
802

Rej.
Rej

5.3.3. Tabela de Regras de Validao do Servio de Revogao de CSC Ativo:

#
A01
A02
A03
A04
A05
A06
A07

Regras de Validao do Servio

Regra de Validao
Validar schema XML
Validar verso do arquivo XML no suportada
Validar cabealho
Validar ambiente informado diverge do Ambiente de
recebimento
Validar certificado Transmissor invlido
Validar certificado Transmissor Data Validade
Validar certificado Transmissor sem CNPJ

Aplic.
Obrig
Obrig
Obrig
Obrig

Msg

215
239
242
252

Efeito
Rej.
Rej.
Rej.
Rej.

Obrig
Obrig
Obrig

280
281
282

Rej.
Rej.
Rej.
Pgina 8/9

Projeto Nota Fiscal de Consumidor Eletrnica

A08
A09
A10
A11
A12
A13
A14
A15
A16
A17
A19
A20
A21

NT-NFCe 2014/001 Web Service de Gerenciamento do CSC

Validar certificado Transmissor - erro Cadeia de
Obrig
Rej.
283
Certificao
Obrig
Rej.
Validar certificado Transmissor revogado
284
Obrig
Rej.
Validar certificado Transmissor difere ICP-Brasil
285
Obrig
Rej.
Validar certificado Transmissor erro no acesso a LCR
286
Validar XML da rea de dados com codificao
Obrig
Rej.
402
diferente de UTF-8
Obrig
Rej.
Validar uso de prefixo de namespace no permitido
404
Validar campo cUF no elemento nfeCabecMsg do
Obrig
Rej.
409
SOAP Header
Obrig
Rej.
Validar UF informada no campo cUF
410
Validar campo versaoDados no elemento
Obrig
Rej.
411
nfeCabecMsg do SOAP Header
Obrig
Rej.
Validar solicitante no autorizado para a consulta
695
Rejeio: O CSC e o identificador informado no
Obrig
Rej
803
possuem correspondncia
Rejeio: O CSC informado no pertence ao
Obrig
Rej
804
solicitante da revogao
Obrig
Rej
Rejeio: O CSC informado est revogado
805

6. Web Service Informaes Adicionais

6.1. Tabela de cdigos e descries das mensagens retornadas pelos servios do Web
Service de manuteno do CSC:
CDIGO

150
151
152
153
802
803
804
805
213
215
239
242
252
280
281
282
283
284
285
286
402
404
409
410
411
695
999

MENSAGEM
Consulta de CSC realizada com sucesso, com CSC ativo(s)
Consulta de CSC realizada com sucesso, sem CSC ativo
CSC gerado
CSC revogado
Rejeio: Contribuinte possui nmero mximo de CSC ativo
Rejeio: O CSC e o identificador informado no possuem correspondncia
Rejeio: O CSC informado no pertence ao solicitante da revogao
Rejeio: O CSC informado est revogado
Rejeio: CNPJ-Base do Emitente difere do CNPJ-Base do Certificado Digital
Rejeio: Falha no schema XML
Rejeio: Cabealho Verso do arquivo XML no suportada
Rejeio: Cabealho Falha no schema XML
Rejeio: Ambiente informado diverge do Ambiente de recebimento
Rejeio: Certificado Transmissor invlido
Rejeio: Certificado Transmissor Data Validade
Rejeio: Certificado Transmissor sem CNPJ
Rejeio: Certificado Transmissor - erro Cadeia de Certificao
Rejeio: Certificado Transmissor revogado
Rejeio: Certificado Transmissor difere ICP-Brasil
Rejeio: Certificado Transmissor erro no acesso a LCR
Rejeio: XML da rea de dados com codificao diferente de UTF-8
Rejeio: Uso de prefixo de namespace no permitido
Rejeio: Campo cUF inexistente no elemento nfeCabecMsg do SOAP Header
Rejeio: UF informada no campo cUF no atendida pelo WebService
Rejeio: Campo versaoDados inexistente no elemento nfeCabecMsg do SOAP Header
Rejeio: Solicitante no autorizado para a consulta
Rejeio: Erro no catalogado

Pgina 9/9