Endpoints Signatários

Endpoints Signatários

🚧

Importante

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

Ex.: https://secure.d4sign.com.br/api/v1/safes?tokenAPI={SEU-TOKEN}&cryptKey={SEU-CRYPT-KEY}

Listar signatários de um documento

GET /documents/{UUID-DOCUMENT}/list

Testar endpoint 🧪


Esse objeto retornará todos os signatários de um documento.

{
    "Content-Type": "application/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": "[email protected]",
        "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" - O link só será exibido depois que o documento for enviado para assinatura,
        "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 [email protected])",
        "password_code": "Código de acesso do signatário"
        
    }
}
ParâmetroDescrição
UUID-DOCUMENT (obrigatório)UUID do documento que deverá ser listado.

Listar Grupos de Assinaturas

GET /groups/{UUID-SAFE}

Testar endpoint 🧪

Este método listará todos os grupos de assinatura do cofre

{
    "Content-Type": "application/json"
}
{
    "uuid_grupo": "018715xc-054b-409f-b122-f683951e5460",
    "nome": "Grupo Jurídico"
}
ParâmetroDescrição
UUID-SAFE (obrigatório)UUID do COFRE que deverá ser listado.

Cadastrar signatários

POST/documents/{UUID-DOCUMENT}/createlist

Testar endpoint 🧪

Esse objeto realizará o cadastro dos signatários do documento, ou seja, quais pessoas precisam assinar esse documento.

