Pular para o conteúdo
  • Não há sugestões porque o campo de pesquisa está em branco.

Listar Detalhes de Grupo de Assinatura (API)

Este endpoint da API D4Sign permite que você recupere os detalhes completos de um grupo de assinatura específico. Ele lista cada membro do grupo e suas configurações de assinatura, como tipo de assinatura, exigências de autenticação e status.

🚧 Importante: Você precisará incluir seus tokens de autenticação na requisição, conforme a documentação da API D4Sign. O tokenAPI utilizado deve pertencer ao dono da conta do UUID-GROUP, ou o grupo deve estar compartilhado com o UUID-COFRE informado.

 

Exemplo de URL completa para requisição: https://secure.d4sign.com.br/api/v1/groups/{UUID-COFRE}/groupdetails/{UUID-GROUP}?tokenAPI={SEU-TOKEN}&cryptKey={SEU-CRYPT-KEY}

Header

O cabeçalho da sua requisição deve conter o Content-Type como application/json.

JSON
{
    "Content-Type": "application/json"
}

Body

Para este endpoint, o corpo da requisição não é necessário. Os UUIDs do cofre e do grupo são enviados na URL.

Resposta (Status 200 - Sucesso)

Quando a requisição for bem-sucedida, você receberá um objeto JSON contendo o nome do grupo e um array (group_details) com os detalhes de cada membro do grupo.

JSON
{
    "name_group": "teste@teste.com.br",
    "group_details": [
        {
            "uuid_conta": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
            "uuid_grupo": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
            "email": "teste@teste.com",
            "tipo_assinatura": "1",
            "certificado_digital": "0",
            "doc_auth": "0",
            "assinatura_presencial": "0",
            "estrangeiro": "0",
            "removido": "0",
            "dt_cadastro": "2024-01-04 11:48:31",
            "desativar_remocao": "0",
            "signatario_editavel": "0",
            "doc_authselfie": "0",
            "sequencia": "1",
            "upload_permitido": "0",
            "upload_obs": null,
            "clausula_destaque": "0",
            "nome_tipo_assinatura": "Assinar"
        },
        {
            "uuid_conta": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
            "uuid_grupo": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
            "email": "teste@teste.com",
            "tipo_assinatura": "1",
            "certificado_digital": "0",
            "doc_auth": "0",
            "assinatura_presencial": "0",
            "estrangeiro": "0",
            "removido": "0",
            "dt_cadastro": "2024-01-04 11:48:41",
            "desativar_remocao": "0",
            "signatario_editavel": "0",
            "doc_authselfie": "0",
            "sequencia": "2",
            "upload_permitido": "0",
            "upload_obs": null,
            "clausula_destaque": "0",
            "nome_tipo_assinatura": "Assinar"
        },
        {
            "uuid_conta": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
            "uuid_grupo": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
            "email": "teste@teste.com",
            "tipo_assinatura": "1",
            "certificado_digital": "0",
            "doc_auth": "0",
            "assinatura_presencial": "0",
            "estrangeiro": "0",
            "removido": "0",
            "dt_cadastro": "2024-01-04 11:49:02",
            "desativar_remocao": "0",
            "signatario_editavel": "0",
            "doc_authselfie": "0",
            "sequencia": "3",
            "upload_permitido": "0",
            "upload_obs": null,
            "clausula_destaque": "0",
            "nome_tipo_assinatura": "Assinar"
        }
    ]
}

Detalhes dos Campos da Resposta:

Campo Tipo Descrição
name_group String O nome do grupo de assinatura.
group_details Array Um array de objetos, onde cada objeto representa um membro/signatário do grupo.
uuid_conta String O UUID da conta à qual o membro do grupo está associado.
uuid_grupo String O UUID do grupo de assinatura.
email String O e-mail do membro do grupo.
tipo_assinatura String O ID do tipo de assinatura configurado para este membro (corresponde aos valores act do cadastro).
certificado_digital String Indica se exige certificado digital (1) ou não (0).
doc_auth String Indica se exige documento com foto (1) ou não (0).
assinatura_presencial String Indica se a assinatura é presencial (1) ou não (0).
estrangeiro String Indica se o signatário é estrangeiro (1) ou não (0).
removido String Indica se o membro foi removido do grupo (1) ou não (0).
dt_cadastro String Data e hora de cadastro do membro no grupo.
desativar_remocao String Indica se a remoção do membro está desativada (1) ou não (0).
signatario_editavel String Indica se as informações do signatário são editáveis (1) ou não (0).
doc_authselfie String Indica se exige documento com foto e selfie (1) ou não (0).
sequencia String A sequência/ordem do signatário dentro do grupo.
upload_permitido String Indica se o upload de documentos é permitido para este membro (1) ou não (0).
upload_obs String Observações sobre documentos que podem ser carregados, se aplicável.
clausula_destaque String Indica se a cláusula de destaque está ativa (1) ou não (0).
nome_tipo_assinatura String O nome do tipo de assinatura (ex: "Assinar").