DOCUMENTAÇÃO

Cadastro de documentos

Chamada: AutoCadastroDOCUMENTO

Esta função tem por objetivo realizar a inclusão de documentos, sendo eles contratos eletrônicos ou laudos. De forma complementar, é possível realizar também:

  • O cadastramento de partes (Relacionamentos que podem ser empresas Pessoa Jurídica ou Pessoa Física), caso estas ainda não estejam cadastradas no Portal QualiSign.
    • Como uma Pessoa física se auto representa no Portal QualiSign é importante que os detalhes da parte (Relacionamento) e os detalhes do representante sejam preenchidos com o CPF da pessoa para que o cadastro/associação se realize com sucesso. Caso a pessoa física também possua um procurador, um segundo representante poderá ser cadastrado/associado através da TAG <representante> como já ocorre quando a parte é proveniente de uma Pessoa Jurídica.
  • O cadastramento automático de representantes, que se realiza de duas formas:

- Se forem preenchidos os nodes referente a representantes novos;

- Se a empresa estiver integrada ao sistema de poderes e neste caso, o Logon_id do representante é o próprio CPF do representante.

Formato de entrada: 

                                    
                                        <?xml version="1.0" encoding="ISO-8859-1" ?>
                                        <documentoeletronico>
                                        <sessao>XXXX</sessao>
                                        <documentos>
                                        <documento docto_nome_arquivo="" docto_referencia="" docto_dtinicio="" docto_dtfim="" docto_fl_validade="" docto_cod_tipodoc="" docto_cod_moeda="" valor="" docto_area="" docto_observacao="" docto_centro_custo="" id_parceiro="" docto_sistema_codigo="" docto_objetivo="">
                                        DOCUMENTO-BASE-64
                                        <politica_assinatura docto_fl_bacen="" docto_fl_ass_digital="" docto_fl_grava_docto="" docto_fl_car_tempo="" docto_fl_ass_chancela="" docto_dependencia_aprov="" docto_Ref_Pendencia="" />
                                        <seguranca_documento  docto_cod_tipo_acesso="" />
                                        <partes>
                                        <parte parte_papel_nome=""  parte_empr_cnpj="" parte_empr_ordem="" parte_acao="">
                                        <detalheParte razao="" nomefantasia="" qtdeass="" PerfilDefault="" />
                                        <representantes>
                                        <representante repr_cont_cpf="" repr_cont_ordem="" repr_somente_acomp="" repr_aprova="" repr_acesso_ass="" >
                                        <detalheRepr nome="" idlogon="" email="" ddi_celular="" celular="" perfil="" DataVencMandato="" DataVencInd=""  AssinaIsoladamente="" LimiteIsoladamente="" AssinaConjuntamente="" LimiteConjuntamente="" />
                                        </representante>
                                        <representante repr_cont_cpf="" repr_cont_ordem="" repr_somente_acomp="" repr_aprova="" repr_acesso_ass="" >
                                        <detalheRepr nome="" idlogon="" email="" ddi_celular="" celular="" perfil="" DataVencMandato="" DataVencInd=""  AssinaIsoladamente="" LimiteIsoladamente="" AssinaConjuntamente="" LimiteConjuntamente="" />
                                        </representante>
                                        <representante repr_cont_cpf="" repr_cont_ordem="" repr_somente_acomp="" repr_aprova="" >
                                        <detalheRepr nome="" idlogon="" email="" ddi_celular="" celular="" perfil="" DataVencMandato="" DataVencInd=""  AssinaIsoladamente="" LimiteIsoladamente="" AssinaConjuntamente="" LimiteConjuntamente="" />
                                        </representante>
                                        </representantes>
                                        </parte>
                                        <parte parte_papel_nome=""  parte_empr_cnpj="" parte_empr_ordem="" parte_acao="">
                                        <detalheParte razao="" nomefantasia="" qtdeass="" PerfilDefault="" />
                                        <representantes>
                                        <representante repr_cont_cpf="" repr_cont_ordem="" repr_somente_acomp="" repr_aprova="">
                                        <detalheRepr nome="" idlogon="" email="" ddi_celular="" celular="" perfil="" DataVencMandato="" DataVencInd=""  AssinaIsoladamente="" LimiteIsoladamente="" AssinaConjuntamente="" LimiteConjuntamente="" />
                                        </representante>
                                        <representante repr_cont_cpf="" repr_cont_ordem="" repr_somente_acomp="" repr_aprova="">
                                        <detalheRepr nome="" idlogon="" email="" ddi_celular="" celular="" perfil="" DataVencMandato="" DataVencInd=""  AssinaIsoladamente="" LimiteIsoladamente="" AssinaConjuntamente="" LimiteConjuntamente="" />
                                        </representante>
                                        </representantes>
                                        </parte>
                                        </partes>
                                        </documento>
                                        </documentos>
                                        </documentoeletronico>
