Definir grupos de signatários

Criar grupos de signatários permite definir uma ordem específica de assinaturas entre diferentes grupos de pessoas.

Exemplo de uso

Imagine que você está gerenciando um processo de assinatura de contrato. Você quer garantir que Pedro e Maria assinem o documento antes que ele seja enviado para Carlos e Alice. Para isso, você pode criar dois grupos de signatários:

• Grupo 1: Pedro, Maria

• Grupo 2: Carlos, Alice

Ao configurar os grupos dessa maneira, o sistema garantirá que as assinaturas de Pedro e Maria sejam concluídas antes que o documento seja enviado para Carlos e Alice. Você pode criar quantos grupos desejar.

Como Configurar

A criação dos grupos deve ser realizada após a criação do documento, ou seja, após obter a resposta da criação do seu documento, faça o disparo para o endpoint de criação dos grupos.

Ver documentação de criação de documentos.

Abaixo, você encontrará a documentação detalhada do endpoint para criar e gerenciar grupos de signatários.

Criar grupos de signatários

POST https://api.zapsign.com.br/api/v1/docs/signature-group/{{doc_token}}/

Headers

Name	Type	Description
Authorization*	string	Api token a frente do texto "Bearer". Ex: Bearer c7f35c84-7893-4087-b4fb-d1f06c23

Request Body

Name	Type	Description
groups	Array<Group>	Array com grupos de signatários

Exemplo de payload:

{
  "groups": [
    {
      "order": 0 // ordem de assinatura
      "title": "Nome do primeiro grupo",
      "signers": [
        { "token": "9a8539c4-b915-4f72-9ed1-072e81e8a886" },
        { "token": "bc2acaee-d20d-4a06-b152-87806ba03ef8" },
      ],
    },
    {
      "title": "Nome do segundo grupo",
      "order": 1 // ordem de assinatura
      "signers": [
        { "token": "bbab9fa5-fdd9-4d64-9e8e-104fb9dc492e" },
        { "token": "bc1b9fa5-fdd9-4d64-9e8e-104dd9dc112f" },
      ],
    }
  ]
}

Propriedades de group

Name	Type	Description
order	number	Ordem sequêncial de assinatura, por exemplo: grupo 0 será assinado primeiro.
signers	Array<Signer>	Lista de objetos com tokens de signatários do grupo
titulo	string	Nome do grupo

Propriedades de signers

Name	Type	Description
token	string	Token do signatário

Perguntas frequentes

• Por que devo usar grupos de signatários? R.: Usar grupos de signatários é útil quando você precisa que determinadas pessoas assinem um documento antes de outras. Isso é comum em fluxos de trabalho onde a aprovação de um grupo é necessária antes que outro grupo possa assinar.

• É possível adicionar ou remover signatários de um grupo após a criação? R.: No momento não. Uma vez que um grupo é criado e o processo de assinatura começou, não é possível alterar a ordem dos grupos de assinatura.

• Todos os membros de um grupo precisam assinar antes que o próximo grupo seja notificado? R.: Sim, todos os signatários de um grupo precisam concluir suas assinaturas antes que o documento seja enviado para o próximo grupo.

• Posso ter vários grupos assinando simultaneamente? R.: Não, os grupos de signatários são criados para estabelecer uma ordem de assinatura. No entanto, todos os membros de um mesmo grupo podem assinar simultaneamente.

• O que acontece se alguém do grupo não assinar? R.: Se alguém de um grupo não assinar, o processo de assinatura não avançará para o próximo grupo. É necessário que todos os membros de um grupo concluam suas assinaturas.