{
    "signers" : [
        {
            "email": "[email protected]",
            "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" (opcional)",
            "uuid_grupo": "UUID DO GRUPO" (opcional),
            "certificadoicpbr_tipo": "2" (opcional),
            "certificadoicpbr_cpf": "CPF" (opcional),
            "certificadoicpbr_cnpj": "CNPJ" (opcional)
            "password_code": "Código de acesso" (opcional),
            "auth_pix": "0" (opcional),
            "auth_pix_nome": "Nome do signatário" (opcional),
            "auth_pix_cpf": "21917876280" (opcional),
            "videoselfie": "0" (opcional),
            "d4sign_score": "0" (opcional),
            "d4sign_score_nome": "Nome do signatário" (opcional),
            "d4sign_score_cpf": "21917876280" (opcional),
            "d4sign_score_similarity": "90" (min 70 - max 90),
        },
        {...}
        ]
}
{
    "key_signer": "NwYu=",
    "email": "[email protected]",
    "act": "1",
    "foreign": "0",
    "certificadoicpbr": "0",
    "assinatura_presencial": "0",
    "assinatura_presencial_link": "LINK PARA ASSINATURA PRESENCIAL" - O link só será exibido depois que o documento for enviado para assinatura,
    "doc_auth": "0",
    "embed_methodauth": "email",
    "embed_smsnumber": "",
    "upload_allow": "0",
    "upload_obs": "Contrato Social e Conta de Luz",
    "docauthandselfie": "0",
    "skipemail": "0",
    "whatsapp": "",
    "password_code": "",
    "status": "created"
}
ParâmetroDescrição
email (obrigatório)E-mail do signatário (pessoa que precisa assinar o documento)
act (obrigatório)Ação da assinatura.
Ações permitidas:
1 = Assinar
2 = Aprovar
3 = Reconhecer
4 = Assinar como parte
5 = Assinar como testemunha
6 = Assinar como interveniente
7 = Acusar recebimento
8 = Assinar como Emissor, Endossante e Avalista
9 = Assinar como Emissor, Endossante, Avalista, Fiador
10 = Assinar como fiador
11 = Assinar como parte e fiador
12 = Assinar como responsável solidário
13 = Assinar como parte e responsável solidário
foreign (obrigatório)Indica se o signatário é estrangeiro, ou seja, se possui CPF.
0 = Possui CPF (Brasileiro).
1 = Não possui CPF (Estrangeiro).
Para os signatários definidos como 'estrangeiros', o CPF não será exigido.
foreign_langIndica qual idioma será utilizado para o estrangeiro.
en = Inglês (US)
es = Espanhol
ptBR = Português
certificadoicpbr (obrigatório)Indica se o signatário DEVE efetuar a assinatura com um Certificado Digital ICP-Brasil.
0 = Será efetuada a assinatura padrão da D4Sign.
1 = Será efetuada a assinatura com um Certificado Digital ICP-Brasil.
assinatura_presencial (obrigatório)Indica se o signatário DEVE efetuar a assinatura de forma presencial.
1 = Será efetuada a assinatura presencial.
0 = Não será efetuada a assinatura presencial.
docauth (opcional)Indica se o signatário DEVE efetuar a assinatura apresentando um documento com foto.
1 = Será efetuada a assinatura exigindo um documento com foto.
0 = Não será efetuada a assinatura exigindo um documento com foto.
docauthandselfie (opcional)Indica se o signatário DEVE efetuar a assinatura apresentando um documento com foto e depois registrar uma selfie segurando o mesmo documento.
1 = Será efetuada a assinatura exigindo um documento com foto e uma selfie segurando o documento.
0 = Não será efetuada a assinatura exigindo um documento com foto e uma selfie segurando o documento.
embed_methodauth (opcional)Indica qual o método de autenticação será utilizado no EMBED.
email = O token será enviado por e-mail
password = Caso o signatário já possua uma conta D4Sign, será exigida a senha da conta.
sms = O token será enviado por SMS (para utilizar essa opção entre em contato com a equipe comercial da D4Sign)
whats = O token será enviado por WhatsApp (para utilizar essa opção entre em contato com a equipe comercial da D4Sign)
embed_smsnumber (opcional)Indica o número de telefone que será enviado o TOKEN.
Atenção: esse número deverá seguir o padrão E.164.
Ex.: +5511953020202 (código do país, DDD, número do telefone)
upload_allow (opcional)Indica se o signatário poderá enviar outros documentos
upload_obs (opcional)Se o upload_allow for setado como 1, indique aqui quais documentos o signatário deve enviar
after_position (opcional)Caso o seu documento esteja na fase "Aguardando assinaturas" e a sequencia de assinatura estiver sendo seguida, você poderá determinar qual a posição do signatário que você deseja adicionar.
Exemplo:
[email protected]
[email protected]
[email protected]
[email protected]
Se você definir a variável after_position com o número 1, o signatário será inserido após o primeiro signatário já cadastrado, no exemplo o [email protected]
skipemail (opcional)Defina com o valor 1 para não enviar e-mails ao signatário
whatsapp_number (opcional)Para enviar para o WhatsApp, digite o número no formato E.164. Ex.: Ex.: +5511953020202 (código do país, DDD, número do telefone)
uuid_grupo (opcional)Para cadastrar um grupo de assinaturas, insira o UUID do grupo.
certificadoicpbr_tipo (opcional)Definir uma modalidade de assinatura com certificado digital. 1 = Qualquer certificado2 = e-CPF3 = e-CNPJ
certificadoicpbr_cpf (opcional)Entre com o CPF do signatário. DEIXE EM BRANCO PARA ACEITAR QUALQUER CERTIFICADO E-CPF.
certificadoicpbr_cnpj (opcional)Entre com o CNPJ do signatário. DEIXE EM BRANCO PARA ACEITAR QUALQUER CERTIFICADO E-CNPJ.
password_code (opcional)Entre com um código para o acesso do signatário. DEIXE EM BRANCO PARA REMOVER O CÓDIGO ANTERIOR.
auth_pix (opcional)Autenticacão bancária por PIX
auth_pix_nomeCaso o auth_pix seja 1, o nome do signatário será obrigatório
auth_pix_cpfCaso o auth_pix seja 1, o CPF do signatário será obrigatório
videoselfieCaso o videoselfie seja 1, o signatário deverá registrar uma vídeo selfie no momento da assinatura
d4sign_score (opcional)Ativação da D4Sign Score - Consulta na base de dados do Governo Federal - Só será aceita se docauthandselfie =1 ou videoselfie = 1.

A consulta será realizada no Denatran, ou seja, o signatário deve possuir uma CNH.