Parâmetro Formato Obrigatório Descrição
sessao Texto S Chave de acesso cadastrada para sua empresa.
documentos Texto S Node para definição de documentos a serem inseridos.
documento Texto S Node para definir o documento a ser inserido.
DOCUMENTO BASE-64 Texto S Texto do documento em BASE64.
docto_nome_arquivo Texto S Nome do documento sendo registrado, incluindo sua extensão.
docto_referencia Texto S Referência do documento.
docto_dtinicio Texto S Data de início da validade do documento no formato DD/MM/AAAA.
docto_dtfim Texto S Data final da validade do documento no formato DD/MM/AAAA.
docto_fl_validade Texto S Indica se o documento não tem uma data de validade definida (indeterminada). Os valores possíveis são S (para validade indeterminada) ou N (para validade determinada).
docto_cod_tipodoc Numérico Texto S Código ou nome do tipo de documento (vide capítulo "Códigos de Tipos de Documento" contido nesta documentação).
docto_cod_moeda Numérico S Código do tipo de moeda (vide capítulo “códigos de tipos de moeda” contido nesta documentação). Caso o cliente utilize a configuração “A quantidade de assinaturas necessárias para encerrar a coleta de uma Parte é definida em cada Relacionamento”, o código da moeda informado deve ser sempre 1 (REAL) pois o Portal QualiSign não faz conversão de moeda no momento de conferir alçadas de limites de um representante.
valor Texto N Valor do documento. Se a configuração “A quantidade de assinaturas necessárias para encerrar a coleta de uma Parte é definida em cada Relacionamento” estiver habilitada para o relacionamento, o valor a ser informado deverá ser sempre em REAIS.
docto_area Texto N Área responsável pelo documento.
docto_observacao Texto N Observação do documento.
docto_centro_custo Texto N Centro de custo do documento.
id_parceiro Texto N Identificador do Parceiro.
Se você é um parceiro do Portal informe o seu ID.
docto_sistema_codigo Numérico N Tipo de produto Portal QualiSign: (se não informado, assume 5)
5 – Contrato Eletrônico;
10 – Laudo Digital.
docto_objetivo Texto N Objetivo do documento
política_assinatura Texto S Node para definir política de assinatura do documento.
docto_fl_bacen Texto S Indica se segue política do BACEN para a assinatura digital. Valores possíveis: S ou N.
docto_fl_ass_digital Texto S Indica se o documento será assinado digitalmente. Valores possíveis: S ou N.
docto_fl_grava_docto Texto S Indica se o pacote PKCS7 conterá ou não o documento. Valores possíveis: S ou N.
docto_fl_car_tempo Texto S Indica se o deveremos inserir carimbo de tempo em todas as assinaturas. Valores possíveis: S ou N.
docto_fl_ass_chancela Texto S Indica o formato de assinatura do documento.Valores possíveis:
N – Indica o formato CADES, padrão do Portal. Esse é o formato padrão se a tag não for informada.
S – Indica o formato PADES.
docto_dependencia_aprov Numérico N Tipo de dependências da aprovação. Os valores possíveis são:
1 - quando este contrato NÃO POSSUI pendências para iniciar o recolhimento de assinaturas (valor default);
2 - quando este contrato POSSUI pendências para iniciar o recolhimento de assinaturas;
3 - quando este contrato é uma pendência para outro contrato.
docto_Ref_Pendencia Texto N Referência do contrato previamente cadastrado no Portal QualiSign com o tipo de dependência da aprovação igual a 2, quando este contrato possui pendências para iniciar o recolhimento de assinatura, que por sua vez será associado ao contrato em questão. Esse parâmetro somente poderá ser passado caso a TAG docto_dependencia_aprov seja atribuída com o valor 3 (este contrato é uma pendência para outro contrato).
seguranca_documento Texto S Node para definir a segurança do documento.
docto_cod_tipo_acesso Numérico S Código do tipo de acesso ao documento. Os valores possíveis são 1 (publico) ou 0 (privado).
partes Texto S Node para definição das partes que deverão assinar/ter acesso ao documento.
parte Texto S Node para definir a parte que assinará ou terá acesso ao documento.
parte_papel_nome Texto S Nome do papel representado por esta empresa.
Colocar a descrição do papel cadastrado no portal.
Vide "Códigos do tipo de documento" para ver a relação de papéis associados a cada tipo de documento.
parte_empr_cnpj Texto S CNPJ da empresa que representará este papel. Preencher o CNPJ sem formatação.
parte_empr_ordem Numérico S Em que ordem será disponibilizada a assinatura desta empresa.
parte_acao Texto N Indica a ação para o papel.
A – Assina COM certificado digital
D - Assina SEM certificado digital
OBS: se este atributo não for preenchido, assume-se que o(s) representante(s) da parte irá(ão) assinar com certificado digital.
detalheParte Texto N Node com os detalhes para inclusão ou alteração de uma parte (cliente).
Obs: Para cadastrar uma Parte Pessoa Física, é necessário complementar informações com o node DetalheRepr.
razao Texto S Razão Social da parte.
nomefantasia Texto S Nome Fantasia da parte.
qtdeass Numérico S Quantidade de assinaturas mínima necessárias para considerar que as assinaturas da parte foram completadas.
Se não utiliza conceito de quantidade mínima de assinaturas informar zero.
PerfilDefault String S Nome do Perfil ou Código do Perfil que deve ser utilizado como padrão para o cadastro de um representante.
(vide capítulo "Perfis de acesso").
representantes Texto N Node para definir os representantes das partes que assinarão ou terão acesso ao documento. Caso este node não exista todos os representantes da empresa serão associados.
representante Texto N Node para definir o representante que assinará o documento. Caso este node não exista nenhum representante será associado.
repr_cont_cpf Texto S CPF do representante.
Preencher sem formatação.
repr_cont_ordem Numérico S Em que ordem será disponibilizada a assinatura deste representante.
repr_somente_acomp Texto S Define o tipo de vínculo com o documento. No caso de acompanhar, receberá todos os e-mails enviados durante o processo de captura de assinatura
S – Somente acompanha.
N – Assina COM certificado digital e acompanha
X – Assina COM certificado, recebe notificação para assinar/aprovar/aceitar, porém não recebe e-mail de conclusão de assinatura
D – Assina SEM certificado digital e acompanha
repr_aprova Texto N Define se o representante é um APROVADOR para o documento.
S – Representante deve aprovar;
N – Não necessita a aprovação deste representante.
repr_acesso_ass Texto N Define a forma como o login será realizado.
N – Acessa com login/senha. Comportamento padrão do portal, se tag não informada;
R – Acessa sem login/senha (Acesso Rápido).
Se não informado assume valor “N”.
detalheRepr Texto N Node com os detalhes para inclusão ou alteração de um representante.
nome Texto S Nome do representante.
idlogon Texto S Identificação do usuário para efetuar login no portal.
email Texto S E-mail do representante.
ddi_celular Numérico N Código DDI do país do Celular do representante. Se não informado assume código 55 (Brasil). Pode ter até 4 dígitos.
celular Numérico N Celular do representante. Deve conter prefixo e número do celular. Se informado o campo deve ter no mínimo 10 caracteres. Por ex.: 1198543210 (se não contém nono dígito), 12998543210 (se contém o nono dígito), etc...
perfil String N Nome do Perfil ou Código do Perfil a ser associado(vide capítulo “Perfis de acesso”).
DataVencMandato Texto N Data de vencimento do mandato do representante, no formato DD/MM/AAAA.
DataVencInd Texto N Define se o mandato do representante é INDETERMINADO. Os valores possíveis são S (para definir mandato indeterminado) ou N (para definir mandato com validade determinada, expressa pelo argumento DataVencMandato.
AssinaIsoladamente Texto N Indica se assina isoladamente (S-Sim, N-Não). Essa informação é relevante somente se a configuração “A quantidade de assinaturas necessárias para encerrar a coleta de uma Parte é definida em cada Relacionamento” estiver habilitada para o relacionamento.
LimiteIsoladamente Texto N Informar valor do limite em REAIS.  Caso AssinaIsoladamente seja igual a S e o limite deste representante seja INDETERMINADO, informar 0 (zero) para LimiteIsoladamente. Caso AssinaIsoladamente seja igual a N, informar na TAG LimiteIsoladamente o valor 0 (zero) ou não informar o TAG. Vale lembrar que a obrigatoriedade em definir limites de um representante na moeda REAL, ocorre devido ao Portal QualiSign não realizar conversão de moedas no momento de conferir alçadas em relação ao valor de um documento. Sendo assim, o valor do documento cadastrado também deve estar sempre em REAIS para utilizar a validação automática de poderes pelo portal. 
Assinaconjuntamente Texto N Indica se assina conjuntamente (S-Sim, N-Não). Essa informação é relevante somente se a configuração “A quantidade de assinaturas necessárias para encerrar a coleta de uma Parte é definida em cada Relacionamento” estiver habilitada para o relacionamento.
Limiteconjuntamente Texto N Informar valor do limite em REAIS.  Caso Assinaconjuntamente seja igual a S e o limite deste representante seja INDETERMINADO, informar 0 (zero) para Limiteconjuntamente. Caso Assinaconjuntamente seja igual a N, informar na TAG Limiteconjuntamente o valor 0 (zero) ou não informar o TAG. Vale lembrar que a obrigatoriedade em definir limites de um representante na moeda REAL, ocorre devido ao Portal QualiSign não realizar conversão de moedas no momento de conferir alçadas em relação ao valor de um documento. Sendo assim, o valor do documento cadastrado também deve estar sempre em REAIS para utilizar a validação automática de poderes pelo portal. 

Formato de saída: 

<?xml version="1.0" encoding="ISO-8859-1" ?>
<documentoeletronico>
    <CodErro />
    <MsgErro />
    <Passcode />
</documentoeletronico>
Parâmetro Formato Descrição
CodErro Numérico Código de erro (ver Códigos de Erros).
MsgErro Texto Mensagem de Erro.
Passcode Texto Passcode do documento.
Voltar para Códigos de Erros para E-mail válido Consulta Relação de Documentos