Definir grupos de signatários

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

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/signature-group/{{doc_token}}/

Headers

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

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

Propriedades de group

Name	Type	Description
titulo	string	Nome do grupo
order	number	Ordem sequencial de assinatura, por exemplo: grupo 0 será assinado primeiro. A numeração dos grupos deve iniciar em zero e ser contínua, sem números pulados.
signers	Array<Signer>	Lista de objetos com tokens de signatários do grupo. Devem estar presentes nos grupos todos os signatários existentes no documento.

Propriedades de signers

Name	Type	Description
token	string	Token do signatário

Exemplo de payload:

{
  "groups": [
    {
      "title": "Nome do primeiro grupo",
      "order": 0, // ordem de assinatura
      "signers": [
      // token do signatário
        { "token": "bc0739d8-bb9c-4137-a7c7-f846be7d6dd0" },
        { "token": "2e511898-c436-4358-93a1-86c7af496f96" }
      ]
    },
    {
      "title": "Nome do segundo grupo",
      "order": 1,
      "signers": [
        { "token": "b46ef316-7a30-47b6-91de-c84e52f2cf93" },
        { "token": "446d556d-58bf-49bd-b4ba-cb9ae16f73ba" }
      ]
    }
  ]
}

Respostas

200 OK

{
    "message": "OK"
}

400 Bad Request

Exemplos de erros:

• Quando a numeração dos grupos não for contínua:

{
    "message": "A numeração dos grupos deve ser contínua. Valores esperados: [0, 1, 2], valores fornecidos: [0, 2, 3]"
}

• Quando os grupos não começarem pelo valor 0:

{
    "message": "A ordem dos grupos de signatários deve começar por 0. Primeiro grupo encontrado: 1"
}

• Quando faltarem signatários do documento a serem associados a algum grupo:

{
    "message": "Há signatários neste documento que não foram incluídos em nenhum grupo."
}