DOCUMENTATION

View workflow status of the document

Name: ConsultarWorkflowDoc

This function is intended to obtain the workflow of the document informing the reference.

There is a limitation on the number of queries allowed per hour. By exceeding this amount, webservices returns error 192 - Query number per hour exceeded (Número de consultas por hora excedido).

Input format:

  • Using reference:
<?xml version="1.0" encoding="ISO-8859-1" ?>
<documentoeletronico>
        <sessao>XXXX</sessao> 
        <docto_sistema_codigo>10</docto_sistema_codigo><referencia>XX</referencia>
</documentoeletronico>
  • Using passcode:
<?xml version="1.0" encoding="ISO-8859-1" ?>
<documentoeletronico>
        <sessao>XXXX</sessao> 
        <passcode>RKILF-FG4FR-TCDEW-57RFE</passcode>
</documentoeletronico>
Parameter Format Required Description
sessao Text Y Registered access key for your company.
docto_sistema_codigo Númerico Y Type of document: (if not informed, assumes value 5)
5 - Electronic Contract;
10 - Digital Report.
referencia Text Y Document reference.
passcode Text Y Document passcode. Passcode is the identification of a document generated by the QualiSign Portal.

Output format: 

                                    <?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="" localizacao_assinatura ="" repr_aprovou="" data_aprovacao="" IP_aprovador="" navegador_aprovador="" localizacao_aprovador=""/>
                </representantes>
        </parte>
        </partes>
</documentoeletronico>
Parameter Format Description
CodErro Numeric Error code (See Error Codes).
MsgErro Text Error message.
docto_referencia Text Document reference.
docto_status Text Document status. Possible values:
  • A - Current/Active;
  • B - Blocked;
  • C - Canceled;
  • D - In Defining Roles;
  • E - Error in closing a party;
      • It can occur in two situations:

      1 - A party was without a representative to make a signature. Example: It was defined that a representative signs two different parties with the same CNPJ. At the time the representative signs the first part, it is automatically removed from the second part, the latter party being without a representative. The contract will enter status "E", error, warning that a party is without a representative;

      2 - Insufficient number of signatures in the party. Example: Client uses minimum signatures for party closure. A minimum quantity of two signatures was defined for a particular relationship, but in the contract only one representative was included in the party. At the moment the representative makes the signature, the contract will enter the status "E", error, warning that this part can not be closed due to the minimum amount of requested signature.
  • G - Awaiting activation of another contract;
  • P - Pending signature / approval;
  • R - Denied;
  • T - Waiting for Time Stamp;
  • V - Expired.
docto_validade Text Document expiring date.
docto_passcode Text Document PASSCODE.
docto_tipo Text Document Type.
docto_criacao Text Date of creation of the document in DD/MM/YYYY format.
docto_hash Text Hash.
docto_carimbo_tempo Text Indicates whether the document has a time stamp. Possible values ​​S=Yes, N=No.
partes Node Node for the definition of the parties to sign the document.
parte Text Node to define the party that will sign the document.
parte_papel_nome Text Name of the role represented by this company.
nomefantasia Text Company's fancy name
parte_empr_cnpj Text CNPJ of the company that will represent this role.
parte_empr_ordem Text Order of signing.
representantes Node Node to define the representatives of the parties who will sign or have access to the document. If this node does not exist all the representatives of the company will be associated.
representante Text Node to define the representative who will sign the document. If this node does not exist, no representative will be associated.
repr_cont_cpf Text Representative's CPF
repr_nome Text Representative's name
repr_cont_ordem Text Order of signing for this representative.
repr_assinou Text Indicates whether the representative has signed the document. Possible values:
S = signed;
N = did not sign the document.
data_assinatura Text Date the representative signed the document.
icp_brasil Text Indicates whether the certificate you have signed is standard ICP Brasil. Possible values:
S = ICP Brasil standard;
N = not ICP Brasil standard.
serial_certif Text Indicates the serial number of the certificate that made the signature.
IP_assinatura Text Indicates the IP of the station/device that signed it.
navegador_assinatura Text Indicates the data of the browser of the station/device that made the signature.
ind_SMS Text Indicates whether the accept was also made by entering SMS code. Possible values:
S = Accepted with SMS code
N = Did not accept with SMS code
forma_de_assinatura Text Indicates the form of signature. Possible values:
Digital Certificate = Signed with digital certificate
User + Password = Signed with user and password
User + Password +SMS = Signed with user, password and SMS
Biometry = Signed with user, password and SMS
Agreement = Signed with OK button
localizacao_assinatura Text Indicates the location where the signature was made (Only mobile devices with location enabled).
repr_aprovou Text Indicates whether the representative has approved the document. Possible values:
S = Approved;
N = Did not approve the document.
data_aprovacao Text Date the representative approved the document.
IP_aprovador Text Indicates the IP of the station/device that approved it.
navegador_aprovador Text Indicates the data of the browser of the station/device that made the approval.
localizacao_aprovador Text Indicates the location where the approval was made (Only mobile devices with location enabled).
Back to Get P7s file of the document Registration of the relationships and representatives