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

Inserir Rubrica do Grupo de Assinatura no Documento (API)

Este guia detalha o processo de como adicionar pins de rubrica diretamente vinculados a grupos de signatários em um documento na D4Sign. Isso permite uma gestão mais eficiente de assinaturas em massa. O processo é dividido em três passos principais:

Passo 1: Inserir grupos de signatários a um documento (API)

O primeiro passo é vincular um grupo de signatários a um documento. As únicas restrições, além das permissões básicas, são: o documento deve estar na fase de "Aguardando Signatários" e o grupo deve estar disponível para seleção no mesmo cofre onde o documento foi inserido.

Com estas regras satisfeitas, é possível utilizar o endpoint abaixo para inserir um grupo ao documento como signatário.

🚧 Importante: Não esqueça de enviar o tokenAPI e cryptKey em sua requisição.

Exemplo: https://secure.d4sign.com.br/api/v1/documents/{UUID-DOCUMENT}/createlist?tokenAPI={SEU-TOKEN}&cryptKey={SEU-CRYPT-KEY}

Cadastrar signatários do documento, incluindo grupos (API)

Este endpoint realizará o cadastro dos signatários do documento, incluindo a opção de adicionar um grupo como signatário.

POST /documents/{UUID-DOCUMENT}/createlist

Parâmetros de Requisição (URL)

Parâmetro

Descrição

UUID-DOCUMENT

(obrigatório) O UUID do documento ao qual o signatário (ou grupo) será adicionado.
Exportar para as Planilhas

Parâmetros de Requisição (Body signers array)

Parâmetro

Descrição

email

(obrigatório) E-mail do signatário individual ou um e-mail de referência para o grupo (se uuid_grupo for utilizado).

act

(obrigatório) Ação da assinatura. Valores permitidos:
1 = Assinar <br>2 = Aprovar <br>3 = Reconhecer <br>4 = Assinar como parte <br>5 = Assinar como testemunha <br>6 = Assinar como interveniente <br>7 = Acusar recebimento <br>8 = Assinar como Emissor, Endossante e Avalista <br>9 = Assinar como Emissor, Endossante, Avalista, Fiador <br>10 = Assinar como fiador <br>11 = Assinar como parte e fiador <br>12 = Assinar como responsável solidário <br>13 = Assinar como parte e responsável solidário

foreign

(obrigatório) Indica se o signatário é estrangeiro. 0 = Possui CPF; 1 = Não possui CPF.

foreign_lang

Idioma do estrangeiro: en = Inglês, es = Espanhol, pt = Português.

certificadoicpbr

(obrigatório) 0 = Assinatura padrão D4Sign; 1 = Assinatura com Certificado ICP-Brasil.

assinatura_presencial

(obrigatório) 1 = Assinatura presencial; 0 = Não presencial.

docauth

(opcional) 1 = Exige documento com foto; 0 = Não exige.

docauthandselfie

(opcional) 1 = Documento + selfie; 0 = Não exige selfie.

embed_methodauth

(opcional) Método de autenticação para embed: email, password, sms, whatsembed.

embed_smsnumber

(opcional) Número do SMS ou WhatsApp no padrão (ex.: +5511953020202).

upload_allow

(opcional) Indica se o signatário pode enviar outros documentos.

upload_obs

(opcional) Quais documentos o signatário deve enviar (se upload_allow = 1).

after_position

(opcional) Define a posição após a qual o signatário será inserido na ordem.

skipemail

(opcional) 1 = Não enviar e-mails ao signatário.

whatsapp_number

(opcional) Número de WhatsApp para assinatura.

uuid_grupo

(opcional) UUID do grupo de assinatura a ser vinculado.

certificadoicpbr_tipo

(opcional) 1 = Qualquer certificado; 2 = e-CPF; 3 = e-CNPJ.

certificadoicpbr_cpf

(opcional) CPF do signatário. Em branco = qualquer e-CPF.

certificadoicpbr_cnpj

(opcional) CNPJ do signatário. Em branco = qualquer e-CNPJ.

password_code

(opcional) Código de acesso do signatário. Em branco remove código anterior.

auth_pix

(opcional) 1 = Autenticação via PIX.

auth_pix_nome

(opcional) Nome obrigatório se auth_pix = 1.

auth_pix_cpf

(opcional) CPF obrigatório se auth_pix = 1.

sms_number

