Abaixo está uma lista abrangente dos eventos da API REST v5.
| Tipo de evento | Descrição |
| CRIADO | Quando um contrato ou rascunho é criado |
| AGREEMENT_MODIFIED | Contrato modificado pelo remetente [modificar o documento durante o processo] |
| USER_ACK_AGREEMENT_MODIFIED | Quando o signatário reconhece a modificação antes de assinar |
| SIGNED | O contrato é assinado através de um processo de assinatura manuscrita |
| ESIGNED | Quando um contrato é assinado com uma assinatura eletrônica |
| DIGSIGNED | Quando um contrato é assinado com uma assinatura digital |
| APROVADO | Quando um contrato é aprovado |
| ACCEPTED | Quando um contrato é aceito |
| DELIVERED | Quando um contrato é entregue |
| FORM_FILLED | Quando um contrato é preenchido |
| OFFLINE_SYNC | Quando um contrato é assinado offline usando um dispositivo móvel |
| UPLOADED_BY_SENDER | Quando um contrato assinado é carregado pelo remetente usando um fluxo de trabalho de assinatura eletrônica |
| FAXED_BY_SENDER | Quando um contrato assinado é carregado pelo remetente usando um fluxo de trabalho de fax |
| SIGNATURE_REQUESTED | Quando um contrato é enviado a um destinatário para assinatura |
| APPROVAL_REQUESTED | Quando um contrato é enviado a um destinatário para aprovação |
| ACKNOWLEDGEMENT_REQUESTED | Quando um contrato é enviado a um destinatário para confirmação |
| FORM_FILLING_REQUESTED | Quando um contrato é enviado a um destinatário para preenchimento de formulário |
| ACCEPTANCE_REQUESTED | Quando um contrato é enviado a um destinatário para aceitação |
| RECALLED | Quando um contrato é cancelado pelo remetente |
| REJECTED | Quando um contrato é rejeitado por um destinatário |
| EXPIRED | Quando alguma data/hora de expiração personalizada é definida pelo remetente e o contrato ultrapassa essa data/hora |
| EXPIRED_AUTOMATICALLY | Quando um contrato expira automaticamente |
| COMPARTILHADO | Quando o contrato foi compartilhado por um participante |
| EMAIL_VIEWED | Quando um destinatário visualiza o email "Assine aqui" |
| EMAIL_BOUNCED | Quando um email é rejeitado pelo servidor de email do destinatário |
| AUTO_CANCELLED_CONVERSION_PROBLEM | Quando a conversão do contrato falha, fazendo com que o contrato seja cancelado automaticamente |
| PASSWORD_AUTHENTICATION_FAILED | Quando a autenticação por senha falha |
| KBA_AUTHENTICATION_FAILED | Quando a autenticação KBA falha |
| KBA_AUTHENTICATED | Quando a autenticação KBA é aprovada |
| WEB_IDENTITY_AUTHENTICATED | Quando a autenticação Web Identity é aprovada |
| WEB_IDENTITY_SPECIFIED | Quando a autenticação de identidade da web é solicitada |
| WIDGET_ENABLED | Quando um formulário web é habilitado de um status desabilitado |
| WIDGET_DISABLED | Quando um formulário web é desabilitado de um status habilitado |
| DELEGADO | Quando um contrato é delegado pelo destinatário |
| AUTO_DELEGATED | Quando um contrato é delegado devido à delegação automática |
| REPLACED_SIGNER | Quando um destinatário do contrato é substituído pelo remetente |
| VAULTED | Quando o contrato tem arquivamento habilitado e um callback é enviado para o cofre fornecido para realizar o arquivamento |
| DOCUMENTS_DELETED | Quando uma política de governança de dados é habilitada e os documentos de um contrato são excluídos |
| DRAFT_MODIFIED | Um contrato no status Rascunho foi modificado |
| ACCESS_CODE_GENERATED | Quando um código de acesso é gerado para conceder acesso à página de assinatura eletrônica para um destinatário. |
| ACCESS_CODE_CONSUMED | Cada vez que o signatário envia ACCESS_CODE_GENERATED, um evento ACCESS_CODE_CONSUMED é registrado. |
| ACTION_AUTO_DELEGATED | Veja AUTO_DELEGATED (prefixo "action" adicionado aqui para indicar que a mensagem deve ser baseada em função). |
| ACTION_COMPLETED | Este é o caso genérico que não atende às condições de nenhum dos casos especiais: ACTION_COMPLETED_OFFLINE_HOSTED, ACTION_COMPLETED_OFFLINE, ACTION_COMPLETED_HOSTED, ACTION_COMPLETED_WIDGET_VERIFIED_API_TOKEN, ACTION_COMPLETED_WIDGET_VERIFICATION_WAIVED, ACTION_COMPLETED_WIDGET_VERIFIED |
| ACTION_COMPLETED_HOSTED | Hospedado online |
| ACTION_COMPLETED_OFFLINE | Caso genérico de assinatura offline |
| ACTION_COMPLETED_OFFLINE_HOSTED | Assinado eletronicamente offline com um host de API |
| ACTION_COMPLETED_WIDGET_VERIFIED | Signatário concluiu a verificação normal de email. Apenas quando o signatário do formulário web é o primeiro participante.Signatários subsequentes acionam o evento ESIGNED. |
| ACTION_COMPLETED_WIDGET_VERIFIED_API_TOKEN | Isto é após um formulário web ser assinado eletronicamente e o usuário verificar sua assinatura via token de API |
| ACTION_COMPLETED_WIDGET_VERIFICATION_WAIVED | Isso acontece quando remetentes não exigem verificação de email para seus widgets |
| ACTION_DELEGATED | Veja DELEGATED, prefixo "action" adicionado aqui para indicar que a mensagem deve ser baseada em função. |
| ACTION_REPLACED_SIGNER | O signatário foi substituído pelo remetente. |
| ACTION_REQUESTED | Os antigos eventos específicos de função foram simplificados em um evento (ACKNOWLEDGMENT_REQUESTED, ACCEPTANCE_REQUESTED, APPROVAL_REQUESTED, FORM_FILLING_REQUESTED, SIGNATURE_REQUESTED).Isso foi feito porque não precisamos nem queremos eventos específicos de função.O cliente pode obter isso da participação, e isso aumentaria vastamente o número de variações de "COMPLETED" acima.Para corresponder a isso, esses eventos "...REQUESTED" foram simplificados para combinar. |
| CREATED_FROM_WIDGET | Quando um usuário usa um formulário web, o contrato é criado quando é assinado |
| CREATED_OFFLINE | Quando um contrato ou rascunho é criado offline |
| CREATED_VIA_UPLOAD | Consulte CREATED. Este é o recurso "entregar documento" no Acrobat/Reader.("Contrato enviado por") |
| CREATED_VIA_ACROBAT | Consulte CREATED. Este é o recurso "Enviar para assinatura" do Acrobat quando usado no Acrobat (página de envio incorporada). ("Contrato carregado do Acrobat por") |
| CREATED_VIA_READER | Consulte CREATED. Este é o recurso "Enviar para assinatura" do Reader quando usado no Acrobat (página de envio incorporada). ("Contrato carregado do Reader por") |
| ACTIVATED | O %s é ativado por |
| DIGITAL_SIGN_UIDAI_SIGNER_CONSENT | Evento de consentimento do usuário UIDAI |
| DEACTIVATED | O %s é desativado por |
| DOWNLOADED | Documento baixado por |
| FAXIN_RECEIVED | A assinatura enviada por fax foi recebida. |
| MODIFICADO | Contratos em estado de rascunho podem ter estes tipos de evento: CREATED, MODIFIED, CANCELLED, FINALIZED, DELETED, mas apenas CREATED e MODIFIED são retornados. FINALIZED é retornado como MODIFIED, e DELETED é suprimido. |
| OUTRO | No futuro, status diferentes dos mencionados acima podem ser adicionados ao aplicativo EchoSign. Por motivos de compatibilidade com versões anteriores, clientes de API existentes receberão o status OTHER. Talvez seja necessário atualizar seu aplicativo cliente para a versão mais recente da API para receber os novos status nesses casos. |
| PAGO | Pago por |
| PRESIGNED | O contrato foi assinado por |
| RECALLED_MAX_SIGNING_KBA_ATTEMPTS | Cancelado automaticamente devido a tentativas de KBA excedidas. Este costumava ser o evento "MAX_SIGNING_KBA_ATTEMPTS_EXCEEDED". |
| RECALLED_MAX_SIGNING_PASSWORD_ATTEMPTS | Cancelado automaticamente devido a tentativas de senha excedidas. Este costumava ser o evento "MAX_SIGNING_PASSWORD_ATTEMPTS_EXCEEDED". |
| RECALLED_MAX_SIGNING_PHONE_ATTEMPTS | Cancelado automaticamente devido ao excesso de tentativas de ligação.Este costumava ser o evento "MAX_SIGNING_PHONE_ATTEMPTS_EXCEEDED". |
| SENDER_CREATED_NEW_REVISION | Uma nova versão do documento foi criada. |
| SIGNING_URL_REQUESTED | A URL de assinatura foi solicitada por |
| READY_TO_VAULT | O contrato está pronto para ser armazenado no cofre |
| WRITTEN_DOWNLOAD | O contrato foi baixado para assinatura por |
| WRITTEN_SIGNED | O contrato foi assinado manualmente por |
Uma lista de status de contratos está abaixo:
Status |
Descrição |
OUT_FOR_SIGNATURE |
Quando o contrato é enviado para assinatura |
ASSINADO |
Quando um contrato é assinado |
APROVADO |
Quando um contrato é aprovado |
ABORTED |
Contrato cancelado ou excluído |
EXPIRADO |
Quando um contrato expira |
ARQUIVADO |
Quando um contrato é arquivado |
PREFILL |
Quando um contrato está no estado de preenchimento prévio e o remetente precisa preencher alguns campos |
AUTHORING |
Quando um contrato está no estado de criação |
WAITING_FOR_VERIFICATION |
Quando um contrato é criado a partir de um formulário web e o signatário do formulário web ainda não verificou o email |
OUT_FOR_APPROVAL |
Quando um contrato está aguardando aprovação |
DELIVERED |
Quando um acordo é confirmado por um destinatário certificado |
ACCEPTED |
Quando um contrato é aceito por um aceitador |
FORM_FILLED |
Quando um contrato é preenchido por um preenchedor de formulário |
OUT_FOR_DELIVERY |
Quando um contrato está aguardando confirmação |
OUT_FOR_ACCEPTANCE |
Quando um contrato está aguardando aceitação |
OUT_FOR_FORM_FILLING |
Quando um acordo está aguardando preenchimento de formulário |