Para: Administradores
Envie assinaturas eletrônicas e leia assinaturas com uma chave central.
Crie uma solicitação de assinatura eletrônica para um caso a partir de um modelo, escolha quem assina cada campo, publique-a para assinatura e baixe a cópia bloqueada assim que todos tiverem assinado.
Neste artigo9 seções
Antes de começar
Esta página aborda o envio de e-signaturesAssinatura eletrônica Um documento enviado para assinatura eletrônica, assinado no navegador. e o uso de uma chave de hub para autenticar essas assinaturas. Os caminhos relacionados a isso estão indicados em https://prd-api-app.caseactive.com/v1/<hub id>/<case id>.
Chamadas
| Chamar | O que faz |
|---|---|
GET /signs/templates | Lista dos seus modelos de assinatura eletrônica |
POST /signs | Cria um documento eletrônico sobre o caso, que ainda não foi publicado. |
PUT /signs/<sign_id>/schema | Escolhe quem assinar cada campo. |
PUT /signs/<sign_id> | Muda o nome, a data de publicação ou os lembretes antes da publicação. |
PUT /signs/<sign_id>/publish | Publica-o, e assim o envia para os seus signatários. |
GET /signs?filter=all | Lista dos documentos eletrônicos relacionados ao caso. |
GET /signs/<sign_id> | Lê um documento eletrônico, com seu status correspondente. |
DELETE /signs/<sign_id> | Apague-o, junto com as suas assinaturas. |
GET /signs/<sign_id>/responses | Lista as suas assinaturas. |
GET /signs/<sign_id>/responses/<response_id> | Lê uma assinatura |
Um documento eletrônico é enviado em etapas: primeiro, é criado; depois, verifica-se quem assina cada campo do documento; finalmente, o documento é publicado. Até que seja publicado, os signatários não têm acesso ao documento, e ninguém fica sabendo disso. Uma vez publicado, nada pode ser alterado a respeito do documento.
Criando uma assinatura eletrônica
GET /signs/templates Lista os seus documentos eletrônicos publicados. Modelos/FormuláriosModelo Um formulário, postagem, assinatura eletrônica, nota ou tarefa reutilizável, armazenado na Biblioteca e copiado para as pastas., Os mais antigos primeiro, sendo cada um deles… asset_id, title, description, due_mins (Quantos minutos após o envio do documento, ele estará pronto para ser entregue?) notifications, E… role_field_participants, Os papéis que assinam cada campo.
POST /signs aceita os seguintes valores:
| Campo | O que faz | Obrigatório | Padrão |
|---|---|---|---|
name | O título do documento eletrônico. Letras, números, espaços e & ' - _ ( ) . /; sem vírgulas ou hífenes. | Sim | — |
duration | {"due_date": "2026-10-09T17:00:00-04:00"}, com o deslocamento de fuso horário correspondente. Os documentos eletrônicos não podem ser repetidos: uma regra de repetição é proibida. | Sim | — |
template | {"owner": "host", "template_id": "<asset_id>"} Para usar o documento e os signatários de um modelo. | Não | Nenhum |
description | Uma nota apresentada em formato e-sign | Não | O modelo utilizado… |
notifications | Lembrâncias: {"names": ["days"], "values": [-1440]}. Cada valor indica o número de minutos restantes até a data de vencimento. | Não | O modelo, ou nada. |
instant_notify | false Não enviar nenhum pedido durante o processo de publicação. Apenas os lembretes serão enviados. | Não | O modelo, ou true |
curl -X POST https://prd-api-app.caseactive.com/v1/ca-7e6d5c4b3a2f10/cc-1a2b3c4d5e6f70/signs \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"name": "Retainer Agreement", "duration": {"due_date": "2026-10-09T17:00:00-04:00"}, "template": {"owner": "host", "template_id": "sign::20260915101500_7a6b5c4d3e2f10"}}'
Isso responde a 201 com sign_id. O documento do modelo é copiado em segundo plano: leia o arquivo e-sigilo até que não haja mais copying.
Para enviar o seu próprio PDF, crie a assinatura eletrônica sem o elemento template. Carregue o PDF como documento e aguarde até que este esteja pronto. Depois, atribua os campos apropriados ao documento. Veja Carregar e anexar arquivos com uma chave de hub.
Escolher quem assina
A partir de um modelo, cada campo é atribuído às pessoas envolvidas no caso, que detêm as funções relacionadas a esse campo, quando o documento e-sigmo é criado. Portanto, coloque o cliente no caso primeiro. O field_participants do e-sigmo mostra o resultado: o nome de cada campo, juntamente com os IDs dos usuários que assinam o documento.
Para alterá-lo, envie toda a mapa para PUT /signs/<sign_id>/schema:
{"field_participants": {"Client Signature": ["cu-4f1c2a9e8b7d60"], "Attorney Signature": ["cu-9d8c7b6a5f4e30"]}}
- Todo ID deve corresponder a alguém que esteja envolvido no caso. O Assistente Virtual não pode assinar os documentos necessários.
- Os nomes dos campos são aqueles que estão presentes no documento.
- O mapa substitui o antigo: um campo que é deixado sem nenhum sinal não possui nenhum signatário.
Publicação
PUT /signs/<sign_id>/publish não aceita nenhum corpo e responde 200. Pelo menos um campo deve ter um “signatário”; um campo sem nenhum “signatário” permanece vazio.
- Cada signatário recebe um e-mail com o pedido de assinatura. Caso não tenha e-mail confirmado, também é enviado um mensagem de texto. Isso acontece imediatamente, a menos que…
instant_notifyÉfalse. Ele aparece nelas. O que precisa ser feitoFaçam A lista em uma maleta contém coisas que você precisa fazer, como formulários para preencher, documentos para assinar ou eventos para confirmar. E também nas notificações do seu portal. - Os lembretes são enviados a cada vez em
notifications, até que as pessoas assinem o documento. - Alguém que está longe do caso para de segurar o objeto em suas mãos.
Após as assinaturas
O documento eletrônico status Lê completed Assim que todos assinarem, e… completed_on Diz-se quando, no fuso horário UTC… 2026-10-06T21:42:10.123456+00:00. Até agora, não tem nada disso. responses Cada signatário que assinou o documento recebe um mapa correspondente a ele. response_id.
GET /signs/<sign_id>/responses A lista contém a assinatura de cada signatário, com o mais antigo em primeiro lugar. Tudo isso está organizado em uma única página. Cada assinatura está listada separadamente. user_id, Quando eles assinaram, foram preenchidos os campos que eles indicaram. response.formFieldValues, assinaram abaixo response.annotations, Com qualquer imagem de assinatura abaixo. response.attachments, E o endereço IP do qual eles assinaram o contrato. response.ip.
A equipe responsável pelo caso é informada, a cada vez que alguém assina o documento. Além disso, quando a cópia assinada está pronta, eles também são informados sobre isso. Toda pessoa que assina o documento é informada também quando a cópia assinada estiver pronta.
A cópia bloqueada
Assim que todos assinarem, será criada uma cópia do documento, com todas as assinaturas. A entrada do documento sob media.schemas.items recebe o valor flat, e o caminho da cópia é definido como flat_status, SUCCEEDED ou FAILED. Você pode baixar esse arquivo como qualquer outro arquivo; consulte Carregar e anexar arquivos com a chave do hub.
Listar e excluir
GET /signs precisa de filter: all lista todos os e-signs no caso, incluindo aqueles que ainda não foram publicados. Os mais recentes são listados primeiro. self lista aqueles enviados pelo Assistente Virtual, seja por meio de qualquer uma das suas chaves ou por meio de automações. completed e uncompleted listam os e-signs enviados pelo próprio chamador. Portanto, essas colunas ficam sempre vazias para uma determinada chave. Em vez disso, verifique as colunas status e completed_on de cada e-sign.
DELETE /signs/<sign_id> pode excluir qualquer assinatura eletrônica a qualquer momento, removendo-a de todas as listas de tarefas dos usuários. Ninguém é informado sobre isso.
Se uma chamada for recusada
| Status | message | Por que |
|---|---|---|
| 400 | SchemaFieldsException | O campo está ausente ou inválido. Isso pode acontecer por causa de uma vírgula em name, uma regra de repetição, ou porque o signatário não está na lista de participantes do caso. errors indica o nome do campo em questão. |
| 400 | SchemaFieldsException, com ItemCopyNotAllowedException em template | O modelo não foi publicado, não está disponível para o papel dos bots, ou seus arquivos ainda estão sendo processados. |
| 403 | PublishAlreadyPublishedException | Já foi publicado, então não pode ser alterado. |
| 403 | PublishAlreadyAnsweredException | Alguém já assinou o documento. |
| 403 | PublishParticipantsMissingException | Nenhum campo possui um sinalizador. |
| 403 | PublishMediaMissingException | Ainda não tem nenhum documento relacionado a isso. |
| 403 | PublishMediaNotReadyException | Seu documento ainda está sendo copiado ou convertido. |
| 403 | PublishMediaFailedException | Seu documento não conseguiu ser convertido. |
| 403 | PublishDocumentUnreadableException | Seu documento não pode ser lido. Apague o arquivo assinado digitalmente e crie um novo documento. |
| 403 | PublishDueTimePassedException | A data de vencimento já passou. |
| 403 | BotNotAllowedException | Alguém tentou assinar o documento, ou mesmo remover a assinatura de outra pessoa. |
| 403 | CaseClosedException | O caso foi encerrado. |
| 404 | ItemNotFoundException | A assinatura ou sinal digital não existe. |
Para informações sobre o corpo do erro e os demais códigos de erro, consulte Como lidar com erros da API e códigos de status.