Caso o signatário não possua uma CNH (cadastro no Denatran), nenhum crédito será descontado da D4Sign Score.
d4sign_score_nomeCaso o d4sign_score seja 1, o nome do signatário será obrigatório
d4sign_score_cpfCaso o d4sign_score seja 1, o CPF do signatário será obrigatório
d4sign_score_similarityNível de similaridade exigida - min 70 - max 90

Alterar signatário

POST/documents/{UUID-DOCUMENT}/changeemail

Testar endpoint 🧪

Esse objeto atualizará o e-mail do signatário

{
    "Content-Type": "application/json"
}
{
    "sha256": "13f2a91a9e85d5240ff32754eba41c02...",
    "sha512": "9ddd2c2659ae6cd6790d1f31780c904145bd80272b51cb...",
    "name": "Meu contrato de venda",
    "uuid_folder": "{UUID DA PASTA}"
}
{
    "message": "E-mail changed"
}
ParâmetroDescrição
email-before (obrigatório)ANTIGO e-mail ou número de WhatsApp do signatário
email-after (obrigatório)NOVO e-mail ou número de WhatsApp do signatário
key-signerChave do signatário

Alterar número do SMS

POST/documents/{UUID-DOCUMENT}/changesmsnumber

Testar endpoint 🧪

Esse objeto atualizará o número do SMS do signatário

{
    "Content-Type": "application/json"
}
{
    "email": "[email protected]",
    "sms-number": "+5511953874555",
    "key-signer": "NyWx="
}
{
    "message": "SMS number changed"
}
ParâmetroDescrição
email (obrigatório)E-mail do signatário
sms-number (obrigatório)NOVO número de SMS do signatário
key-signerChave do signatário

Alterar código de acesso do signatário

POST/documents/{UUID-DOCUMENT}/changepasswordcode

Testar endpoint 🧪

Esse objeto atualizará o código de acesso do signatário

{
    "Content-Type": "application/json"
}
{
    "email": "[email protected]",
    "password-code": "Código para acessar o documento",
    "key-signer": "NyWx="
}
{
    "message": "Password code changed",
}
ParâmetroDescrição
email (obrigatório)E-mail do signatário
password-codeCódigo para acessar o documento. Deixe em branco para remover o código atual.
key-signerChave do signatário

Remover signatário

POST/documents/{UUID-DOCUMENT}/removeemaillist

Testar endpoint 🧪

{
    "Content-Type": "application/json"
}
{
    "email-signer": "[email protected]",
    "key-signer": "NyWx="
}
{
    "message": "E-mail has removed"
}
ParâmetroDescrição
email-signer (obrigatório)E-mail do signatário
key-signer (obrigatório)Chave do signatário

Cadastrar informações do signatário

POST/documents/{UUID-DOCUMENT}/addinfo

Testar endpoint 🧪

🚧

Importante

APENAS PARA ASSINATURA PRESENCIAL

Esse objeto cadastrará as informações (nome, cpf e data de nascimento) no signatário criado. Você poderá utilizar esse objeto para as assinaturas presenciais. Se você souber os dados do signatário, cadastre-os para evitar que o signatário precise informá-los no momento da assinatura.

{
    "Content-Type": "application/json"
}
{
    "key_signer": "NwYj=",
    "email": "[email protected]",
    "display_name": "Nome do Signatário",
    "documentation": "CPF do Signatário",
    "birthday": "Data de Nascimento do Signatário",
    "tokenAPI": "{token-user}"
}
{
    "uuid-doc": 00004fa2-a361-42e3-a923-bb088b1809fe,
    "email": "[email protected]",
    "name": "Nome do signatário",
    "documentation": "CPF do signatário",
    "birthday": "Data de nascimento do signatário",
    "status": "changed"
}
ParâmetroDescrição
key_signerChave do signatário
email (obrigatório)E-mail do signatário cadastrado
display_name (opcional)Informar o nome do signatário
documentation (opcional)Informar o CPF do signatário
birthday (opcional)Informar a data de nascimento do signatário

Did this page help you?