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

Cadastrar Signatários (API)

Este endpoint da API D4Sign permite que você cadastre os signatários de um documento, definindo quem e como cada pessoa precisa assinar. É fundamental para preparar o fluxo de assinaturas de qualquer documento.

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

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

Header

O cabeçalho da sua requisição deve conter o Content-Type como application/json, além dos seus tokens de autenticação.

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

Body

No corpo da requisição, você enviará um array de objetos signers, onde cada objeto representa um signatário com suas configurações de assinatura.

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": "+5511900000000",
            "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": "000.000.000-00",
            "d4sign_score_similarity": "90"
        }
    ]
}

Detalhes dos Parâmetros do Body (dentro do array signers):

Parâmetro Tipo Obrigatoriedade Descrição
email String Obrigatório O e-mail do signatário.
act String Obrigatório A 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 String Obrigatório Indica se o signatário é estrangeiro: 0 se possui CPF; 1 se não possui CPF.
foreign_lang String Opcional Idioma do signatário estrangeiro: en = Inglês, es = Espanhol, pt = Português.
certificadoicpbr String Obrigatório Tipo de assinatura: 0 para assinatura padrão D4Sign; 1 para assinatura com Certificado ICP-Brasil.
assinatura_presencial String Obrigatório Indica assinatura presencial: 1 para sim; 0 para não.
docauth String Opcional Exige documento com foto: 1 para sim; 0 para não.
docauthandselfie String Opcional Exige documento + selfie: 1 para sim; 0 para não.
embed_methodauth String Opcional Método de autenticação para embed: email, password, sms, whatse (WhatsApp).
embed_smsnumber String Opcional Número de SMS ou WhatsApp para autenticação no padrão (ex: +5511953020202).
upload_allow String Opcional Indica se o signatário pode enviar outros documentos: 1 para sim; 0 para não.
upload_obs String Opcional Descrição dos documentos que o signatário deve enviar (somente se upload_allow = 1).
after_position String Opcional Define a posição na ordem de assinatura após a qual este signatário será inserido.
skipemail String Opcional 1 para não enviar e-mails de notificação ao signatário.
whatsapp_number String Opcional Número de WhatsApp para assinatura, no padrão (ex: +5511981876540).
uuid_grupo String Opcional UUID do grupo de assinatura ao qual o signatário pertence.
certificadoicpbr_tipo String Opcional Tipo de certificado ICP-Brasil: 1 = Qualquer certificado; 2 = e-CPF; 3 = e-CNPJ.
certificadoicpbr_cpf String Opcional CPF do signatário para validação de e-CPF. Se em branco, qualquer e-CPF é aceito.
certificadoicpbr_cnpj String Opcional CNPJ do signatário para validação de e-CNPJ. Se em branco, qualquer e-CNPJ é aceito.
password_code String Opcional Código de acesso do signatário. Se em branco, remove um código anterior.
auth_pix String Opcional Ativa a autenticação via PIX: 1 para sim; 0 para não.
auth_pix_nome String Opcional Nome do signatário. Obrigatório se auth_pix = 1.
auth_pix_cpf String Opcional CPF do signatário. Obrigatório se auth_pix = 1.
sms-number String Obrigatório (se relevante para o método de autenticação) NOVO número de SMS do signatário. (Note: o parâmetro embed_smsnumber também existe e pode ter um propósito similar ou complementar dependendo do contexto da D4Sign API.)
videoselfie String Opcional Exige vídeo selfie: 1 para sim; 0 para não.
d4sign_score String Opcional Ativa o D4Sign Score: 1 para sim; 0 para não. Requer CNH + (docauthandselfie = 1 ou videoselfie = 1).
d4sign_score_nome String Opcional Nome do signatário. Obrigatório se d4sign_score = 1.
d4sign_score_cpf String Opcional CPF do signatário. Obrigatório se d4sign_score = 1.
d4sign_score_similarity String Opcional Nível de similaridade exigida para o D4Sign Score (mínimo: 70, máximo: 90).

Resposta (Status 200 - Sucesso)

Quando a requisição for bem-sucedida, você receberá um objeto JSON com os detalhes do signatário recém-cadastrado, incluindo sua chave de identificação e status.

JSON
{
    "key_signer": "NwYu=",
    "email": "email@user.com.br",
    "act": "1",
    "foreign": "0",
    "certificadoicpbr": "0",
    "assinatura_presencial": "0",
    "assinatura_presencial_link": "LINK PARA ASSINATURA PRESENCIAL",
    "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"
}

Detalhes dos Campos da Resposta:

Campo Tipo Descrição
key_signer String Chave de identificação única do signatário.
email String O e-mail do signatário.
act String A ação de assinatura definida para o signatário.
foreign String Indica se o signatário é estrangeiro.
certificadoicpbr String Indica se a assinatura será com Certificado ICP-Brasil.
assinatura_presencial String Indica se a assinatura é presencial.
assinatura_presencial_link String O link para a assinatura presencial. Este link só é exibido depois que o documento for enviado para assinatura.
doc_auth String Indica se a exigência de documento com foto está ativa.
embed_methodauth String O método de autenticação configurado para o embed.
embed_smsnumber String O número de SMS ou WhatsApp configurado para autenticação.
upload_allow String Indica se o signatário pode enviar outros documentos.
upload_obs String Descrição dos documentos que o signatário deve enviar.
docauthandselfie String Indica se a exigência de documento + selfie está ativa.
skipemail String Indica se o envio de e-mails para o signatário está desabilitado.
whatsapp String O número de WhatsApp do signatário, se configurado.
password_code String O código de acesso do signatário, se configurado.
status String O status do cadastro do signatário (ex: "created").