(obrigatório) NOVO número de SMS do signatário (se embed_methodauth for sms).

key_signer

Chave do signatário.

videoselfie

1 = Exige vídeo selfie.

d4sign_score

(opcional) Ativa D4Sign Score. Requer docauthandselfie = 1 ou videoselfie = 1.

d4sign_score_nome

(opcional) Nome obrigatório se d4sign_score = 1.

d4sign_score_cpf

(opcional) CPF obrigatório se d4sign_score = 1.

d4sign_score_similarity

(opcional) Nível de similaridade exigida (min: 70 - max: 90).
Requisição - Envio Header
 
JSON 
{
    "Content-Type": "application/json"
}

Requisição - Envio Body

JSON 
{
    "signers" : [
        {
            "email": "email@dominio.com",
            "act": "1",
            "foreign": "1",
            "certificadoicpbr": "0",
            "assinatura_presencial": "0",
            "docauth": "0",
            "docauthandselfie": "0",
       	    "embed_methodauth": "email",
      	    "embed_smsnumber": "",
      	    "upload_allow": "0",
      	    "upload_obs": "Contrato Social e Conta de Luz",
      	    "whatsapp_number": "+5511981876540",
      	    "uuid_grupo": "UUID DO GRUPO",
      	    "certificadoicpbr_tipo": "2",
      	    "certificadoicpbr_cpf": "CPF",
      	    "certificadoicpbr_cnpj": "CNPJ",
      	    "password_code": "Código de acesso",
      	    "auth_pix": "0",
      	    "auth_pix_nome": "Nome do signatário",
      	    "auth_pix_cpf": "21917876280",
      	    "videoselfie": "0",
      	    "d4sign_score": "0",
      	    "d4sign_score_nome": "Nome do signatário",
      	    "d4sign_score_cpf": "21917876280",
      	    "d4sign_score_similarity": "90"
        },
        {...}
    ]
}

Resposta

Em caso de sucesso, a resposta retornará uma mensagem de sucesso.

JSON 
{
    "message": "success"
}

Como Consultar o UUID de um Grupo:

Para obter o uuid_grupo (UUID do grupo) a ser utilizado na requisição acima, você pode consultar o endpoint abaixo:

GET /groups/{UUID-SAFE}

Este endpoint listará todos os grupos de assinatura de um cofre específico.

Requisição - Envio Header

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

Resposta de Exemplo (Listar Grupos):

JSON 
[
    {
        "uuid_grupo": "018715xc-054b-409f-b122-f683951e5460",
        "nome": "Grupo Jurídico"
    },
    {
        "uuid_grupo": "a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6",
        "nome": "Departamento Comercial"
    }
]

Passo 2: Listar os grupos adicionados como signatários de um documento (API)

Após inserir corretamente um grupo como signatário de um documento, é fundamental confirmar que o grupo é listado corretamente como signatário através da API. Esta é uma condição essencial para permitir que os pins sejam inseridos no terceiro passo, pois o e-mail associado ao grupo será necessário.

Utilizando o endpoint abaixo, podemos listar todos os signatários do documento e identificar o e-mail de referência que foi criado para designar o grupo.

🚧 Importante: Não esqueça de enviar o tokenAPI e cryptKey em sua requisição.

Exemplo: https://secure.d4sign.com.br/api/v1/documents/{UUID-DOCUMENT}/list?tokenAPI={SEU-TOKEN}&cryptKey={SEU-CRYPT-KEY}

Listar todos os signatários de um documento (API)

Este endpoint retornará todos os signatários de um documento, incluindo os grupos inseridos.

GET /documents/{UUID-DOCUMENT}/list

Parâmetros de Requisição (URL)

Parâmetro

Descrição

UUID-DOCUMENT

(obrigatório) UUID do documento cujos signatários serão listados.
 

Requisição - Envio Header

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

Resposta de Exemplo (Listar Signatários):

JSON
 
