- Page Content
- Introduction
- Input format
- Output format
Name: AutoCadastroDOCUMENTO
This function has the purpose of inclusion of documents, such as electronic contracts or reports. In addition, it is also possible to perform:
-
The registration of parties (Relationships that can be companies Corporate or Individual), if they are not already registered in the QualiSign Portal.
- As an individual is auto-represented on the QualiSign Portal it is important that the details of the party (Relationship) and the details of the representative are filled in with the person's CPF so that the registration/association is successful. If the individual also has an attorney, a second representative can be registered/associated through the TAG <representante> as already occurs when the party comes from a Legal Entity.
- The automatic registration of representatives, which takes place in two ways:
– If the nodes for new representatives are filled;
– If the company is integrated with the proxy system and in this case, the representative's Logon_id is the representative's own CPF.
Input format:
<?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="" >
<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>
<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>
| Parameter | Format | Required | Description |
|---|---|---|---|
| sessao | Text | Y | Registered access key for your company. |
| documentos | Text | Y | Node for defining documents to be inserted. |
| documento | Text | Y | Node to define the document to be inserted. |
| DOCUMENT-BASE-64 | Text | Y | Text of the document in BASE64. |
| docto_nome_arquivo | Text | Y | Name of the document being registered, including its extension. |
| docto_referencia | Text | Y | Document reference. |
| docto_dtinicio | Text | Y | Start date of the document validation in format DD/MM/YYYY. |
| docto_dtfim | Text | Y | End date of the document validation in format DD/MM/YYYY. |
| docto_fl_validade | Text | Y | Indicates whether the document does not have an expiration date set (undefined [indeterminada]). Possible values are S (for indeterminate validity) or N (for determined validity). |
| docto_cod_tipodoc | Text | Y | Code or document type name (See Document type code contained in this documentation) |
| docto_cod_moeda | Numeric | Y | Currency type code (See Currency Codes in this documentation). If the customer uses the setting "The number of signatures required to terminate the collection of a Party is defined in each Relationship" ("A quantidade de assinaturas necessárias para encerrar a coleta de uma Parte é definida em cada Relacionamento"), the currency code entered must always be 1 (REAL) because the QualiSign Portal does not carry out currency conversion when checking a representative's level boundaries. |
| valor | Text | N | Document's value. If the "The number of signatures required to terminate collection of a Party is defined in each Relationship" ("A quantidade de assinaturas necessárias para encerrar a coleta de uma Parte é definida em cada Relacionamento") setting is enabled for the relationship, the value to be reported should always be in REAIS. |
| docto_area | Text | N | Area responsible for the document. |
| docto_observacao | Text | N | Document comments. | docto_centro_custo | Text | N | Document cost center. |
| id_parceiro | Text | N | Partner Identifier. If you are a partner of the Portal enter your ID. |
| docto_sistema_codigo | Numeric | N | Type of QualiSign Portal's product: (if not informed, assumes 5) 5 – Electronic Contract. 10 – Digital Report. |
| docto_objetivo | Text | N | Document's purpose. |
| política_assinatura | Text | Y | Node to set document signing policy. |
| docto_fl_bacen | Text | Y | Indicates the following BACEN policy for the digital signature. Possible values: S (Yes) or N (No) |
| docto_fl_ass_digital | Text | Y | Indicates whether the document will be digitally signed. Possible values: S (Yes) or N (No) |
| docto_fl_grava_docto | Text | Y | Indicates whether the PKCS7 package will contain the document. Possible values: S (Yes) or N (No) |
| docto_fl_car_tempo | Text | Y | Indicates whether to insert a time stamp on all signatures. Possible values: S (Yes) or N (No) |
| docto_fl_ass_chancela | Text | Y | Indicates the document signing format. Possible values: N – Indicates de CADES format, the Portal's default. This is the default format if the tag is not informed. S – Indicates de PADES format. |
| docto_dependencia_aprov | Numeric | N | Approval dependency type. The possible values are: 1 – when this contract DOES NOT have pendency to start the collection of signatures (default value); 2 – when this contract HAVE pendency to start the collection of signatures; 3 – when this contract is a pendency for another contract. |
| docto_Ref_Pendencia | Text | N | Reference of the contract previously registered in the QualiSign Portal with the type of dependency of the approval equal to 2, when this contract has pendency to start the collection of signature, which in turn will be associated with the contract in question. This parameter can only be sent if the TAG docto_dependencia_aprov is assigned a value of 3 (this contract is a pendency for another contract). |
| seguranca_documento | Text | Y | Node to set document security. |
| docto_cod_tipo_acesso | Numeric | Y | Document access type code. Possible values are 1 (public) or 0 (private). |
| partes | Text | Y | Node to define the parties that should sign/access the document. |
| parte | Text | Y | Node to define the part that will sign or have access to the document. |
| parte_papel_nome | Text | Y | Name of the role represented by this company. Put the description of the role registered in the portal See Document type code to see the list of roles associated with each document type. |
| parte_empr_cnpj | Text | Y | CNPJ of the company that will represent this role. Complete the CNPJ without formatting. |
| parte_empr_ordem | Numeric | Y | Order of signing. |
| parte_acao | Text | N | Indicates the action for the paper. A - Sign or D - Accept Note: If this attribute is not fulfilled, it is assumed that the representative will sign. |
| detalheParte | Text | N | Node with details for inclusion or change of a party (client) Note: To register an Individual Party, it is necessary to complement information with the DetailRepr node |
| razao | Text | Y | Company name of the party |
| nomefantasia | Text | Y | Fancy name of the party |
| qtdeass | Numeric | Y | The minimum number of signatures required to consider that the signatures of the party have been completed. If you do not use concept of minimum quantity of signatures inform zero. |
| PerfilDefault | String | Y | Profile Name or Profile Code that should be used as the default for a representative's registration. (See Access Profiles). |
| representantes | Text | N | 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 | N | 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 | Y | Representative's CPF. Fill in without formatting. |
| repr_cont_ordem | Numeric | Y | Order of signing for this representative. |
| repr_somente_acomp | Text | Y | Sets the type of link to the document. In the case of follow up, you will receive all emails sent during the signature capture process S – only follow up N – Sign WITH digital certificate and follow up X – Sign WITH certificate, receive notification to sign/approve/accept, but does not receive signature completion email D – Sign WITHOUT digital certificate and follow up |
| repr_aprova | Text | N | Defines whether the delegate is an APPROVER for the document. S – Representative must approve N – Does not require the approval of this representative. |
| detalheRepr | Text | N | Node with details for inclusion or change of a representative |
| nome | Text | Y | Representantive's name. |
| idlogon | Text | Y | User ID to log in to the portal |
| Text | Y | Representative's e-mail. | |
| ddi_celular | Numeric | N | Country Calling Code of representative's cell phone number. If not informed, the assumed code will be 55 (Brazil). It can contain up to 4 digits. |
| celular | Numeric | N | Representative's cell phone number. Must contain prefix and cell number. If informed, the field must be at least 10 characters. Eg.: 1198543210 (if it does not contain ninth digit), 12998543210 (if it contains the ninth digit), etc ... |
| perfil | String | N | Profile Name or Profile Code to be associated (See Access Profiles). |
| DataVencMandato | Text | N | Expiring date of the representative's mandate in DD / MM / YYYY format. |
| DataVencInd | Text | N | Defines whether the representative's mandate is UNDEFINED. Possible values are S (to define indeterminate mandate) or N (to define a mandate with expiring date determined, expressed by the DataVencMandat argument. |
| AssinaIsoladamente | Text | N | Indicates whether it is signed alone (S-Yes, N-No). This information is relevant only if the "The number of signatures required to finish collection of a Party is set in each Relationship" setting is enabled for the relationship. |
| LimiteIsoladamente | Text | N | Inform value of the limit in REAIS. In case AssinaIsoladamente is equal to S and the limit of this representative is INDETERMINED, enter 0 (zero) for LimiteIsoladamente. In case AssinaIsoladamente is equal to N, enter in the TAG LimiteIsoladamente the value 0 (zero) or not inform the TAG. It is worth remembering that the obligation to define limits of a representative in the REAL currency occurs due to the QualiSign Portal does not carry out currency conversion when checking the levels in relation to the value of a document. Therefore, the value of the registered document must also always be in REAIS to use the automatic validation of powers by the portal. |
| Assinaconjuntamente | Text | N | Indicates whether to sign together (S-Yes, N-No). This information is relevant only if the "The number of signatures required to terminate collection of a Party set in each Relationship" setting is enabled for the relationship. |
| Limiteconjuntamente | Text | N | Inform value of the limit in REAIS. If Assinaconjuntamente is equal to S and the limit of this representative is INDETERMINED, enter 0 (zero) for Limiteconjuntamente. If Assinaconjuntamente is equal to N, enter in the TAG Limiteconjuntamente the value 0 (zero) or do not inform the TAG. It is worth remembering that the obligation to define limits of a representative in the REAL currency occurs due to the QualiSign Portal does not carry out currency conversion when checking competence in relation to the value of a document. Therefore, the value of the registered document must also always be in REAIS to use the automatic validation of powers by the portal. |
Output format:
<?xml version="1.0" encoding="ISO-8859-1" ?>
<documentoeletronico>
<CodErro />
<MsgErro />
<Passcode />
</documentoeletronico>
| Parameter | Format | Description |
|---|---|---|
| CodErro | Numeric | Error code (See Error Codes). |
| MsgErro | Text | Error message. |
| Passcode | Text | Document passcode. |