DOCUMENTAÇÃO

Consulta status de workflow do documento

Chamada: ConsultarWorkflowDoc

Esta função tem por intuito obter o workflow do documento informando a referência.

Existe uma limitação de quantidade de consultas permitidas por hora. Ao ultrapassar esta quantidade, o webservice retorna o erro 192 – Número de consultar por hora excedido.

Formato de entrada:

  • Utilizando referência:
<?xml version="1.0" encoding="ISO-8859-1" ?>
<documentoeletronico>
        <sessao>XXXX</sessao> 
        <docto_sistema_codigo>10</docto_sistema_codigo><referencia>XX</referencia>
</documentoeletronico>
  • Utilizando passcode:
<?xml version="1.0" encoding="ISO-8859-1" ?>
<documentoeletronico>
        <sessao>XXXX</sessao> 
        <passcode>RKILF-FG4FR-TCDEW-57RFE</passcode>
</documentoeletronico>
Parâmetro Formato Obrigatório Descrição
sessao Texto S Chave de acesso cadastrada para sua empresa.
docto_sistema_codigo Númerico S Tipo de documento: (se não informado, assume-se o valor 5)
5 - Contrato Eletrônico
10 - Laudo Digital
referencia Texto S Referência de um documento.
passcode Texto S Passcode de um documento. Passcode é a identificação de um documento gerada pelo Portal QualiSign.

Formato de saída: 

                                    <?xml version="1.0" encoding="ISO-8859-1" ?>
<documentoeletronico>
        <CodErro />
        <MsgErro />
        <documento docto_referencia="" docto_status="" docto_validade=""
    docto_passcode="" docto_tipo=" " docto_criacao="" 
        docto_hash="" docto_carimbo_tempo="" / >
        <partes>
            <parte parte_papel_nome=""  nomefantasia="" parte_empr_cnpj="" parte_empr_ordem="">
                <representantes>
                    <representante repr_cont_cpf="" <repr_ nome="" repr_cont_ordem=""  repr_assinou="" data_assinatura="" icp_brasil="" serial_certif="" IP_assinatura="" navegador_assinatura="" ind_SMS="" forma_de_assinatura="" tipo_acesso_ass="" localizacao_assinatura ="" repr_aprovou="" data_aprovacao="" IP_aprovador="" navegador_aprovador="" localizacao_aprovador=""/>
                </representantes>
        </parte>
        </partes>
</documentoeletronico>
Parâmetro Formato Descrição
CodErro Numérico Código de erro (ver Códigos de Erros).
MsgErro Texto Mensagem de Erro.
docto_referencia Texto Referência do documento.
docto_status Texto Status do documento. Valores possíveis:
  • A – Vigente/Ativo;
  • B – Bloqueado;
  • C – Cancelado;
  • D – Em Definição de Papéis;
  • D – Erro no encerramento de uma parte:
      • Pode ocorrer em duas situações:
      1-Uma parte ficou sem representante para efetuar assinatura. Exemplo: foi definido que um representante assina por duas partes diferentes com mesmo CNPJ. No momento que o representante efetuar a assinatura na primeira parte, ele é, automaticamente, removido da segunda parte, ficando essa última parte sem representante. O contrato entrará no status “E”, erro, alertando que uma parte está sem representante
      2-Quantidade de assinaturas insuficientes na parte. Exemplo: Cliente utiliza qtde mínima de assinaturas para encerramento da parte. Foi definido uma quantidade mínima de duas assinaturas para determinado relacionamento, porém, no contrato, foi incluído somente um representante na parte. No momento que o representante efetuar a assinatura o contrato entrará no status “E” alertando que essa parte não pode ser encerrada devido á quantidade mínima de assinatura solicitada.
  • G – Aguardando ativação de outro contrato;
  • P – Pendente de assinatura/aprovação;
  • R – Recusado;
  • T – Aguardando Carimbo de Tempo;
  • V – Vencido.
docto_validade Texto Validade do documento.
docto_passcode Texto Código PASSCODE do documento.
docto_tipo Texto Tipo de documento.
docto_criacao Texto Data de criação do documento no formato DD/MM/AAAA.
docto_hash Texto Hash
docto_carimbo_tempo Texto Indica se o documento tem carimbo de tempo. Valores possíveis S=Sim, N=Não
partes Nó Node para definição das partes que deverão assinar o documento.
parte Texto Node para definir a parte que assinará documento.
parte_papel_nome Texto Nome do papel representado por esta empresa.
nomefantasia Texto Nome fantasia.
parte_empr_cnpj Texto CNPJ da empresa que representará este papel.
parte_empr_ordem Texto Em que ordem será disponibilizada a assinatura desta empresa.
representantes Nó Node para definir os representantes das partes que assinarão o documento.
representante Texto Node para definir o representante que assinará o documento.
repr_cont_cpf Texto CPF do representante.
repr_nome Texto Nome do Representante.
repr_cont_ordem Texto Em que ordem será disponibilizada a assinatura deste representante.
repr_assinou Texto Indica se o representante assinou o documento. Valores possíveis:
S = Assinou;
N = Não assinou o documento.
data_assinatura Texto Data que o representante assinou o documento.
icp_brasil Texto Indica se o certificado que assinou é padrão ICP Brasil. Valores possíveis:
S = Padrão ICP Brasil;
N = Não é padrão ICP Brasil.
serial_certif Texto Indica o serial do certificado que efetuou a assinatura.
IP_assinatura Texto Indica o IP da estação/dispositivo que efetuou a assinatura.
navegador_assinatura Texto Indica os dados do navegador da estação/dispositivo que efetuou a assinatura.
ind_SMS Texto Indica se a assinatura SEM certificado digital foi efetuada também com digitação de código SMS recebido no celular. Valores possíveis:
S = Assinatura sem certificado digital com SMS;
N = Assinatura sem certificado digital sem SMS.
forma_de_assinatura Texto Indica a forma de assinatura. Valores possíveis:
Certificado Digital = Assinou com certificado digital
Usuário + Senha = Assinou com usuário e senha
Usuário + Senha + SMS = Assinou com usuário, senha e SMS
Biometria = Assinou com usuário, senha e Biometria
Concordância = Assinou com botão OK.
SMS = Se assinatura eletrônica com acesso rápido (efetuado sem login pela notificação e assinatura efetivada com código SMS). Os demais tipos de assinatura, efetuadas com acesso rápido sem o código SMS, permanecem com o respectivo valor. Somente se foi efetivada pela nova tela de acesso rápido. Se efetuada através de Login do Portal permanecem os valores atuais.
tipo_acesso_ass Texto Indica a forma de acesso para assinatura. Valores possíveis:
Normal = Acesso normal/padrão, com login/senha
Rápido = Acesso rápido, sem login/senha
localizacao_assinatura Texto Indica localização onde foi efetuada a assinatura (Somente para dispositivo mobile com localização habilitada).
repr_aprovou Texto Indica se o representante aprovou o documento. Valores possíveis: S = Aprovou;
N = Não aprovou o documento.
data_aprovacao Texto Data que o representante aprovou o documento.
IP_aprovador Texto Indica o IP da estação/dispositivo que efetuou a aprovação.
navegador_aprovador Texto Indica os dados do navegador da estação/dispositivo que efetuou a aprovação.
localizacao_aprovador Texto Indica localização onde foi efetuada a aprovação (Somente para dispositivo mobile com localização habilitada).
Voltar para Obtém o pacote P7s de documento Cadastro de relacionamentos e representantes