{
    "uuidDoc": "9f08bf18-bf4b-410f-9701-c286e5b1cad1",
    "nameDoc": "teste.pdf",
    "type": "application/pdf",
    "size": "118990",
    "pages": "6",
    "uuidSafe": "06b3ddb1-abc9-4ab8-b944-0d7c940486af",
    "safeName": "Atendimento",
    "statusId": "3",
    "statusName": "Aguardando Assinaturas",
    "statusComment": "Comentário sobre cancelamento",
    "whoCanceled": "E-mail de quem cancelou o documento",
    "list": [
        {
            "key_signer": "NwYj=",
            "user_name": "Signatario 1",
            "user_document": "000000000000 (CPF)",
            "email": "signatario@email.com.br",
            "signed": "1",
            "sign_info": {
                "ip": "192.168.0.1",
                "ip_reverser": "bfb467a6.virtua.com.br porta: 33421",
                "geolocation": "-23 -23",
                "user_agent": "Mozilla",
                "date_signed": "2038-03-29 11:05:34",
                "date_signed_atom": "2038-03-29T11:05:34-03:00"
            },
            "type": "1",
            "foreign": "0",
            "certificadoicpbr": "0",
            "assinatura_presencial": "0",
            "assinatura_presencial_link": "LINK PARA ASSINATURA PRESENCIAL" ,
            "embed_methodauth": "email",
            "embed_smsnumber": "",
            "email_sent": "1",
            "email_sent_status": "Delivery",
            "email_sent_message": "Mensagem entregue com sucesso.",
            "upload_allowed": "0",
            "upload_obs": "Descricao dos documentos",
            "documents_attached": "[]",
            "date": "2016-04-17 13:56:21",
            "docauth": "1",
            "docauth_text": "DADOS CAPTURADOS DO DOCUMENTO REGISTRADO (SOLICITE ESSE RECURSO EM NOSSO SUPORTE@D4SIGN.COM.BR)",
            "password_code": "Código de acesso do signatário"
        }
    ]
}

Observação: O link para assinatura presencial (assinatura_presencial_link) só será exibido depois que o documento for enviado para assinatura.

Passo 3: Inserir pins de rubrica da assinatura diretamente vinculados aos grupos no documento (API)

Considerando que, no fluxo normal de inserção de pins, precisamos apenas enviar os dados de posicionamento do pin no documento e o e-mail do signatário a ele vinculado, podemos utilizar o e-mail que foi criado para designar o grupo (obtido no Passo 2) como referência.

A requisição do endpoint abaixo utilizará este e-mail para buscar na lista de signatários se esse pin pode ser inserido e vinculado ao grupo. Neste caso, conforme observamos nos passos anteriores, o e-mail do pin e o da lista de signatários serão correspondentes.

🚧 Importante: Não esqueça de enviar o tokenAPI e cryptKey em sua requisição.

Exemplo: https://secure.d4sign.com.br/api/v1/documents/{UUID-DOCUMENT}/addpins?tokenAPI={SEU-TOKEN}&cryptKey={SEU-CRYPT-KEY}

Adicionar rubrica do grupo ao documento (API)

Este endpoint irá adicionar a rubrica do grupo de signatário selecionado ao documento ou anexo.

POST /documents/{UUID-DOCUMENT}/addpins

Parâmetros de Requisição (URL)

Parâmetro

Descrição

UUID-DOCUMENT

(obrigatório) O UUID do documento principal ao qual o pin será adicionado.
Parâmetros de Requisição (Body pins array)
 

Parâmetro

Descrição

document

(obrigatório) UUID do documento principal ou do documento anexo (slave) onde o pin será adicionado.

email

(obrigatório) E-mail do grupo de signatários (obtido no Passo 2) que terá o pin adicionado.

page_height

(obrigatório) Altura da página do documento em pixels.

page_width

(obrigatório) Largura da página do documento em pixels.

page

(obrigatório) O número da página onde o pin será posicionado no documento selecionado no parâmetro document.

position_x

(obrigatório) Posição X (horizontal) do pin em pixels, a partir da esquerda da página.

position_y

(obrigatório) Posição Y (vertical) do pin em pixels, a partir do topo da página.

type

Tipo de pin a ser adicionado:
0 para assinatura <br> 1 para rubrica <br> 2 para selo
Requisição - Envio Header
 
JSON
 
{
    "Content-Type": "application/json"
}

Requisição - Envio Body

JSON
 
{
  "pins": [
    {
      "document": "uuid_document",
      "email" : "Grupo@email.com.br",
      "page_height": 300,
      "page_width": 500,
      "page":1,
      "position_x":30,
      "position_y":30,
      "type": 1 
    }
  ]
}

Ao receber a mensagem de sucesso, o pin de rubrica da assinatura deve estar disponível no documento da plataforma e em sua posição determinada na API.