Pular para o conteúdo principal

Configurações do Signer

Configurações General​

Na seção General:

  • SiteUrl: URL publicamente acessível do site (ex.: https://signer.patorum.com/). Este endereço é usado para compor e-mails com links de volta para o site.

  • EncryptionKey: chave de criptografia.

  • EncryptionCertThumb: thumbprint do certificado da chave de criptografia.

  • RootPasswordHash: hash da senha de root, calculado acima.

  • AutoUpdateDatabase: por padrão, a aplicação tenta fazer as alterações de modelo no banco de dados após uma atualização (quando necessário). Defina como false se a aplicação não tiver permissões de proprietário sobre o banco de dados.

  • SupportEmailAddress: o endereço de e-mail de suporte (usado no rodapé dos e-mails enviados).

  • PersonalAccountsEnabled (obsoleta desde a v1.63.0): se true, qualquer usuário que entre ou se cadastre no site pode usar a aplicação e criar documentos na sua conta pessoal. Se false, os usuários só poderão usar a área logada se tiverem sido adicionados previamente a uma organização. Use as configurações de Access Control, pois esta opção está obsoleta.

  • AccessRequestEmailAddress (v1.38.0): o endereço de e-mail para o qual as solicitações de acesso são enviadas (se as contas pessoais não estiverem habilitadas). Se definido, quando um usuário vê a tela "Sem acesso", aparece um botão que permite a ele solicitar acesso ao sistema. O endereço de e-mail configurado recebe o nome e o e-mail do usuário que solicitou o acesso.

  • AllowCreateDocumentsByDefault (padrão: true, v1.12.0): se true, os usuários poderão criar documentos após se cadastrarem. Se false, o papel de criador de documentos deve ser concedido individualmente a cada usuário pelo administrador do sistema.

  • AllowCreateOrganizationsByDefault (padrão: true, v1.12.0): se true, os usuários poderão criar organizações após se cadastrarem (se as contas pessoais estiverem habilitadas).

  • EnableDocumentTypes (obsoleta desde a v1.7.0): se true, exibe uma seleção para definir o tipo de um documento ao criá-lo. Os tipos disponíveis são Deed e Power of Attorney. Use as configurações de DocumentTypes, pois esta opção está obsoleta.

  • OriginalFileWatermarkText: documentos do tipo Deed terão uma marca d'água com este texto na versão original até que o documento seja concluído.

  • EnableElectronicSignature (obsoleta desde a v1.1.0): se true, exibe a opção de aceitar assinaturas eletrônicas ao criar documentos. Use as configurações de ElectronicSignature, pois esta opção está obsoleta.

  • NotifyConclusion (v1.5.0): se true, envia um e-mail a todos os participantes de um documento quando ele é concluído.

  • NotifyParticipantsOnAddedVersion (v1.66.0): se true, envia um e-mail a todos os participantes ativos de um documento quando uma nova versão do documento é adicionada. Se não estiver habilitada, somente os observadores serão notificados.

  • NotifyParticipantsOnAttachmentUpdates (v1.66.0): se true, envia um e-mail a todos os participantes ativos de um documento quando anexos são adicionados ou excluídos. Se não estiver habilitada, somente os observadores serão notificados.

  • NotifyParticipantsOnDocumentInformationUpdates (v1.66.0): se true, envia um e-mail a todos os participantes ativos de um documento quando as informações do documento são atualizadas. Se não estiver habilitada, somente os observadores serão notificados.

  • AreActionsOrderedByDefault (v1.6.0): se true, as ações do fluxo do documento serão ordenadas por padrão, a menos que o usuário altere isso durante a criação do documento.

  • FlowActionTicketValidityMinutes: define a validade, em minutos, do ticket enviado no e-mail de lembrete de assinatura, que permite ao usuário assinar sem entrar no sistema. O valor padrão é 1440 (24 horas).

  • RestrictedUserAutocomplete (padrão: true): se true, as sugestões de preenchimento automático de participantes mostram apenas os usuários que estão nas mesmas organizações que o usuário atual e (a partir da v1.8.0) os que foram adicionados como participantes nos documentos do usuário atual. Se false, as sugestões buscam entre todos os usuários do banco de dados. Esta opção não afeta o preenchimento automático para os administradores do sistema.

  • EnableDocumentAuthentication: se true, exibe a opção de autenticação de documento na tela de assinatura rápida. Isso permite que o usuário autentique um documento inserindo uma representação visual personalizada com informações do seu registro de advogado ou de contador.

  • EnableBilling (obsoleta desde a v1.40.0): se true, habilita o módulo de cobrança. Use a opção nas configurações de Billing, pois esta opção está obsoleta.

  • EnableBillingInformationCheck (v1.19.0, obsoleta desde a v1.40.0): se true, habilita a verificação de que as informações de cobrança foram preenchidas sempre que uma transação paga é criada por um usuário ou por uma organização. Use a opção nas configurações de Billing, pois esta opção está obsoleta.

  • UseCustomStaticHomePage: se true, usa o arquivo estático index.html do theme-assets como página inicial. Após o login, os usuários sempre serão redirecionados para <SiteUrl>/private, já que a página inicial será estática. Você pode alterar a URL de redirecionamento com a configuração RedirectUri na seção de configuração do OIDC.

  • HidePoweredBy (v1.9.0): se true, oculta a seção "powered by" exibida na página inicial padrão.

  • EnableSignaturePositioning (padrão: true): se true, exibe a opção de pré-selecionar a posição da assinatura de um signatário ao criar documentos.

  • EnableSignatureMarksDownload: se true, permite que o usuário baixe a versão com marcas de assinatura de um documento.

  • EnableSigningTagsDownload (padrão: true, v1.5.0): se true, permite que o usuário baixe as signing tags de um documento.

  • EnablePrinterFriendlyDownload (padrão: true, v1.5.0): se true, permite que o usuário baixe a versão para impressão de um documento.

  • DocumentConcludedNotificationAttachmentType (padrão: PrinterFriendlyVersion, v1.35.0): define a versão do documento enviada como anexo quando o documento é concluído. Os valores disponíveis são: Original, PrinterFriendlyVersion, Signatures, OriginalWithMarks, SigningTags e SignatureMarks.

  • SendOriginalFileWithPendingActionEmail (v1.36.0): se true, envia a versão original do documento como anexo nas notificações de ação pendente.

  • SendPublicAttachmentFilesWithPendingActionEmail (v1.75.0): se true e SendOriginalFileWithPendingActionEmail também for true, adiciona os anexos do documento às notificações de ação pendente.

  • SendPublicAttachmentFilesWithDocumentConcludedEmail (v1.75.0): se true, adiciona os anexos do documento à notificação de documento concluído.

  • EmailAttachmentSizeLimit: o tamanho máximo de arquivo (em bytes) que pode ser anexado a um e-mail. O valor padrão é 10485760 (10 MB).

  • UserManualUrl: se definida, exibe (ao lado do menu do usuário) um botão para um PDF com o manual do usuário da aplicação.

  • SetPasswordEmailExpiration: a validade do link de definição de senha, em minutos. O valor padrão é 1440 (24 horas).

  • IdentifierType (padrão: Cpf, v1.7.0, obsoleta desde a v2.11.0): o tipo de identificador de usuário desta instância. As opções disponíveis são Cpf e EcuadorBceId. Use as configurações de IdentifierScope, pois esta opção está obsoleta.

  • FilterCertificatesByIdentifier (padrão: true, v1.7.0): se true, filtra automaticamente os certificados pelo identificador do usuário.

  • FilterCertificatesByKeyUsage (v1.7.0): se true, filtra os certificados que têm os atributos de não repúdio e de assinatura digital.

  • MaximumItemsInBatchNotifications (padrão: 10, v1.10.4): define o número máximo de itens incluídos nas notificações que listam um lote de itens (por exemplo, todos os documentos em que um usuário foi adicionado como observador).

  • UngroupedNotificationsDelayInSeconds (padrão: 180, v1.56.0): quando várias notificações precisam ser enviadas a um usuário sobre um ou mais documentos (se o tipo de destinatário não for e-mail), cada notificação é enviada com um intervalo crescente, em segundos, definido por esta configuração.

  • NormalizePdfs (padrão: true, v1.13.0): se true, o sistema tenta normalizar automaticamente os PDFs enviados para criar um documento, para evitar erros de arquivo protegido e de modo de anexação (append mode).

  • MaxUploadSizeInBytes (padrão: 106954752 - 100 MB, v1.15.0): define o tamanho máximo de upload, em bytes. Há um limite superior de 1 GB, que só pode ser alterado atualizando o arquivo web.config no pacote de instalação.

  • EnableDeletedDocumentValidation (v1.18.0): se true, o sistema valida documentos pelo código de validação mesmo que eles tenham sido excluídos pelos seus proprietários.

  • AllowSetFlowActionEmail (padrão: true, v1.20.0): se true, permite que um participante tenha um e-mail específico para o documento, ou seja, se um documento for enviado a um usuário mas o e-mail informado for diferente do cadastrado para esse usuário, o e-mail informado será o considerado nas notificações do(s) documento(s) enviado(s). Esta opção não tem efeito se o nome de usuário for o e-mail.

  • AllowSetFlowActionPhoneNumber (padrão: true, v1.28.0): se true, permite que um participante tenha um número de telefone específico para o documento, ou seja, se um documento for enviado a um usuário mas o telefone informado for diferente do cadastrado para esse usuário, o telefone informado será o considerado nas notificações do(s) documento(s) enviado(s).

  • CountryIdentifierMode (padrão: Unique, v1.21.0, obsoleta desde a v2.11.0): define o comportamento do identificador do país. Os tipos disponíveis são Unique, NonUnique, Nullable e NullableUnique. Use as configurações de IdentifierScope, pois esta opção está obsoleta.

  • SearchByIdentifierOnlyForUniqueIdentifierMode (v1.64.0): a partir da v1.64.0, ao buscar um novo usuário, verifica primeiro o identificador do país se o modo do identificador for Unique ou NullableUnique. Nas versões anteriores, isso só era feito para o modo Unique (defina como true para voltar a esse comportamento).

  • FilterCertificatesByEmailIfNoIdentifier (padrão: true, v1.21.0): se true, filtra pelo e-mail os certificados digitais de um usuário que não tem identificador.

  • UpdatedUserWithoutIdentifierAfterSignature (padrão: true, v1.21.0): se true, tenta adicionar um identificador a um usuário depois que ele assina um documento com sucesso com um certificado que tem identificador.

  • DefaultCurrency (padrão: R$, v1.22.0): define a moeda padrão da aplicação.

  • DocumentAcceptedMimeTypes (v1.22.0): define os mime types aceitos no upload de documentos. Os valores devem ser separados por vírgula. Defina como null se os tipos não devem ser restringidos.

  • HideMultipleDocumentNotificationViewDocumentsButton (v1.27.0): se true, o botão Ver documentos não é incluído nos e-mails de ação pendente de vários documentos. Isso garante que o e-mail contenha apenas links que não exigem que o usuário entre no sistema.

  • HideMultipleConcludedDocumentNotificationViewDocumentsButton (v1.45.0): se true, o botão Ver documentos não é incluído no e-mail de documentos concluídos de vários documentos. Isso garante que o e-mail contenha apenas links que não exigem que o usuário entre no sistema.

  • AllowAlgorithmNotAllowed (v1.31.0): se true, aceita documentos assinados com algoritmos considerados inseguros, como o SHA-1.

  • MaxNumberSignaturesToValidateAtOnce (padrão: 40, v1.31.0): define o número máximo de assinaturas que um documento pode ter para que todas sejam validadas de uma vez, em vez de em rodadas.

  • NumberSignaturesPerValidationRound (padrão: 10, v1.31.0): define o número de assinaturas validadas em cada rodada de validação, se o documento ultrapassar o número especificado na configuração MaxNumberSignaturesToValidateAtOnce.

  • MaxTotalOfSignaturesForRoundsValidation (padrão: 40, v1.43.0): define o número máximo de assinaturas retornadas ao fazer a validação em rodadas.

  • MaxEllapsedSecondsForRoundsValidation (padrão: 30, v1.43.0): define o número máximo de segundos que podem ser usados em todas as rodadas de validação. Se esse tempo for ultrapassado, a aplicação retorna todas as assinaturas validadas até o momento.

  • CanceledDocumentWatermarkText (v1.33.0): o texto da marca d'água adicionada aos documentos cancelados.

  • ExpiredDocumentWatermarkText (v1.33.0): o texto da marca d'água adicionada aos documentos expirados.

  • EnableEmailTemplateCustomization (v1.33.0): se true, permite substituir os templates de e-mail padrão. Os arquivos devem ser HTML e seguir o padrão Email-<template-type>.html.

  • HidePublicAreaMenuLinks (v1.34.0): se true, oculta os links de menu da área pública, como os links de validação de documento e de login.

  • MaskUserIdentifier (v1.35.0): se true, mascara os identificadores de usuário nas representações visuais de assinatura, no manifesto de assinaturas, na área pública e na maioria das telas que permitem aos usuários ver informações de outros usuários.

  • MaskUserEmailAddress (v1.47.0): se true, mascara os endereços de e-mail dos usuários no manifesto de assinaturas, na área pública e na maioria das telas que permitem aos usuários ver informações de outros usuários.

  • ReplyToDocumentCreator (v1.41.0): se true, adiciona o endereço de e-mail do criador do documento como endereço de resposta (reply-to) em todos os e-mails associados a esse documento.

  • FilterDocumentsByPendingForMe (v1.43.0): se true, o filtro "Mostrar documentos pendentes para mim" fica habilitado por padrão na página de documentos.

  • MaxItemsRetrievedInOrganizationFilter (padrão: 10, v1.43.0): define o número máximo de organizações exibidas no filtro de organização da página de documentos (e de outras páginas).

  • MaxItemsRetrievedInFolderFilter (padrão: 20, v1.43.0): define o número máximo de pastas exibidas no filtro de pastas da página de documentos (e de outras páginas).

  • FlowActionTitleDisplayedByDefault (v1.46.0): se true, exibe por padrão a caixa de título do participante.

  • UseOrganizationNameAsNotificationsSenderName (v1.47.0): se true, as notificações sobre documentos são enviadas com o nome da organização como nome do remetente.

  • ParticipantWelcomeMessageIntervalInMinutes (padrão: 0, v1.47.0): se positivo, define quantos minutos aguardar para enviar a notificação de boas-vindas ao participante depois que ele assinar um documento pela primeira vez (e ainda não tiver definido sua senha). Qualquer valor negativo desabilita esta notificação.

  • OrganizationUserWelcomeMessageDisabled (v1.58.3): se true, não envia a notificação de boas-vindas depois que um usuário é adicionado a uma organização.

  • HideParticipantsListAndOrderOfActionsForNonManagers (v1.50.0): oculta as informações dos participantes na página de detalhes do documento para todos os usuários, exceto os gestores ou administradores da organização do documento.

  • DisablePendingFlowActionsApi (v1.50.0): desabilita a API que retorna as informações dos participantes pendentes dos documentos. Com isso, os participantes pendentes não são exibidos na página de documentos.

  • DocumentExpirationTime (v1.54.0): define o horário de expiração dos documentos no formato timespan (HH:mm:ss). Por padrão (se não definido), considera-se como horário de expiração o fim do dia no fuso horário padrão configurado. Esta opção só deve ser usada se o fuso horário padrão for o Horário Padrão de Brasília (GMT-3).

  • ShortSiteName (v1.56.0): um nome curto para se referir à aplicação em mensagens com limite pequeno de caracteres (como mensagens SMS). Deve ser uma versão mais curta da configuração SiteName.

  • UpdateSubscriptionAccessTimeoutDelayInSeconds (v1.60.0, padrão: 60): tempo de espera para reagendar os jobs de atualização de acesso da subscription se já houver um job do mesmo tipo em execução. Se definido como 0, desabilita esse comportamento.

  • DisableOrganizationRenameByNonInstanceAdmin (v1.63.0): se true, os administradores de organização não poderão atualizar as informações da organização, como nome e identificador. Somente os administradores da instância poderão fazer essas alterações.

  • EnableSignatureValidationWhenGeneratingManifest (v1.63.0): se true, sempre que um manifesto de assinaturas for gerado, as assinaturas do documento assinado associado serão validadas. Fica desabilitada por padrão por causa do impacto no desempenho.

  • EnableSignaturesManifestDownloadInDocumentValidation (v1.67.0): se true, uma opção de download do manifesto de assinaturas é exibida na validação de documentos.

  • AllowUserInfoUpdateBySubscription (v.1.64.0): se true, os usuários criados ao criar um documento ou ao adicionar um usuário a uma subscription poderão ter suas informações atualizadas pelos administradores dessa subscription.

  • RequireFolderSelectionWhenCreatingDocuments (v.1.65.0): se true, os usuários são obrigados a selecionar uma pasta ao criar documentos.

  • AllowBasicAndOperatorUsersToManageContacts (padrão: false, v2.17.1): se true, os usuários com o papel Basic ou Operator em uma organização também podem criar, atualizar e excluir os contatos da organização. Por padrão, somente Admin e Manager podem gerenciar contatos.

  • MaxWebhooksPerOrganization (v1.65.0, padrão: 5): número máximo de webhooks que podem ser adicionados a uma organização.

  • DocumentConcludedWebhookDelayInSeconds (v1.66.0, padrão: 60): tempo de espera, em segundos, até que o webhook de documento concluído seja disparado.

  • EnableCustomizableTranslationFiles (v1.69.0): se true, habilita a personalização dos arquivos de tradução do frontend.

  • EnableCustomizableLocalizationResourceFiles (v1.69.0): se true, habilita a personalização dos arquivos de recursos de localização do backend.

  • AllowFlowActionRefusalToNotRefuseDocument (v1.70.0): se true, quando uma ação é recusada, o status do documento não é alterado para recusado (desde que ainda possa haver pelo menos uma ação concluída com sucesso).

  • MarksSessionExpirationInMinutes (v1.70.0, padrão: 60): a validade padrão, em minutos, de uma sessão de posicionamento de marcas.

  • MaxSignersPerDocument (v1.71.0, padrão: 30): o número máximo de signatários permitido por documento.

  • HideDownloadOptionForPendingDocuments (v1.76.0): se true, não exibe a opção de download para documentos pendentes. Esta configuração pode ser sobrescrita pelas configurações da organização.

  • EnableInitialStepForActionInPublicArea (v1.79.0): a partir da v1.79.0, as páginas públicas de assinatura e de aprovação exibem o documento diretamente ao usuário, sem a página inicial com os detalhes do documento. Se true, volta ao comportamento das versões anteriores.

  • DisableSwagger (v1.80.0): se true, desabilita o Swagger.

  • DisableLTV (v2.2.0): se true, desabilita o LTV nas assinaturas PAdES.

  • DisableRefuseSignature (v2.2.0): se true, desabilita a opção de recusar assinaturas na página de assinatura.

  • MaxItemsRetrievedInBillingPlanFilter (v2.3.0, padrão: 10): define o número máximo de itens retornados no filtro de planos de cobrança.

  • RemoveJsFromPdfs (v2.4.6, padrão: true): habilita a remoção automática de objetos Javascript dos PDFs, para aumentar a segurança.

  • EnableDocumentValidationInThePublicArea (v2.4.0, padrão: true): habilita a página e os endpoints de validação de documentos.

  • DisableNotifyParticipantsOnDocumentDeleted (v2.6.0, padrão: false): impede que notificações de documento excluído sejam geradas na instância.

  • PublicUploadEnabled (v2.6.0, padrão: true): exige que os usuários estejam autenticados para fazer uploads na plataforma.

  • PublicBatchSignatureEnabled (v2.7.0, padrão: false): se true, habilita a opção de assinatura em lote na área pública. Isso permite que os usuários assinem vários documentos de uma vez sem precisar entrar no sistema, usando um ticket enviado no e-mail de lembrete de assinatura.

  • IncludeQrCodeInEmailNotifications (v2.9.0, padrão: false): se true, inclui nas notificações por e-mail um QR code que leva ao documento na plataforma por meio do aplicativo WebPKI.

  • CleanupFailedHangfireJobsCommandTimeoutSeconds (padrão: 300, v2.21.0): timeout de comando, em segundos, de cada exclusão em lote feita pelo job de limpeza dos jobs do Hangfire que falharam. Essa limpeza é executada sobre o schema do Hangfire em uso e pode ter de aguardar brevemente por locks, por isso precisa de um prazo maior que o timeout padrão de requisição. Defina como zero ou menos para voltar ao timeout padrão.

Configurações Billing (v1.40.0)​

Na seção Billing:

  • Enabled: se true, habilita o módulo de cobrança.
  • EnableBillingInformationCheck: se true, habilita a verificação de que as informações de cobrança foram preenchidas sempre que uma transação paga é criada por um usuário ou por uma organização.
  • TrialPeriodDays: se maior que 0, habilita o período de avaliação de cobrança e define quantos dias ele dura. Durante o período de avaliação, todas as transações de uma organização são gratuitas (a data de criação da organização é considerada a data de início).
  • EnableBillingPlanHiring (v1.53.0): se true, os usuários poderão escolher e contratar planos de cobrança. Se habilitada, é preciso configurar um gateway de pagamento.
  • MaxNumberOfAvailablePlansDisplayed (padrão: 20, v1.53.0): o número máximo de planos de cobrança exibidos na página de contratação de planos.
  • AllowBasicUsersToViewOrganizationBillingInformation (v1.62.0): se true, os usuários básicos poderão ver as faturas e as informações de cobrança de uma organização.
  • BlockSubscriptionDeletionIfHasPaymentDebt (padrão: true, v1.78.0): se true, os administradores de organização não podem excluir uma subscription que tenha débitos de pagamento. O administrador da instância, no entanto, poderá excluí-la se necessário.
  • EnableInformationCheckForZeroValueInvoices (padrão: false, v2.22.0): quando EnableBillingInformationCheck também está habilitada, estende a exigência das informações de cobrança às faturas que ainda não acumularam valor cobrável (subscriptions em período de avaliação e subscriptions pré-pagas ainda sem cobrança lançada na fatura), em vez de aplicá-la somente quando o valor da fatura for maior que zero.

Configurações DocumentTypes (v1.7.0)​

Na seção DocumentTypes:

  • Enabled: se true, exibe uma seleção para definir o tipo de um documento ao criá-lo. Os tipos disponíveis são Deed (obsoleto desde a v1.33.0), Power of Attorney (obsoleto desde a v1.33.0) e Prescription.
  • EnabledOptions: lista, separada por vírgulas, dos tipos que serão habilitados/exibidos. A ordem dos tipos é respeitada na exibição. Exemplo: PowerOfAttorney,Deed,Prescription. Se esta configuração não for informada e os tipos de documento estiverem habilitados, todas as opções disponíveis serão exibidas.

Configurações SupportChat (v1.6.0)​

Na seção SupportChat:

  • Type: o provedor do chat de suporte. As opções disponíveis são Movidesk, Jivo ou Custom (v1.44.0).
  • Enabled: se true, habilita o chat de suporte do tipo selecionado.
  • Key: a chave da conta do chat de suporte.
  • ScriptUrl (v1.44.0): se o tipo for Custom, define a URL de onde o script do chat é carregado.

Configurações ElectronicSignature​

Na seção ElectronicSignature:

  • Enabled: se true, exibe a opção de aceitar assinaturas eletrônicas ao criar documentos.
  • EnableSmsAuthentication: se true, habilita a opção de verificação por SMS nas assinaturas eletrônicas. Para funcionar corretamente, é preciso configurar um provedor de SMS (veja SMS).
  • EnableWhatsappAuthentication (v1.56.0): se true, habilita a opção de verificação por Whatsapp nas assinaturas eletrônicas. Para funcionar corretamente, as configurações de Whatsapp devem estar definidas.
  • EnableOtpAuthentication: se true, habilita a opção de verificação por aplicativo de OTP nas assinaturas eletrônicas.
  • EnableSelfieAuthentication (v1.23.0): se true, habilita a captura de selfie nas assinaturas eletrônicas.
  • EnableDatavalidAuthentication (v1.32.0): se true, habilita a captura de selfie com validação pelo Datavalid nas assinaturas eletrônicas. Se habilitada, a configuração da seção Datavalid também deve ser definida.
  • EnablePixAuthentication (v1.32.0): se true, habilita a autenticação por Pix nas assinaturas eletrônicas. Se habilitada, a configuração da seção Gerencianet também deve ser definida.
  • EnableIdScanAuthentication (v1.77.0): se true, habilita a autenticação por leitura de documento de identidade (ID scan) nas assinaturas eletrônicas. Se habilitada, a configuração da seção RestPki também deve ser definida.
  • EnableElectronicSignatureOfTermsOfUse (padrão: true): se true, permite que os termos de uso sejam assinados eletronicamente.
  • IsAllowedByDefault: se true, a opção de permitir assinaturas eletrônicas vem selecionada por padrão.
  • IsRequired (v1.46.0): se true, o signatário não terá a opção de assinar com certificado digital.
  • IsGeolocationRequired (v1.5.0): se true, a geolocalização do usuário precisa ser enviada para que ele possa assinar eletronicamente.
  • Mode (padrão: Timestamp se houver um servidor de carimbo de tempo configurado, SelfSigned caso contrário, v1.8.0): o modo em que as assinaturas eletrônicas são feitas. Os modos disponíveis são SelfSigned e Timestamp:
    • SelfSigned: um certificado autoassinado é gerado uma vez e usado em todas as assinaturas eletrônicas da aplicação.
    • Timestamp: a assinatura eletrônica é adicionada ao documento como uma assinatura de carimbo de tempo. Requer que um servidor de carimbo de tempo (Timestamper) esteja configurado.
  • AdditionalInfoUrl (v1.9.0): URL para a qual o usuário é redirecionado ao clicar no ícone de informações de assinatura eletrônica na tela de criação de documento.
  • UseSignatureCertificateAsSelfSignedCertificate (v1.52.0): se true e um certificado de assinatura estiver habilitado, ele é usado no lugar do certificado autoassinado gerado automaticamente.
  • EnableLivenessAuthentication (v1.75.0 - somente para testes internos): se true, habilita a validação de prova de vida (liveness) nas autenticações por selfie e por Datavalid.
  • RequireLivenessOnSelfieAuthentication (v1.75.0): se true, exige que as autenticações por selfie tenham validação de prova de vida.
  • RequireLivenessOnDatavalidAuthentication (v1.75.0): se true, exige que as autenticações por Datavalid tenham validação de prova de vida.
  • HideEvidencesInPublicValidation (v1.75.1): se true, oculta as evidências do signatário eletrônico na página pública de validação de documentos.
  • HideSubjectNameInXadesSignatures (v1.76.0): se true, não adiciona o nome do titular (subject name) nas assinaturas XAdES.
  • DatabaseCommandTimeout (v1.76.0): define o timeout de comandos do banco de dados, em segundos.
  • MaxLivenessSessionsPerSignature (padrão: 5, v2.13.0): número máximo de sessões de prova de vida que podem ser criadas por tentativa de assinatura. Use -1 para ilimitado.
  • MaxIdScanSessionsPerSignature (padrão: 5, v2.13.0): número máximo de sessões de IdScan que podem ser criadas por tentativa de assinatura. Use -1 para ilimitado.

Configurações CloudSignatureSession (v2.19.0)​

Na seção CloudSignatureSession:

  • Enabled (padrão: false): se true, habilita a reutilização de sessões de assinatura em nuvem. Com ela habilitada, os usuários podem autorizar uma única autenticação para assinar vários documentos dentro de um período configurado, sem precisar informar o OTP repetidamente.
  • OrganizationAllowsSessionsByDefault (padrão: true): se true, a reutilização de sessões de assinatura em nuvem vem habilitada por padrão nas novas organizações. Cada organização pode alterar esta configuração individualmente.
  • DefaultSessionExpirationMinutes (padrão: 720): a duração padrão da sessão, em minutos. O valor máximo permitido é 10080 (7 dias). Qualquer valor configurado acima desse limite é reduzido ao máximo.
  • CheckboxCheckedByDefault (padrão: true): se true, a caixa de seleção "manter sessão ativa" vem marcada por padrão quando um usuário faz uma assinatura em nuvem, o que torna a reutilização de sessão opcional por exclusão (opt-out) em vez de por adesão (opt-in).

Configurações Signature Certificate (v1.52.0)​

Na seção SignatureCertificate:

  • BlobName: o nome do certificado PFX armazenado no Blob Storage configurado.
  • BlobFolder (padrão: certificates): a pasta onde o certificado fica armazenado no Blob Storage configurado.
  • Password: a senha do certificado PFX. Recomenda-se que o certificado tenha senha.

Configurações TrustServices (certificados em nuvem, v1.11.0)​

Na seção TrustServices:

  • Enabled: se true, exibe os provedores de certificados em nuvem sempre que uma assinatura for necessária. Só são exibidos os provedores que têm um certificado para o identificador do usuário. Se o usuário não tiver nenhum certificado nos provedores configurados, nada é exibido.

  • Opções de informações dos serviços (Services): cada serviço deve ser configurado individualmente, como mostrado abaixo. Os serviços disponíveis são: BirdID, SafeID, NeoID e VIDaaS:

    • <provider>:ClientId: o client id deste provedor.
    • <provider>:ClientSecret: o client secret deste provedor.
    • <provider>:Endpoint (opcional): só deve ser definido para provedores fora do padrão, como ambientes de homologação. Especifica o endpoint do serviço.
    • <provider>:BadgeUrl (opcional): só deve ser definido para provedores fora do padrão, como ambientes de homologação. Especifica a imagem do selo que será exibida ao usuário.
    • <provider>:Provider (opcional): só deve ser definido para provedores fora do padrão, como ambientes de homologação. Especifica o nome do provedor.
    • <provider>:ProtocolVariant (opcional): só deve ser definido para provedores fora do padrão, como ambientes de homologação. Especifica o nome da variante do protocolo.

  • DiscoveryEnabled (padrão: true, v1.48.1): se false, desabilita a descoberta de provedores de certificados em nuvem (exibe todos os provedores configurados para todos os usuários).

Configurações VisualRepresentation​

Na seção VisualRepresentation:

  • Enabled (padrão: true, v1.7.0): se true, todos os documentos PDF assinados com PAdES terão uma representação visual da assinatura, que pode ser posicionada automática ou manualmente.

  • SignatureWidthCentimetersOnA4: largura da representação visual da assinatura, em centímetros (otimizada para o tamanho de papel A4). O valor padrão, a partir da v1.37.0, é 5.85 (o valor anterior era 6).

  • SignatureHeightCentimetersOnA4: altura da representação visual da assinatura, em centímetros (otimizada para o tamanho de papel A4). O valor padrão, a partir da v1.37.0, é 1.45 (o valor anterior era 3.3).

  • SignatureInitialsWidthCentimetersOnA4: largura da representação visual da rubrica (usada ao aprovar um documento), em centímetros (otimizada para o tamanho de papel A4). O valor padrão é 1.5.

  • SignatureInitialsHeightCentimetersOnA4: altura da representação visual da rubrica (usada ao aprovar um documento), em centímetros (otimizada para o tamanho de papel A4). O valor padrão é 1.5.

  • AuthenticationStampWidthCentimetersOnA4: largura da representação visual do selo de autenticação, em centímetros (otimizada para o tamanho de papel A4). O valor padrão é 2.

  • AuthenticationStampHeightCentimetersOnA4: altura da representação visual do selo de autenticação, em centímetros (otimizada para o tamanho de papel A4). O valor padrão é 2.

  • AuthenticationSignatureWidthCentimetersOnA4: largura da representação visual da assinatura de autenticação, em centímetros (otimizada para o tamanho de papel A4). O valor padrão é 19.31.

  • AuthenticationSignatureHeightCentimetersOnA4: altura da representação visual da assinatura de autenticação, em centímetros (otimizada para o tamanho de papel A4). O valor padrão é 3.436.

  • DisableAutomaticSignaturePositioning (v1.18.0): se true, a representação visual da assinatura não é adicionada ao documento se o usuário não selecionar manualmente uma posição ao assinar.

  • SignaturePositioningRequired (v1.28.0): se true, exige que o usuário posicione a representação da assinatura ao assinar um arquivo PDF.

  • SignaturePositioningEnabledByDefault (v1.52.0): se true, a opção de pré-posicionar a assinatura vem selecionada por padrão na tela de criação de documento.

  • TextVerticalMarginMultiplier (padrão: 1.0, v1.37.0): define a margem vertical do texto multiplicando o número informado por 1% da altura da assinatura.

  • TextHorizontalMarginMultiplier (padrão: 1.0, v1.37.0): define a margem horizontal do texto multiplicando o número informado por 1% da largura da assinatura.

  • EnableSignaturePositionConfirmation (v1.62.0): se true, exibe um diálogo pedindo confirmação quando o usuário posiciona uma assinatura.

Configurações ValidationStamp (v1.7.0)​

Na seção ValidationStamp:

  • Enabled: se true, adiciona um carimbo a todos os documentos PDF depois do upload. O carimbo contém a informação de onde o documento foi criado e de onde suas assinaturas podem ser validadas. É uma opção recomendada se a representação visual estiver desabilitada.

  • AddSimplifiedManifest (v1.10.1): se true, adiciona um manifesto simplificado como última página do documento. Isso também impede que os fluxos dos documentos sejam editados, já que o manifesto só contém os participantes adicionados na criação do documento.

  • AllowCustomization (v1.63.0): se true, permite que as organizações personalizem o carimbo de validação.

  • ShowOnBottom: se true, exibe o carimbo de validação na parte inferior de todas as páginas.

  • ShowOnRight (padrão: true): se true, exibe o carimbo de validação à direita de todas as páginas.

  • HeightCentimeters: a altura do carimbo, em centímetros. O valor padrão é 0.5.

  • LeadingCentimeters: o deslocamento horizontal (ou vertical, se o carimbo estiver à direita), em centímetros, a partir do início da página. O valor padrão é 1.5.

  • TrailingCentimeters: o deslocamento horizontal (ou vertical, se o carimbo estiver à direita), em centímetros, a partir do fim da página. O valor padrão é 1.5.

  • MarginToPageCentimeters: a margem, em centímetros, em relação à parte inferior da página (ou ao lado direito, se o carimbo estiver à direita). O valor padrão é 0.3.

  • SummaryFontSize: o tamanho da fonte do carimbo, em pontos. O valor padrão é 8.

  • ShowLogo (v1.17.0): se true, exibe a logo no canto inferior direito de todas as páginas.

  • LogoWidthCentimeters (v1.17.0): largura da logo, em centímetros. O valor padrão é 1.

  • LogoHeightCentimeters (v1.17.0): altura da logo, em centímetros. O valor padrão é 1.

  • LogoMarginRightCentimeters (v1.17.0): a margem da logo, em centímetros, em relação à parte inferior da página. O valor padrão é 1.

  • LogoMarginBottomCentimeters (v1.17.0): a margem da logo, em centímetros, em relação ao lado direito da página. O valor padrão é 1.

  • EnableEditFlow (v1.17.0): se true, permite pequenas alterações no fluxo do documento após o envio, mesmo que AddSimplifiedManifest também seja true. As alterações permitidas são: adicionar ou remover observadores e atualizar os e-mails dos participantes (se permitido por outras configurações).

  • AllowOriginalFileDownload (v1.60.0, padrão: true): se true, baixa a versão original de um documento, sem nenhuma das marcas do carimbo de validação.

  • DisplayOriginalFileWhileDocumentNotConcluded (v1.60.0): se true, exibe o documento original na pré-visualização ou na assinatura de documentos (desde que eles não estejam concluídos). Para que esta opção funcione corretamente, AllowOriginalFileDownload também precisa estar habilitada.

Configurações PrinterFriendly​

Na seção PrinterFriendly:

  • ShowSummaryBottom (padrão: true): se true, exibe o resumo de assinaturas na parte inferior de todas as páginas.

  • ShowSummaryRight: se true, exibe o resumo de assinaturas à direita de todas as páginas.

  • SummaryHeightCentimeters: a altura do resumo, em centímetros. O valor padrão é 2.

  • SummaryLeadingCentimeters: o deslocamento horizontal (ou vertical, se o resumo estiver à direita), em centímetros, a partir do início da página. O valor padrão é 1.5.

  • SummaryTrailingCentimeters: o deslocamento horizontal (ou vertical, se o resumo estiver à direita), em centímetros, a partir do fim da página. O valor padrão é 3.5.

  • SummaryMarginToPageCentimeters (v1.6.0): a margem, em centímetros, em relação à parte inferior da página (ou ao lado direito, se o resumo estiver à direita). O valor padrão é 0.3.

  • SummaryFontSize (v1.6.0): o tamanho da fonte do resumo, em pontos. O valor padrão é 8.

  • ShowLogo (padrão: true): se true, exibe a logo no canto inferior direito de todas as páginas.

  • LogoWidthCentimeters: largura da logo, em centímetros. O valor padrão é 1.

  • LogoHeightCentimeters: altura da logo, em centímetros. O valor padrão é 1.

  • LogoMarginRightCentimeters: a margem da logo, em centímetros, em relação à parte inferior da página. O valor padrão é 1.

  • LogoMarginBottomCentimeters: a margem da logo, em centímetros, em relação ao lado direito da página. O valor padrão é 1.

  • ShowQrCode (padrão: true): se true, exibe um QR code que leva à tela de validação das assinaturas do documento.

  • ManifestPageMargin: margens da página do manifesto, em centímetros. O valor padrão é 2.5.

  • ManifestPageHeight: a altura da página do manifesto, em centímetros. O valor padrão é 29.7 (A4).

  • NormalFontSize: tamanho da fonte normal na página do manifesto, em pontos. Os tamanhos das fontes dos cabeçalhos são definidos com base neste tamanho. O valor padrão é 12.

  • SmallFontSize: tamanho da fonte pequena na página do manifesto, em pontos. O valor padrão é 10.

  • LineHeight: altura aproximada de uma fonte com o tamanho de fonte normal. O valor padrão é 0.74.

  • SmallLineHeight: altura aproximada de uma fonte com o tamanho de fonte pequeno. O valor padrão é 0.6.

  • AllowCustomization (v1.63.0, padrão: true): se true, permite que as organizações personalizem a versão para impressão.

  • IgnorePreExistingSignatures (v1.68.0, padrão: true): se true, não inclui (na versão para impressão) as assinaturas feitas antes da criação do documento (veja também a configuração PreExistingSignaturesDocumentCreationTresholdInSeconds). Isso é especialmente importante se os tipos de assinatura estiverem habilitados, pois as assinaturas existentes podem não corresponder ao tipo de assinatura selecionado quando o documento é enviado ao Signer. Se os tipos de assinatura estiverem habilitados e você quiser desabilitar esta configuração, considere habilitar também EnableSignatureValidationWhenGeneratingManifest.

  • PreExistingSignaturesDocumentCreationTresholdInSeconds (v1.68.1, padrão: 60): define um limite de quão antigas as assinaturas podem ser para ainda serem consideradas feitas após a criação do documento (definido em segundos a partir da data de criação do documento).

  • EvidenceImagesWatermarkText (v1.77.0): se true, adiciona marca d'água às imagens de evidência exibidas na versão para impressão.

  • ShowIdScanOnPrinterFriendlyVersion (v1.77.0): se true, exibe a leitura do documento de identidade (ID scan) na versão para impressão de uma assinatura eletrônica que exigiu essa autenticação.

  • AddWatermarkToSelfies (v1.77.0): se true, adiciona marca d'água às selfies exibidas na versão para impressão.

  • EnableSingleSignerSummary (v2.3.0): se true e o documento tiver apenas um signatário, o resumo exibe mais informações sobre o signatário.

  • EnableSingleSignerSummaryForMultipleSigners (v2.3.0): se true, ignora o número de signatários e exibe o resumo de signatário único mesmo que haja mais de um signatário.

  • SingleSignerDateFormat (v2.3.0): define o formato usado para exibir a assinatura no resumo de signatário único.

  • EmailAttachmentSignersLimit (padrão: 30, v2.14.0): número máximo de signatários em um fluxo acima do qual a versão para impressão deixa de ser anexada aos e-mails de notificação.

Configurações PaymentGateway (v1.27.0)​

Na seção PaymentGateway:

  • Enabled: se true, habilita a integração com o gateway de pagamento.
  • Gateway (padrão: Iugu): define o gateway de pagamento. O único valor disponível é Iugu (https://www.iugu.com/).
  • DueDays (padrão: 10): o número de dias que o usuário terá para pagar uma fatura.
  • InvoiceProductName (padrão: o mesmo valor da configuração SiteName): define o nome do produto que aparece no PDF da fatura.
  • MinInvoiceValue (padrão: 1): o valor mínimo de uma fatura. Todas as faturas com valor inferior a este são marcadas automaticamente como pagas depois de fechadas.
  • InvoiceDueDays (padrão: 1, v1.53.0): o número de dias após o fechamento da fatura usado para definir a data de vencimento da fatura. Isso controla quando são feitas as cobranças automáticas no cartão de crédito.
  • BillingPlanDueDays (padrão: 2, v1.53.0): o número de dias que o usuário terá para fazer o pagamento da contratação de um plano de cobrança.

Configurações Iugu (v1.27.0)​

Na seção Iugu:

  • AccountId: o ID da conta na Iugu.
  • ApiToken: o token de API da Iugu.
  • WebhooksAuthKey: a chave de autenticação de webhooks da Iugu.
  • TestMode: define se as credenciais são do ambiente de testes.
  • PaymentMethods (padrão: credit_card,bank_slip,pix, v1.37.0): lista dos meios de pagamento permitidos, separados por vírgula.

Configurações Invoice Receipt (v1.27.0)​

Na seção InvoiceReceipt:

  • Enabled: se true, habilita a emissão de notas fiscais para as faturas.
  • Gateway (padrão: NFEio): define o gateway de notas fiscais. O único valor disponível é NFEio (https://nfe.io/).
  • ReceiptType (padrão: NFSe): define o tipo de nota fiscal emitida. O único valor disponível é NFSe (nota fiscal de serviço).
  • CityServiceCode: o código do serviço no município em que ele será prestado. Acesse "Empresas > Lista de Serviços Cadastrados" na sua conta da NFEio para ver os códigos disponíveis para a sua empresa.
  • CnaeCode (opcional): o CNAE da sua empresa.
  • ReceiptDescription (padrão: o mesmo valor da configuração SiteName): uma descrição incluída na "Descrição do Serviço" da nota fiscal.

Configurações SMS​

Na seção SMS:

  • Type: define o provedor de SMS. As opções disponíveis são TotalVoice, Twilio, Zenvia (v1.28.0), SmsEmpresa (v1.28.0), Generic (v1.36.0), AmazonSNS (v1.55.0) e Tigo (v1.55.0).

Para o provedor TotalVoice, defina a configuração:

  • AccessToken:

Para o provedor Twilio, defina as configurações:

  • MessageFrom: o número usado para enviar a mensagem.
  • AccountSid: o SID da conta.
  • AuthToken: o Auth Token da conta.

Para o provedor Zenvia, defina as configurações:

  • Account (v1.28.0): a conta de API do Zenvia Connect.
  • Password (v1.28.0): a senha de API do Zenvia Connect.

Para o provedor SmsEmpresa, defina a configuração:

  • ChaveKey (v1.28.0): a "Chave Key" exibida nas configurações da sua conta da SMS Empresa.

Para o provedor Generic (v1.36.0), defina as configurações:

  • Endpoint: o endpoint para o qual as informações do SMS serão enviadas.
  • AuthType (padrão: NoAuth): define o tipo de autorização informado na requisição. As opções disponíveis são NoAuth, Basic, Bearer e ApiKey.
  • Username: o nome de usuário, se o AuthType for Basic.
  • Password: a senha, se o AuthType for Basic.
  • BearerToken: o token Bearer, se o AuthType for Bearer.
  • ApiKey: a chave de API, se o AuthType for ApiKey.

Para o provedor AmazonSNS (v1.55.0), defina as configurações:

  • Region: o código da região da AWS, por exemplo sa-east-1 ou us-east-1 (veja AWS region codes).
  • AccessKeyId: o ID da chave de acesso.
  • SecretAccessKey: a chave de acesso secreta.

Configurações Whatsapp (v1.56.0)​

Na seção Whatsapp:

  • Type (padrão: Meta, 1.78.0): define o serviço usado para enviar as mensagens de Whatsapp. As opções disponíveis são Meta e Zenvia (v1.78.0).
  • TemplateMapping (opcional): dicionário de nomes de templates. Só deve ser usado se você não quiser registrar o template no Meta Business Management com o nome que recomendamos. Exemplo:
Whatsapp__TemplateMapping__pendingsignature=signer_pendingsignature

Para o serviço Meta, defina as configurações:

  • Endpoint (padrão: https://graph.facebook.com): o endpoint para o qual as mensagens de Whatsapp serão enviadas. Só deve ser definido se você tiver uma instância on-premises do Whatsapp Business.
  • AccessToken: um token de acesso da API do Whatsapp Business.
  • PhoneNumberId: o ID do número de telefone que será usado para enviar as mensagens.

Para o serviço Zenvia (1.78.0), defina as configurações:

  • Endpoint (padrão: https://api.zenvia.com): o endpoint da Zenvia para o qual as mensagens de Whatsapp serão enviadas.
  • ApiToken: o token de API da Zenvia.
  • PhoneNumber: o número de telefone que será usado para enviar as mensagens.
  • LanguageTemplateMap (opcional): dicionário de nomes de template/idioma. Como a Zenvia usa GUIDs como nomes de templates e cada template tem um idioma fixo, use esta configuração para mapear templates/idiomas para os GUIDs da Zenvia. Exemplo:
Whatsapp__LanguageTemplateMap__pendingsignature-pt_BR=c5d3904f-3e22-49bc-a92b-37eeb6522c90
Whatsapp__LanguageTemplateMap__authenticationcode-pt_BR=8bc863e9-e661-43dc-ab29-016b0b990b86
  • EnableSendingRemindersViaLinkSharingOption (v2.3.0): se true, habilita o envio de lembretes diretamente pela API do WhatsApp.
  • MinimumWaitTimeBetweenRemindersInSeconds (v2.3.0, padrão: 300): tempo mínimo, em segundos, que deve ser aguardado entre as notificações de lembrete, para evitar spam.

Configurações NFEio (v1.27.0)​

Na seção NFEio:

  • ApiKey: a chave de API da NFEio.
  • CompanyId: o ID da empresa na NFEio a ser usado.
  • WebhookSecretKey: a chave secreta usada ao criar webhooks na NFEio.

Configurações Zoom (v1.29.0)​

Na seção Zoom:

  • Enabled: se true, habilita a integração com as videoconferências do Zoom.
  • JwtToken (obsoleta desde a v1.59.0): o token de autenticação JWT do Zoom. Use a autenticação Server to Server, definindo AccountId, ClientId e ClientSecret.
  • AccountId (v1.59.0): o ID da sua conta do Zoom. Obrigatório para a autenticação Server to Server.
  • ClientId (v1.59.0): o client ID do Zoom. Obrigatório para a autenticação Server to Server.
  • ClientSecret (v1.59.0): o client secret do Zoom. Obrigatório para a autenticação Server to Server.

Configurações Datavalid (v1.32.0)​

Na seção Datavalid:

  • Disabled: se true, desabilita o serviço Datavalid.
  • ConsumerKey: a consumer key do SERPRO para uso do serviço Datavalid.
  • ConsumerSecret: o consumer secret do SERPRO para uso do serviço Datavalid.
  • ApiVersion (v1.65.0, padrão: v3): versão da API a ser usada. Os valores disponíveis são v3 e v2.
  • UseFacialOnlyValidation (v1.65.0, padrão: true): se true, usa a API que valida apenas imagens faciais.

Configurações Gerencianet (v1.32.0)​

Na seção Gerencianet:

  • Disabled: se true, desabilita o serviço Gerencianet.
  • ClientId: o Client ID da API do serviço Gerencianet.
  • ClientSecret: o Client Secret da API do serviço Gerencianet.
  • PixKey: a chave Pix aleatória cadastrada na conta da Gerencianet.
  • CertificateBase64: o certificado de autenticação (no formato Base64) do serviço Gerencianet. Se você hospeda a aplicação em um Azure App Service, também precisa incluir a configuração WEBSITE_LOAD_USER_PROFILE com o valor 1. Se hospeda no IIS (Windows Server), defina a opção Carregar Perfil do Usuário da identidade do pool de aplicativos como True.

Configurações Batches (v1.30.0)​

Na seção Batches:

  • MaxDocumentsInBatch (padrão: 50000): o número máximo de documentos processados em um lote.
  • MaxItemsRetrievedFromDatabase (padrão: 10000): o número máximo de documentos retornados em uma única consulta ao banco de dados ao processar lotes. Em lotes de grande volume, isso é usado para evitar timeouts nas consultas ao banco de dados.
  • NumberDocumentsPerSignatureRound (padrão: 100): número de documentos processados em cada rodada de um lote de assinatura.
  • NumberDocumentsPerGenerationRound (padrão: 10): número de documentos processados em cada rodada de um lote de geração.
  • NumberNotificationsCreatedPerRound (padrão: 30): número de notificações criadas por rodada do lote.
  • NumberDocumentsPerExpirationRound (v1.33.0, padrão: 100): número de documentos processados por rodada de expiração.
  • NumberDocumentsPerDocumentsCreatedWebhookRound (v1.50.0, padrão: 100): número de documentos retornados em cada rodada ao gerar o webhook de documentos criados.
  • NotifyPendingActionsIndividually (v1.34.0): se true, envia os e-mails de ação pendente individualmente ao executar ações em lote.
  • NotifyParticipantsDefaultValue (v1.39.0, padrão: true): define o valor padrão da opção de notificar participantes exibida quando um usuário assina documentos em lote.
  • MaxAgeForOnGoingDocumentBatchesInDays (v1.80.1, padrão: 5): a idade máxima dos lotes de documentos em andamento retornados na página de documentos.
  • MaxOnGoingDocumentBatchesItemsRetrievedFromDatabase (v1.80.1, padrão: 10): o número máximo de lotes de documentos retornados na página de documentos.

Configurações Envelopes (v1.33.0)​

Na seção Envelopes:

  • MaxNumberFiles (padrão: 20): o número máximo de arquivos no envelope.

Configurações Custom Resources (v1.37.0)​

Na seção CustomResources:

  • Localizers: dicionário de localizadores personalizados. As chaves disponíveis são: MailFormatter e NotificationRepository.
    • Resources: dicionário de recursos a personalizar. A chave do dicionário é a chave do recurso.
      • en: o valor do recurso específico para inglês.
      • pt: o valor do recurso específico para português.
      • es: o valor do recurso específico para espanhol.
      • Default: o valor padrão do recurso, usado se o valor específico do idioma não for encontrado.

Exemplo:

CustomResources__Localizers__MailFormatter__Resources__SignDocument__Default=Sign Document

Configurações Reminder (v1.49.0)​

Na seção Reminder:

  • DefaultReminderPeriodInDays (padrão: 3): o número de dias a aguardar antes de enviar notificações de lembrete de ação para os documentos da organização. Se definido como 0, as notificações de lembrete não são enviadas.
  • MaxNumberOfNotificationsForReminder (padrão: 10): o número máximo de notificações enviadas para um lembrete.
  • MaxNumberOfRemindersPerScheduleJobRound (padrão: 100): o número máximo de lembretes processados em uma rodada do job agendado.

Configurações Push Notification (v1.54.0)​

Na seção PushNotification:

  • Disabled: se true, desabilita o envio de notificações push.
  • ApiKey: uma chave de API de uma subscription no portal de clientes da Lacuna com permissão para enviar notificações push para o aplicativo Web PKI.

Configurações Access Control (v1.63.0)​

Na seção AccessControl:

  • IsOpen: se true, qualquer usuário que entre ou se cadastre no site pode usar a aplicação e criar documentos na sua conta pessoal. Se false, os usuários só poderão usar a área logada se tiverem sido adicionados previamente a uma organização. Veja Controle de acesso para mais detalhes.
  • BlockPersonalAccounts: se true e o controle de acesso estiver aberto, os usuários podem usar a aplicação normalmente, mas precisam criar ou usar uma organização para executar ações.

Configurações Email (v1.66.0)​

Na seção Email:

  • EnableTracking (padrão: true): se true, os e-mails são rastreados, e as evidências de abertura e de cliques em links são registradas.
  • EnableUnsubscribe: se true, adiciona aos e-mails um link de descadastramento. Os endereços de e-mail que se descadastraram só voltam a receber notificações se forem retirados da lista de bloqueio pelo administrador da instância.

Configurações Signature Types (v1.68.0)​

Na seção SignatureTypes:

  • Enabled: se true, habilita a seleção de um tipo de assinatura ao criar e validar documentos.
  • DefaultType (padrão: Advanced): define a opção de tipo de assinatura padrão ao criar e validar documentos. As opções disponíveis são: Simple, Advanced ou Qualified.
  • Simple: subseção que define as configurações relativas ao tipo de assinatura Simple:
    • Disabled: se true, desabilita o tipo de assinatura Simple.
    • AllowAdvancedElectronicSignatures: se true, as assinaturas eletrônicas avançadas são validadas com sucesso ao validar um documento com o tipo de assinatura Simple.
    • TrustArbitrator (padrão: árbitro que aceita a ICP-Brasil): configurações de trust arbitrator específicas do tipo de assinatura Simple. Podem ser definidas como explicado em Configurações de Trust Arbitrator. Veja também TrustArbitrators dos tipos Simples e Qualificada.
    • Authentication: subseção que define os tipos de autenticação disponíveis para o tipo de assinatura Simple. Quando não definida, os tipos disponíveis são definidos pelas configurações de ElectronicSignature.
      • EnableSmsAuthentication
      • EnableWhatsappAuthentication
      • EnableOtpAuthentication
      • EnableSelfieAuthentication
      • EnableDatavalidAuthentication
      • EnablePixAuthentication
      • EnableLivenessAuthentication (v1.75.0)
      • EnableIdScanAuthentication (v1.77.0)
      • RequireLivenessOnSelfieAuthentication (v1.75.0)
      • RequireLivenessOnDatavalidAuthentication (v1.75.0)
  • Advanced: subseção que define as configurações relativas ao tipo de assinatura Advanced:
    • DisplaySecurityContextNames: se true, adiciona o nome do contexto de segurança da assinatura Advanced ao exibir o tipo de assinatura. Só deve ser definida se você tiver mais de um contexto de segurança.
    • AllowSimpleElectronicSignatures: se true, as assinaturas eletrônicas simples são validadas com sucesso ao validar um documento com o tipo de assinatura Advanced.
  • Qualified: subseção que define as configurações relativas ao tipo de assinatura Qualified:

Configurações Totals (v1.72.0)​

Na seção Totals:

  • HideDocumentPaginationTotalTreshold (padrão: 10000): limite para ocultar a contagem da lista de documentos.

  • HideDocumentPaginationTotal (padrão: true): se true, oculta o total ao listar documentos se o total ultrapassar o HideDocumentPaginationTotalTreshold.

  • HideOrganizationDocumentTotalsTreshold (padrão: 10000): limite para ocultar o total de documentos nos detalhes da organização.

  • HideOrganizationDocumentTotals: se true, oculta o total de documentos nos detalhes da organização se o total ultrapassar o HideOrganizationDocumentTotalsTreshold.

  • HideOrganizationDocumentPaginationTotalsTreshold (padrão: 10000): limite para ocultar a contagem da lista de documentos na administração da organização.

  • HideOrganizationDocumentPaginationTotals: se true, oculta o total ao listar documentos na administração da organização se o total ultrapassar o HideOrganizationDocumentPaginationTotalsTreshold.

  • HideEventPaginationTotalTreshold (padrão: 10000): limite para ocultar a contagem da lista de eventos.

  • HideEventPaginationTotal (padrão: true): se true, oculta o total ao listar eventos se o total ultrapassar o HideEventPaginationTotalTreshold.

Configurações Throttling​

Na seção Throttling:

  • EnableSensitiveDataLogging: se true, registra no log informações sensíveis sobre as requisições limitadas, como o endereço IP.
  • DocumentKeyThrottling: define os parâmetros de throttling das consultas por chave de documento. Veja Throttling Parameters abaixo. Vem habilitado por padrão, com limite 10 e intervalo 1.

Configurações Throttling Parameters​

Define as seguintes propriedades:

  • Enabled: se true, habilita este tipo de throttling.
  • IntervalInSeconds: o intervalo, em segundos, durante o qual as operações sujeitas a throttling são avaliadas.
  • Limit: o número máximo de operações que podem ser executadas antes que o throttling seja aplicado.

Configurações Trust Arbitrator​

dica

Para um passo a passo com exemplos, veja TrustArbitrator.

As configurações de trust arbitrator permitem definir quais certificados digitais são aceitos pela aplicação. Isso é feito definindo um JSON no seguinte formato:

{
  "Version": "2019-05-09",
  "TrustedRoots": [],
  "StandardPkis": []
}
  • Version: versão do formato. As opções disponíveis são 2019-05-09 ou 2022-07-21. A última também aceita a propriedade IntermediateCAs.
  • StandardPkis: lista de PKIs padrão. As opções disponíveis são Brazil, Italy, Peru, System, ENotariado e RegistroCivil. System aceita as raízes confiáveis do sistema operacional do servidor.
  • TrustedRoots: lista de certificados raiz no formato Base64.
  • IntermediateCAs (somente com a versão 2022-07-21): lista de certificados de ACs intermediárias no formato Base64. Útil quando os certificados dos signatários não trazem as informações necessárias para baixar as ACs intermediárias da cadeia. Esses certificados não são confiáveis por si só: a cadeia ainda precisa terminar em uma raiz aceita.

Na seção TrustArbitrator:

  • Type (padrão: árbitro que aceita a ICP-Brasil): define de onde o sistema obtém o JSON do trust arbitrator. As opções disponíveis são AppSetting ou BlobStorage.
  • Content: deve ser definida se AppSetting for selecionado. O conteúdo JSON do trust arbitrator. Se esta configuração for definida em um arquivo de configuração JSON, lembre-se de que as aspas duplas precisam ser escapadas. Exemplo: 
    "Content": "{ \"Version\": \"2019-05-09\", \"StandardPkis\": [ \"Brazil\" ] }"
  • BlobName: deve ser definida se BlobStorage for selecionado. O nome do arquivo com o conteúdo JSON do trust arbitrator armazenado no Blob Storage. Exemplo: "BlobName": "my-arbitrator.json".
  • BlobFolderName (padrão: trustarbitrators): a pasta do blob em que fica o arquivo com o conteúdo JSON do trust arbitrator armazenado no Blob Storage. Só é relevante se BlobStorage for selecionado.

Configurações Security Headers (v2.1.0)​

Na seção SecurityHeaders:

  • Default__Enabled: se true, habilita o uso de headers de segurança.

Configurações Terms Of Use (v2.3.0)​

Na seção TermsOfUse:

  • SendTermsOfUseUpdateOnlyToSubscriptionUsers: se true, restringe o envio das atualizações dos termos de uso aos usuários de subscriptions.
  • ProcessingDelayInMinutes (padrão: 20): define o intervalo, em minutos, a ser aguardado entre as notificações de termos de uso.
  • MaxItemsRetrievedFromDatabase (padrão: 10000): define o número máximo de usuários retornados do banco de dados para notificar sobre alterações nos termos de uso.

Configurações SigningTags​

Na seção SigningTags:

  • PageHeight:
  • PageWidth:
  • PageMarginTop:
  • PageMarginRight:
  • PageMarginBottom:
  • PageMarginLeft:

Configurações Amplia​

Na seção Amplia:

  • EndpointUrl:
  • ApiKey:
  • EnableAttributeCertificate:
  • KeyStore: o valor padrão é Database.

Configurações Hsm​

Na seção Hsm:

  • Enabled:
  • EnableLocalCA: se true, permite que os usuários emitam certificados de teste usando o serviço local do Amplia.
  • ImageUrl:
  • Name:
  • Type:
  • DinamoPocket: subseção:

Configurações DinamoPocket​

  • Address: subseção:
  • MasterUser: subseção:
  • MasterPassword: subseção:

Configurações Timestamper​

Na seção Timestamper:

  • Enabled: se true, carimbos de tempo serão adicionados às assinaturas.
  • Url: a URL do servidor de carimbo de tempo.
  • Type (padrão: BearerToken, v1.28.0): define o tipo de autenticação usado para conectar ao servidor de carimbo de tempo. As opções disponíveis são BearerToken, BasicAuthentication (obsoleto desde a v1.43.0) e BasicAuthenticationV2 (v1.43.0).
  • BearerToken: se o tipo for BearerToken, define o valor do token de portador para a autenticação.
  • Username (v1.28.0): se o tipo for BasicAuthentication ou BasicAuthenticationV2, define o nome de usuário para a autenticação.
  • Password (v1.28.0): se o tipo for BasicAuthentication ou BasicAuthenticationV2, define a senha para a autenticação.
  • MaxAutoRetryCount (padrão: 3, v1.30.0): o número de novas tentativas feitas se não for possível obter um carimbo de tempo na primeira tentativa.
  • RetryDelayInMilliseconds (padrão: 1500): o tempo de espera, em milissegundos, entre as novas tentativas de obter o carimbo de tempo.
  • Organization (v2.22.0): controla como os administradores de organização podem gerenciar a configuração de carimbo de tempo de cada organização:
    • EnabledByDefault (padrão: true, v2.22.0): o valor usado na configuração de carimbo de tempo de uma organização quando ela não tem um valor próprio definido explicitamente.
    • DisableSettingsByNonInstanceAdmin (padrão: false, v2.22.0): quando true, somente os administradores do sistema da instância podem alterar (ou redefinir) a configuração de carimbo de tempo de uma organização; a seção fica oculta para os administradores de organização, e qualquer tentativa de alterá-la pela API é rejeitada com 403 Forbidden.

Configurações Notarize​

Na seção Notarize:

  • Enabled:
  • Notaries: lista de subseções:

Configurações NotaryConfig​

  • Type: subseção:
  • ApplicationId: subseção:
  • NotaryApplicationKey: subseção:
  • EndpointUrl:
  • UploadApi:
  • StartNotarizationApi:

Configurações Authenticator​

Na seção Authenticator:

  • HashAlgorithm:
  • NumberOfDigits:
  • PeriodInSeconds:
  • TokenAuthTimeValidationEnabled:
  • TokenAuthTimeValidation:

Configurações Scanner​

Na seção Scanner:

  • Disabled: se true, desabilita a integração com o Scanner.
  • Endpoint: o endpoint do Scanner.
  • ApiKey: uma chave de API do Scanner. Para habilitar a validação de documentos de todas as subscriptions do Scanner, informe uma chave com privilégios de Root Admin e defina o parâmetro SubscriptionId.
  • SubscriptionId (opcional): só deve ser definida se a ApiKey for uma chave Root. Define a subscription à qual os documentos digitalizados serão associados.
  • InputType (padrão: 'Scan', v1.37.0): define as opções de entrada permitidas. As opções disponíveis são Scan, FileUpload e ScanOrFileUpload.
  • MetadataInputEnabled (padrão: true, v1.37.0): se true, o usuário que digitaliza precisará informar os metadados.
  • MetadataPresets (opcional, v1.37.0): subseção definida a seguir:
    • DocumentType: define o tipo de documento nos metadados, para que o usuário que digitaliza não precise informá-lo ao preencher os metadados.
    • DocumentTypeIsReadonly: se true, o usuário que digitaliza não poderá alterar o tipo de documento.

Configurações Google Tag Manager (v1.50.0)​

Na seção GoogleTagManager:

  • Id: o ID do Tag Manager. Deve ser informado para usar o Tag Manager.
  • Auth
  • Preview
  • ResourcePath
  • CspNonce

Configurações Document Access Validation (v2.7.0)​

Na seção DocumentAccessValidation:

  • Enabled: se true, a validação de acesso a documentos fica habilitada. Com ela habilitada, os usuários podem selecionar um tipo de validação ao criar um documento, e os usuários precisarão fazer a validação selecionada para acessar o documento na área pública de validação.
  • RequireForEveryDocumentAccess: se true, todos os documentos exigirão validação, mesmo que o criador do documento não tenha selecionado nenhum tipo de validação ao criá-lo ou que o documento tenha sido criado antes de esta configuração ser habilitada. Se false, só os documentos que tiveram um tipo de validação selecionado na criação exigirão validação.
  • DefaultValidationType (padrão: UserIdentifier): o tipo de validação usado para os documentos que não têm um tipo de validação selecionado explicitamente quando RequireForEveryDocumentAccess é true. No momento, a única opção disponível é UserIdentifier, que exige que o usuário informe o CPF de um signatário para acessar o documento, mas outros tipos de validação podem ser adicionados no futuro.

Configurações IdRC (v2.8.0)​

Estas configurações são para a integração com o serviço de assinatura do Registro Civil (IdRC). Na seção Idrc:

  • Enabled: se true, habilita a integração com o serviço de assinatura do Registro Civil (IdRC). Isso é necessário para permitir que os usuários usem o IdRC como opção nas raízes confiáveis do contexto de segurança.
  • Homologation: se true, habilita o modo de homologação (testes) da integração com o IdRC. Isso inclui as raízes dos certificados de homologação como raízes confiáveis quando o usuário adiciona o IdRC ao contexto de segurança.
  • IdrcServerBaseUrl: a URL base do servidor do IdRC a ser usado.
  • IdrcServerApiKey: a chave de API fornecida pelo IdRC.
  • IdrcServerClientSecret: o client secret acordado com o IdRC.
  • IdrcServerClientId: o client ID acordado com o IdRC.

Configurações IdentifierScope (v2.11.0)​

A partir da versão 2.11.0, é possível configurar uma instância para usar mais de um tipo de identificador. Ainda assim, é preciso ter um tipo de identificador principal, usado quando nenhum tipo é especificado, e definir o comportamento de unicidade de cada tipo de identificador. Essas configurações ficam na seção IdentifierScope.

Desde a versão 2.18.0, ao usar vários tipos de identificador, o modo de cada tipo é respeitado: um tipo cujo modo não seja Nullable ou NullableUnique é obrigatório sempre que esse tipo for selecionado para um usuário. Para exigir que um usuário tenha pelo menos um identificador de qualquer tipo permitido, use a configuração RequireAtLeastOneIdentifier.

Na seção IdentifierScope:

  • EnableMultipleIdentifiersPerUser: se true, permite que os usuários tenham mais de um identificador (ex.: CPF e um identificador paraguaio simultaneamente).
  • AllowedIdentifierTypes: lista, separada por vírgulas, dos tipos de identificador permitidos. Exemplo: Cpf,EcuadorBceId. Quando definida, só os tipos listados são aceitos. Tipos suportados: Cpf, EcuadorBceId, ParaguayCedulaIdentidad, ParaguayRuc e ParaguayPassport.
  • DefaultIdentifierType: o tipo de identificador padrão, usado quando nenhum tipo é especificado explicitamente. Substitui a configuração obsoleta General.IdentifierType. Deve ser um tipo de identificador válido incluído na configuração AllowedIdentifierTypes. Exemplo: Cpf.
  • IdentifierModes: lista, separada por vírgulas, de pares IdentifierType=Mode que definem o comportamento de unicidade de cada tipo de identificador. Substitui a configuração obsoleta General.CountryIdentifierMode. Os modos disponíveis são Unique, NonUnique, Nullable e NullableUnique. Exemplo: Cpf=Nullable,EcuadorBceId=NullableUnique. Se EnableMultipleIdentifiersPerUser for true, esta configuração deve ser definida para todos os tipos de identificador incluídos em AllowedIdentifierTypes. Desde a versão 2.18.0, tipos com modo não anulável são permitidos quando vários identificadores estão habilitados: o valor do identificador passa a ser obrigatório sempre que esse tipo for selecionado.
  • RequireAtLeastOneIdentifier (padrão: false, v2.18.0): se true, todo usuário precisa ter pelo menos um identificador de um tipo permitido, mesmo quando todos os modos de identificador são anuláveis. Identificadores de tipos que não estão mais listados em AllowedIdentifierTypes não atendem a essa regra. Só pode ser usada quando EnableMultipleIdentifiersPerUser é true; caso contrário, a aplicação não inicia.
  • DisableGrantIdIdentifierSync (v2.11.1, padrão: false): se true, desabilita a sincronização de identificadores com o GrantId. Isso é especialmente útil ao usar vários tipos de identificador, já que o GrantId só suporta um identificador por usuário.
  • DisableSyncIdentifiersJob (v2.13.2, padrão: false): se true, desabilita o job em segundo plano que sincroniza periodicamente os identificadores dos usuários. Útil quando o job de sincronização causa conflitos ou não é necessário na implantação.

Configurações Contacts (v2.12.0)​

Na seção Contacts:

  • Disabled (padrão: false): se true, desabilita completamente a funcionalidade de lista de contatos externos.

Configurações AdvancedSearch (v2.12.0)​

Na seção AdvancedSearch:

  • Disabled (padrão: false): se true, desabilita a funcionalidade de busca avançada de participantes.
  • AllowIncludeContacts (padrão: true): se false, remove a opção que permite aos usuários escolher se os contatos são incluídos nos resultados da busca.
  • DefaultIncludeContacts (padrão: true): define se os contatos são incluídos nos resultados da busca por padrão.
  • AllowIncludeExternalUsers (padrão: false): se true, exibe a opção que permite aos usuários escolher se os usuários externos são incluídos nos resultados da busca.
  • DefaultIncludeExternalUsers (padrão: false): define se os usuários externos são incluídos nos resultados da busca por padrão.

Configurações RestPki (v2.13.0)​

Na seção RestPki (antes FaceTec; o nome antigo da seção continua aceito por compatibilidade):

  • Endpoint: a URL do endpoint do serviço RestPki.
  • ApiKey: a chave de API do serviço RestPki.

Obrigatória quando EnableLivenessAuthentication ou EnableIdScanAuthentication está definida como true na seção ElectronicSignature.

Configurações Pdf (v2.14.0)​

Na seção Pdf:

  • PdfAConversionEnabled (padrão: false, v2.14.0): se true, habilita a conversão de documentos para PDF/A.
  • DefaultPdfAProfile (padrão: PdfA2b, v2.14.0): o perfil PDF/A padrão usado na conversão de documentos. As opções disponíveis são: PdfA1a, PdfA1b, PdfA2a, PdfA2b, PdfA3a e PdfA3b.
  • PdfService: subseção que define a conexão com o Lacuna PDF Service, usado para fazer a conversão para PDF/A. Obrigatória quando PdfAConversionEnabled é true:
    • Endpoint: a URL do endpoint do PDF Service.
    • ApiKey: a chave de API do PDF Service.

Configurações DocumentDownload (v2.16.1)​

Na seção DocumentDownload. Estas configurações ficavam antes na seção General, que agora está obsoleta para essas chaves; as chaves antigas de General continuam sendo respeitadas como alternativa quando a chave correspondente de DocumentDownload não está definida:

  • EnableSignatureMarksDownload (padrão: false): se true, permite que o usuário baixe a versão com marcas de assinatura de um documento.
  • EnableSigningTagsDownload (padrão: true): se true, permite que o usuário baixe a versão com signing tags de um documento.
  • EnablePrinterFriendlyDownload (padrão: true): se true, permite que o usuário baixe a versão para impressão de um documento.
  • EnableRefusedDocumentDownload (padrão: false, v2.16.1): se false, bloqueia o download de um documento depois que ele for recusado, impedindo que documentos recusados circulem como se fossem válidos e assinados. Defina como true para permitir o download de documentos recusados.
  • CanceledWatermarkText: o texto da marca d'água adicionada aos documentos cancelados no download.
  • ExpiredWatermarkText: o texto da marca d'água adicionada aos documentos expirados no download.
  • RefusedWatermarkText (v2.16.1): o texto da marca d'água adicionada aos documentos recusados no download.
Ver em Markdown