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

Listar Signatários de um Documento (API)

Este endpoint da API D4Sign permite que você recupere todos os detalhes dos signatários vinculados a um documento específico. É essencial para acompanhar o status das assinaturas e obter informações sobre cada participante.

🚧 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}/list?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",
    "tokenAPI": "{SEU-TOKEN-API}",
    "cryptKey": "{SUA-CRYPT-KEY}"
}

Body

Para este endpoint, o corpo da requisição não é necessário. O UUID-DOCUMENT é enviado na URL para identificar o documento cujos signatários você deseja listar.

Resposta (Status 200 - Sucesso)

Quando a requisição for bem-sucedida, você receberá um objeto JSON com detalhes do documento e um objeto list contendo as informações de cada signatário.

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"
	}
}

Detalhes dos Campos da Resposta:

Campo Tipo Descrição
uuidDoc String O UUID do documento.
nameDoc String O nome do documento.
type String O tipo MIME do documento (ex: application/pdf).
size String O tamanho do documento em bytes.
pages String O número de páginas do documento.
uuidSafe String O UUID do cofre onde o documento está armazenado.
safeName String O nome do cofre.
statusId String O ID do status atual do documento.
statusName String O nome do status atual do documento (ex: "Aguardando Assinaturas").
statusComment String Comentário sobre o status do documento, como um motivo de cancelamento.
whoCanceled String O e-mail do usuário que cancelou o documento, se aplicável.
list Objeto Um objeto que contém as informações detalhadas de cada signatário do documento.
list.key_signer String Chave de identificação interna do signatário.
list.user_name String O nome do signatário.
list.user_document String O CPF do signatário (ou outro documento de identificação).
list.email String O e-mail do signatário.
list.signed String Indica se o signatário já assinou (1) ou não (0).
list.sign_info Objeto Contém informações sobre a assinatura, como IP, geolocalização, user agent e datas.
list.type String O tipo de signatário.
list.foreign String Indica se o signatário é estrangeiro (1) ou não (0).
list.certificadoicpbr String Indica se utilizou certificado ICP-Brasil (1) ou não (0).
list.assinatura_presencial String Indica se a assinatura foi presencial (1) ou não (0).
list.assinatura_presencial_link String O link para assinatura presencial. Este link só é exibido após o documento ser enviado para assinatura.
list.embed_methodauth String O método de autenticação utilizado no embed (ex: "email").
list.embed_smsnumber String Número de SMS utilizado para autenticação no embed, se aplicável.
list.email_sent String Indica se o e-mail de notificação foi enviado (1) ou não (0).
list.email_sent_status String O status de entrega do e-mail (ex: "Delivery").
list.email_sent_message String A mensagem de status da entrega do e-mail.
list.upload_allowed String Indica se o upload de documentos adicionais foi permitido (1) ou não (0) para este signatário.
list.upload_obs String Descrição dos documentos que podem ser anexados pelo signatário, se aplicável.
list.documents_attached Array Lista de documentos anexados pelo signatário, se aplicável.
list.date String A data de registro do signatário no documento.
list.docauth String Indica se a captura de dados do documento registrado (DocAuth) foi utilizada (1) ou não (0).
list.docauth_text String Texto explicativo sobre o DocAuth (para solicitar, contatar suporte@d4sign.com.br).
list.password_code String O código de acesso do signatário para o documento, se um código foi definido para acesso.