Guides

Endpoints Documentos

Suggest Edits

Endpoints Documentos

🚧

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 todos os documentos

GET/documents

Testar endpoint 🧪

📘

O resultado será de 500 documentos por páginas
Utilize o parametro PG na URL para paginar o resultado. Ex.:
https://secure.d4sign.com.br/api/v1/documents?tokenAPI={SEU-TOKEN}&cryptKey={crypt-key}&pg=2
O primeiro bloco do resultado exibirá o total de páginas disponíveis

Requisição

{
    "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"
},
{...}]

Listar um documento específico

GET /documents/{UUID-DOCUMENT}

Testar endpoint 🧪

Esse objeto retornará apenas o documento solicitado.

{
    "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"
}
ParâmetroDescrição
UUID-DOCUMENTO (obrigatório)UUID do documento que deverá ser listado.

Verificar as dimensões de um documento

GET /documents/{UUID-DOCUMENT}/dimensions

Esse objeto retornara as dimensões por páginas de um documento.

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

{
  "dimensions": [
    {
      "page": 1,
      "width": 777,
      "height": 1098
    },
    {
      "page": 2,
      "width": 777,
      "height": 1098
    },
    {
      "page": 3,
      "width": 777,
      "height": 1098
    }
  ]
}

Listar todos os documentos de uma fase

GET /documents/{ID-FASE}/status

Testar endpoint 🧪

Esse objeto retornará todos os documentos que estiverem na fase informada.

📘

O resultado será de 500 documentos por páginas
Utilize o parâmetro PG na URL para paginar o resultado. Ex.:
https://secure.d4sign.com.br/api/v1/documents?tokenAPI={SEU-TOKEN}&cryptKey={crypt-key}&pg=2

O primeiro bloco do resultado exibirá o total de páginas disponíveis

{
    "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"
}
ParâmetroDescrição
ID-FASE (obrigatório)ID da FASE que deverá ser listado.
ID 1 - Processando
ID 2 - Aguardando Signatários
ID 3 - Aguardando Assinaturas
ID 4 - Finalizado
ID 5 - Arquivado
ID 6 - Cancelado
ID 7 - Editando

UPLOAD de um documento principal

POST /documents/{UUID-SAFE}/upload

Testar endpoint 🧪

Esse objeto realizará o UPLOAD do seu documento para os servidores da D4Sign.

🚧

Atenção!

Após o UPLOAD, o documento será criptografado em nossos cofres e carimbado com um número de série.

Após o processamento um preview será gerado. O processamento será realizado em background, ou seja, a requisição não ficará bloqueada.

Todos os documentos ficam armazenados em COFRES criptografados, ou seja, o parâmetro UUID-SAFE é obrigatório e determina em qual cofre o documento ficará armazenado.

{
    "Content-Type": "multipart/form-data;",
    "tokenAPI": "{token-user}"
}

{
    "file": "FILE(form-data)",
    "uuid_folder": "{UUID DA PASTA}",
  "workflow":"2"
}

{
    "uuid": "9f08bf18-bf4b-410f-9701-c286e5b1cad1"
}
ParâmetroDescrição
File (obrigatório)Arquivo que será enviado para os servidores da D4Sign. MIME Types aceitos PDF,DOC,DOCX,JPG,PNG,BMP
uuid_folder (opcional)Para que o documento fique armazenado dentro da pasta, informe o UUID dela.
workflow (opcional)1= Seguir a ordem de assinatura do parâmetro "after_position" na requisição de cadastrar signatários.
2= Não seguir a ordem de assinatura do parâmetro "after_position" na requisição de cadastrar signatários.

UPLOAD de um documento anexo ao principal

POST/documents/{UUID-DOC-PRINCIPAL}/uploadslave

Testar endpoint 🧪

Esse objeto realizará o UPLOAD do seu documento para os servidores da D4Sign e ficará anexo ao documento principal.

Após o processamento um preview será gerado. O processamento será realizado em background, ou seja, a requisição não ficará bloqueada.

{
    "Content-Type": "multipart/form-data;",
    "tokenAPI": "{token-user}"
}

{
    "file": "FILE(form-data)"
}

{
    "message": "File created"
}
ParâmetroDescrição
File (obrigatório)Arquivo que será enviado para os servidores da D4Sign. MIME Types aceitos PDF,DOC,DOCX,JPG,PNG,BMP

UPLOAD de um documento principal (Binário)

POST/documents/{UUID-SAFE}/uploadbinary

Testar endpoint 🧪

Esse objeto realizará o UPLOAD do seu documento para os servidores da D4Sign.

Após o UPLOAD, o documento será criptografado em nossos cofres e carimbado com um número de série.

Após o processamento um preview será gerado. O processamento será realizado em background, ou seja, a requisição não ficará bloqueada.

Todos os documentos ficam armazenados em COFRES criptografados, ou seja, o parâmetro UUID-SAFE é obrigatório e determina em qual cofre o documento ficará armazenado.

{
    "base64_binary_file": "JVhsdCAdwesAD2dsadfASDQW...",
    "mime_type": "application/pdf",
    "name": "Meu contrato de venda",
    "uuid_folder": "{UUID DA PASTA}"
}

{
    "uuid": "9f08bf18-bf4b-410f-9701-c286e5b1cad1"
}
ParâmetroDescrição
base64_binary_file (obrigatório)Arquivo que será enviado para os servidores da D4Sign. ATENÇÃO: Você deve enviar o binário do seu arquivo codificado em BASE64
mime_type (obrigatório)Informe o MIMETYPE do seu arquivo
name (opcional)Informe o nome do seu arquivo
uuid_folder (opcional)Para que o documento fique armazenado dentro da pasta, informe o UUID dela.

UPLOAD de um documento anexo ao principal (Binário)

POST/documents/{UUID-DOC-MASTER}/uploadslavebinary

Testar endpoint 🧪

Esse objeto realizará o UPLOAD do seu documento para os servidores da D4Sign.

Após o UPLOAD, o documento será criptografado em nossos cofres e carimbado com um número de série.

Após o processamento um preview será gerado. O processamento será realizado em background, ou seja, a requisição não ficará bloqueada.

{
    "base64_binary_file": "JVhsdCAdwesAD2dsadfASDQW...",
    "mime_type": "application/pdf",
    "name": "Meu contrato de venda"
}

{
    "message": "File created"
}
ParâmetroDescrição
base64_binary_file (obrigatório)Arquivo que será enviado para os servidores da D4Sign. ATENÇÃO: Você deve enviar o binário do seu arquivo codificado em BASE64
mime_type (obrigatório)Informe o MIMETYPE do seu arquivo
name (opcional)Informe o nome do seu arquivo

UPLOAD de um hash de documento (HASH)

POST/documents/{UUID-SAFE}/uploadhash

Testar endpoint 🧪

Esse objeto realizará o UPLOAD do hash de um documento para os servidores da D4Sign.

Após o UPLOAD, o hash de documento será criptografado em nossos cofres e carimbado com um número de série.

Todos os documentos ficam armazenados em COFRES criptografados, ou seja, o parâmetro UUID-SAFE é obrigatório e determina em qual cofre o hash de documento ficará armazenado.

{
    "sha256": "13f2a91a9e85d5240ff32754eba41c02...",
    "sha512": "9ddd2c2659ae6cd6790d1f31780c904145bd80272b51cb...",
    "name": "Meu contrato de venda",
    "uuid_folder": "{UUID DA PASTA}"
}

{
    "uuid": "9f08bf18-bf4b-410f-9701-c286e5b1cad1"
}
ParâmetroDescrição
sha256 (obrigatório)Informe o sha256 do arquivo em HEXADECIMAL. O sha256 deverá possuir 64 caracteres. Atenção: Não envie o sha256 em binário.
sha512 (obrigatório)Informe o sha256 do arquivo em HEXADECIMAL. O sha512 deverá possuir 64 caracteres. Atenção: Não envie o sha256 em binário.
name (opcional)Informe o nome do seu arquivo
uuid_folder (opcional)Para que o documento fique armazenado dentro da pasta, informe o UUID dela.

Destacar cláusulas

POST/documents/{UUID-DOCUMENT}/addhighlight

Testar endpoint 🧪

Esse objeto cadastrará as informações (texto) para serem destacadas para o signatário

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

{
    "key_signer": "NwYj=",
    "email": "[email protected]",
    "text": "Cláusula que será destacada"
}

{
    "success": 1,
    "email": "[email protected]",
    "key_signer": "ODkyMzI0",
    "text": "Cláusula que será destacada"
}
ParâmetroDescrição
key_signerChave do signatário
email (obrigatório)E-mail do signatário cadastrado
textCláusula que será destacada

Enviar documento para assinatura

POST/documents/{UUID-DOCUMENT}/sendtosigner

Testar endpoint 🧪

Esse objeto enviará o documento para assinatura, ou seja, o documento entrará na fase 'Aguardando assinaturas', onde, a partir dessa fase, os signatários poderão assinar os documentos.

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

{
    "message": "{mensagem_para_o_signatário}",
    "skip_email": "1",
    "workflow": "0",
    "tokenAPI": "{token-user}"
}

{
    "message": "File sent to successfully signing"
}
ParâmetroDescrição
message (opcional)Mensagem que será enviada para os signatários, caso o parâmetro skip_email esteja definido como 0
skip_email (obrigatório)Opções:
0 = Os signatários serão avisados por e-mail que precisam assinar um documento.
1 = O e-mail não será disparado.
ATENÇÃO: Nos casos em que o EMBED ou a ASSINATURA PRESENCIAL estiver sendo usado, ou seja, quando o signatário for efetuar a assinatura diretamente do seu website ou em seu Tablet, o parâmetro skip_email DEVERÁ ser definido como 1
workflow (obrigatório)Opções:
0 = Para não seguir o workflow.
1 = Para seguir o workflow.
Caso o parâmetro workflow seja definido como 1, o segundo signatário só receberá a mensagem de que há um documento aguardando sua assinatura DEPOIS que o primeiro signatário efetuar a assinatura, e assim sucessivamente.
Porém, caso seja definido como 0, todos os signatários poderão assinar o documento ao mesmo tempo.

Cancelar um documento

POST/documents/{UUID-DOCUMENT}/cancel

Testar endpoint 🧪


Esse objeto irá cancelar o documento.

{
    "Content-Type": "application/json",
    "tokenAPI": "{token-user}"
}

{
	"comment": "comentário sobre o cancelamento"
}

{
    "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": "6",
    "statusName": "Cancelado",
    "statusComment": "Comentário sobre cancelamento",
    "whoCanceled": "E-mail de quem cancelou o documento"
}
ParâmetroDescrição
comment (opcional)Insira um comentário sobre o cancelamento.

DOWNLOAD de um documento

POST/documents/{UUID-DOCUMENT}/download

Testar endpoint 🧪

Esse objeto irá gerar uma URL final para download do documento.

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

{
	"type": "{type}",
	"language": "pt",
  "document": "true" 
}

{
    "url": "https://secure.d4sign.com.br/CODIGO",
    "name": "teste.pdf"
}
ParâmetroDescrição
type (opcional)Para realizar o download do arquivo completo, escolha ZIP nesse atributo. Para realizar o download apenas do PDF, escolha PDF nesse atributo.
language (opcional)Para realizar o download do arquivo em inglês, escolha en nesse atributo. Para realizar o download do arquivo em português, escolha pt nesse atributo.
document
(opcional)		true: Traz na resposta as fotos do documento do signatário em base 64 caso tenho sido usada a autenticação documento com foto ou foto e selfie.
false: não traz na resposta as fotos do documento do signatário em base 64.

Reenviar link de assinatura

POST/documents/{UUID-DOCUMENT}/resend

Testar endpoint 🧪

Esse objeto irá reenviar o link de assinatura para o signatário.

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


{
    "email": "[email protected]" ou "551987651213",
    "key_signer": "NwUj="
}

{
    "message": "Message sent"
}
ParâmetroDescrição
email ou WhatsApp (obrigatório)Email ou WhatsApp do signatário que deverá receber o link novamente.
key_signer (obrigatório)Chave do signatário.

O link de assinatura de um documento poderá ser reenviado nos seguintes intervalados de tempo:

O 1º em 1 min,

O 2º em 5 min,

O 3º em 30 min,

E a partir disso o link poderá ser reenviado de 60 em 60 min.

Listar templates

POST/templates

Testar endpoint 🧪

Esse objeto irá retornar todos os templates criados em sua conta.

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


{
    "id": "MzE=",
    "name": "Nome do template",
    "variables": 
    	array {
    		"0": "variavel 1",
		"1": "variavel 2",
		"2": "variavel 3"
	}

}

Documento a partir do template HTML

POST/documents/{UUID-SAFE}/makedocumentbytemplate

Testar endpoint 🧪

Esse objeto irá gerar um documento em seu cofre a partir de um template.

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


{
    "name_document": "Nome do documento",
    "uuid_folder (opcional)": "{UUID DA PASTA}",
    "templates": {
	    "id_template 1": {
	    	"variavel 1": "valor 1",
	    	"variavel 2": "valor 2",
	    	{...}
	    }
   }
}

{
    "uuid": "9f08bf18-bf4b-410f-9701-c286e5b1cad1"
}

Exemplo id_template:


"MzE=" => array (
			'NOME_CLIENTE' => 'João',
			'CPF' => '222222222-22')
ParâmetroDescrição
name_document (opcional)Define o nome do documento. Se não for preenchido, o documento terá o nome "Documento"
uuid_folder (opcional)Para que o documento fique armazenado dentro da pasta, informe o UUID dela.
id_template (obrigatório)Array contendo o ID do template na CHAVE e as variáveis no VALUE.
Lembrando que você deverá informar pelo menos um template. As variáveis dos campos personalizados (ex.: arrastando, bloco, NOME_CONTRATANTE, etc.) precisam ser informadas exatamente iguais ao cadastro. Ex.: 'NOME_CONTRATANTE' => 'fulano' irá substituir o campo personalizado NOME_CONTRATANTE por fulano. O sistema é case sensitive, ou seja, você deverá respeitar letras maiúsculas e minúsculas.

Obs.: Para criar o documento em um cofre compartilhado a partir de um template HTML, será preciso ter as permissões de acesso "Administrador" ou "Padrão".

Documento a partir do template WORD

POST/documents/{UUID-SAFE}/makedocumentbytemplateword

Testar endpoint 🧪

Esse objeto irá gerar um documento em seu cofre a partir de um template word.

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


{
    "name_document": "Nome do documento",
    "uuid_folder (opcional)": "{UUID DA PASTA}",
    "templates": {
	    "(Insira o ID do template)": {
	    	"variavel 1": "valor 1",
	    	"variavel 2": "valor 2",
	    	{...}
	    }
   }
}

{
    "uuid": "9f08bf18-bf4b-410f-9701-c286e5b1cad1"
}

Exemplo id_template:


"MzE=" => array (
			'NOME_CLIENTE' => 'João',
			'CPF' => '222222222-22')
ParâmetroDescrição
name_document (opcional)Define o nome do documento. Se não for preenchido, o documento terá o nome "Documento"
uuid_folder (opcional)Para que o documento fique armazenado dentro da pasta, informe o UUID dela. Se não for preenchido, o documento será salvo no cofre informado na requisição.
id_template (obrigatório)Array contendo o ID do template na CHAVE e as variáveis no VALUE.
Lembrando que você deverá informar pelo menos um template. As variáveis dos campos personalizados (ex.: NOME_CONTRATANTE, etc.) precisam ser informadas exatamente iguais ao cadastro. Ex.: 'NOME_CONTRATANTE' => 'João' irá substituir o campo personalizado NOME_CONTRATANTE por "João". O sistema é case sensitive, ou seja, você deverá respeitar letras maiúsculas e minúsculas.

🚧

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}

Obs.: Para criar o documento em um cofre compartilhado a partir de um template word, será preciso ter as permissões de acesso "Administrador" ou "Padrão".

Download em formato PDF/A

POST documents/{uuid-document}/download

Testar endpoint 🧪

Esse objeto irá gerar uma URL final para download do documento convertido em pdf-a

{   
    "type": "pdfa",
	"language": "pt"
}

{
   "url": "https://secure.d4sign.com.br/CODIGO",
   "name": "teste.pdf"
}

Parâmetros de requisição

ParâmetroDescrição
typeEscolha pdfa nesse atributo.
language (Opcional)Para realizar o download do arquivo em inglês, escolha en nesse atributo. Para realizar o download do arquivo em português, escolha pt nesse atributo.

Download de Documentos e Certificados de Assinaturas Desmembrados

Primeiro, precisamos listar os anexos vinculados a um documento principal através do seguinte endpoint:

GET documents/{uuid-main-document}/listslaves

Testar endpoint 🧪

Para isso, utilizaremos os seguintes parâmetros:

{
    "Accept": "application/json"
}


[
    {
        "total_documents": 3,
        "total_in_this_page": 3,
        "current_page": 1,
        "total_pages": 1
    },
    {
        "uuidDoc": "7ba92714-c163-4bc7-84f0-e638601f6e19",
        "nameDoc": "Anexo 3 - Planta.pdf",
        "type": "application/pdf",
        "size": "778748",
        "pages": null
    },
    {
        "uuidDoc": "aea20243-475a-43fc-8ba5-c02f6eec76fc",
        "nameDoc": "Anexo 1- IPTU.pdf",
        "type": "application/pdf",
        "size": "60795",
        "pages": "4"
    },
    {
        "uuidDoc": "51a4df32-a637-4c12-adf1-c8e3ecfc5aef",
        "nameDoc": "Anexo 2 - Financiamento.pdf",
        "type": "application/pdf",
        "size": "434198",
        "pages": "3"
    }
]

Em seguida, você precisará efetuar o download de documentos anexos vinculados a um documento principal e suas hashes (certificados de assinatura), utilizando os parâmetros abaixo:

POST documents/{uuid-main-document}/downloadlist

Testar endpoint 🧪


{
    "Accept": "application/json"
}


{  
	"language": "pt",  
            "type":"pdfa",  
	"documents": {  
		"uuid-slave-document1": "1/0",  
		"uuid-slave-document2"": "1/0" 
	}  
}

{
   "url": "https://secure.d4sign.com.br/CODIGO"
}

Parâmetros de requisição

ParâmetroDescrição
language - OpcionalPara realizar o download do arquivo em inglês, escolha en nesse atributo. Para realizar o download do arquivo em português, escolha pt nesse atributo.
type - OpcionalPara fazer em download em pdf, exclua o atributo, mas para baixar em no formato pdf-a, escolha "pdfa" nesse atributo.
documentsPode-se colocar mais Uuid de arquivos, caso necessário.
uuid-slave-document1Onde o uuid_arquivo é o uuid do arquivo que se quer baixar (doc principal ou anexo) e o 1-(true)/0-(false) é se quer ou não a hash daquele documento.

O retorno desse POST é a URL usada para o download do zip com os arquivos e hashes enviados na lista (que é o padrão para fazer download na nossa API).

O documento precisa estar finalizado, ou seja, todos os signatários devem ter assinado o documento.

Posicionamento XY de Rubricas

Após configurar o template na plataforma e gerenciar seus tokens para o tipo "Rubrica"; você deve:

  1. Seguir a documentação para Listar templates em https://docapi.d4sign.com.br/reference/listar-templates
  2. O resultado gerado irá listar todos os seus templates. Então você deve copiar o código "id" do template que acabou de configurar;
  3. Seguir a documentação para Listar Cofres em https://docapi.d4sign.com.br/reference/listar-cofres
  4. O resultado irá listar todos os seus cofres próprios e compartilhados. Então você deve copiar o "uuid_safe", que é o código do cofre que deseja armazenar o arquivo.
  5. Em seguida utilizar o "uuid_safe" para roda a seguinte requisição:

POST documents/{uuid-safe}/createrubricintemplateword

Testar endpoint 🧪


A requisição irá criar o documento no cofre selecionado e deve ser possível ver as rubricas na página da seguinte forma:

{   "name_document": "teste Posicionamento XY de Rubricas",
    "templates": {
    "MTE5Mg==": {
            "nome_completo": "[email protected]",
            "endereço_residencial": "[email protected]",
            "bairro": "[email protected]",
            "cidade": "[email protected]",
            "CEP": "[email protected]",
            "CPF": "[email protected]",
            "CNPJ": "[email protected]"
        }
    }
}

{
    "message": "success",
    "uuid": "74d61e87-f1fb-4ae0-ba8e-d2e0c34e8b6c"
}

Parâmetros de requisição

ParâmetroDescrição
name_documentNome que deseja dar ao documento no cofre.
templatesLista de templates, podendo ser mais de um.
MTE5Mg==Uuid do template e seus respectivos tokens:
endereço_residencialCampo do 1º token do template e como retorno irá trazer no campo a rubrica do e-mail do signatário correspondente.
bairroCampo do 2º token do template e como retorno irá trazer no campo a rubrica do e-mail do signatário correspondente.
cidadeCampo do 3º token do template e como retorno irá trazer no campo a rubrica do e-mail do signatário correspondente.
CEPCampo do 4º token do template e como retorno irá trazer no campo a rubrica do e-mail do signatário correspondente.
CPFCampo do 5º token do template e como retorno irá trazer no campo a rubrica do e-mail do signatário correspondente.
CNPJCampo do 6º token do template e como retorno irá trazer no campo a rubrica do e-mail do signatário correspondente.

O retorno desse POST é o documento disponível na plataforma com as rubricas posicionadas em cada campo definido na configuração do token, com o respectivo e-mail do signatário, além do UUID do documento.

Download Documentos Base 64

POST documents/{uuid-document}/download

Testar endpoint 🧪

Esse objeto irá gerar uma URL final para download do documento convertido para base 64.

{   
    "type": "pdf",
	"language": "pt",
    "encoding":true
}

{
   "url": "https://secure.d4sign.com.br/CODIGO",
   "name": "teste.pdf"
}

Parâmetros de requisição

ParâmetroDescrição
typeEscolha pdf nesse atributo.
language (Opcional)Para realizar o download do arquivo em inglês, escolha en nesse atributo. Para realizar o download do arquivo em português, escolha pt nesse atributo.
encodingEscolha "1" nessa atributo para realizar o download em base 64.

Após baixar o arquivo utilizando a URL gerada nessa requisição, ainda será necessário tratá-la isolando os "&" na URL (colocar o & comercial entre aspas na URL) para que o download possa ser feito utilizando o PowerShell, por exemplo, no seguinte formato:

curl.exe {URL TRATADA} > {NOME DO DOCUMENTO}.txt

Deste modo, o arquivo ficará disponível na pasta local no formato base 64.

UPLOAD de Big File - Documento principal acima de 20MB

POST /documents/{UUID-SAFE}/uploadbigfile

Testar endpoint 🧪

Esse objeto realizará o UPLOAD do seu documento acima de 20MB e menor que 500 MB para os servidores da D4Sign.

🚧

Atenção!

Após o UPLOAD, o documento será criptografado em nossos cofres e carimbado com um número de série.

Após o processamento um preview será gerado. O processamento será realizado em background, ou seja, a requisição não ficará bloqueada.

Todos os documentos ficam armazenados em COFRES criptografados, ou seja, o parâmetro UUID-SAFE é obrigatório e determina em qual cofre o documento ficará armazenado.

{
    "Content-Type": "multipart/form-data;",
    "tokenAPI": "{token-user}"
}

{
    "file": "FILE(form-data)",
    "uuid_folder": "{UUID DA PASTA}"
}

{
    "uuid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx"
}
ParâmetroDescrição
File (obrigatório)Arquivo que será enviado para os servidores da D4Sign. MIME Types aceitos PDF,DOC,DOCX,JPG,PNG,BMP
uuid_folder (opcional)Para que o documento fique armazenado dentro da pasta, informe o UUID dela.

Documento a partir do template WORD com mais de 1 preenchedor

POST/documents/{UUID-SAFE}/makedocumentbytemplateword

Testar endpoint 🧪

Esse objeto irá gerar um documento em seu cofre a partir de um template word.

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


{
    "name_document": "Nome do documento",
    "uuid_folder (opcional)": "{UUID DA PASTA}",
  
    "templates": {
       "id_template": {
         
        "persona 1":{
	    			"variavel 1": "valor 1",
	    			"variavel 2": "valor 2",
	    	{...},
        
        "persona 2":{
	    			"variavel 1": "valor 1",
	    			"variavel 2": "valor 2",
	    	{...},
         
         "tokens_gerais":{
	    			"variavel 1": "valor 1",
	    			"variavel 2": "valor 2",
	    	{...}
        
	    }
   }
}

{
    "uuid": "xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}

Para encontrar o "id_template", o primeiro passo é utilizar a requisição de listar templates disponível em: https://docapi.d4sign.com.br/reference/listar-templates

Exemplo id_template:


{
   "name_document":"Modelo template para contrato com 2 preenchedores API",
   "templates":
      {
         "MTIwMDcy=":{
            "organizador": {
               "nome_completo":"VALOR TESTE",
                "nome":"VALOR TESTE",
                "endereco_organizador":"VALOR TESTE",
                "valor_total":"VALOR TESTE",
                "nome_da_empresa":"VALOR TESTE",
                "nome_do_representante_da_empresa":"VALOR TESTE",
                "endereco_da_empresa":"VALOR TESTE",
                "telefone_da_empresa":"VALOR TESTE 2",
                "cargo_do_representante_da_empresa":"VALOR TESTE",
                "e_mail_do_organizador_do_evento":"VALOR TESTE"
            },
            "cliente": {
                "nome_completo":"VALOR TESTE 1",
                "nome":"VALOR TESTE 1",
                "endereco_cliente":"VALOR TESTE 1",
                "endereco_do_cliente":"VALOR TESTE 1",
                "telefone_do_cliente":"VALOR TESTE 1",
                "e_mail_do_cliente":"VALOR TESTE 1",
                "numero_de_cpf_ou_cnpj_do_cliente":"VALOR TESTE 1"
            },
            "tokens_gerais": {
                "endereco":"VALOR Tokens Gerais",
                "nome_completo":"VALOR Tokens Gerais",
                "nome_do_evento":"VALOR Tokens Gerais",
                "data_assinatura":"VALOR Tokens Gerais",
                "nome_evento":"VALOR Tokens Gerais",
                "data_evento":"VALOR Tokens Gerais",
                "hora_inicio_evento":"VALOR Tokens Gerais",
                "hora_termino_evento":"VALOR Tokens Gerais",
                "local_evento":"VALOR Tokens Gerais",
                "descricao":"VALOR Tokens Gerais",
                "estado":"VALOR Tokens Gerais",
                "local_e_data_da_assinatura":"VALOR Tokens Gerais"
            }
        }
      }
}
ParâmetroDescrição
name_document (opcional)Define o nome do documento. Se não for preenchido, o documento terá o nome "Documento".
uuid_folder (opcional)Para que o documento fique armazenado dentro da pasta, informe o UUID dela. Se não for preenchido, o documento será salvo no cofre informado na requisição.
id_template (obrigatório)Array contendo o ID do template na CHAVE e as variáveis no VALUE.
persona (opcional)Se o template tiver mais de um preenchedor esse campo é obrigatório. Você poderá adicionar quantos preenchedores quiser. Caso dois preenchedores possam preencher o mesmo campo, deverá ser adicionado em "tokens_gerais", desta forma iremos salvar o primeiro valor preenchido.
Lembrando que você deverá informar pelo menos um template. As variáveis dos campos personalizados (ex.: NOME_CONTRATANTE, etc.) precisam ser informadas exatamente iguais ao cadastro. Ex.: 'NOME_CONTRATANTE' => 'João' irá substituir o campo personalizado NOME_CONTRATANTE por "João". O sistema é case sensitive, ou seja, você deverá respeitar letras maiúsculas e minúsculas.

🚧

Importante

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

Obs.: Para criar o documento em um cofre compartilhado a partir de um template word, será preciso ter as permissões de acesso "Administrador" ou "Padrão".

Agendamento de envio de documentos para assinatura

POST/documents/{uuid-document}/scheduling

Testar endpoint 🧪

Esse objeto irá agendar o envio do documento.

{
  "message":"Mensagem opcional de envio",
  "workflow":"1",
  "scheduling_date":"2026/09/10",
  "scheduling_time":"21:00",
  "urgent_document":"0"
}

{
    "message": "Scheduling created successfully",
    "mensagem_pt": "Agendamento criado com sucesso."
}
ParâmetroDescrição
uuid-document (obrigatório)uuid do documento principal.
message (opcional)Mensagem que será enviada para os signatários no envio.
workflow (obrigatório)1 = Para não seguir a ordem de assinaturas e 2 = Para seguir a ordem de assinaturas.
scheduling_date (obrigatório)Data de agendamento. Deve ser igual ou superior a data atual e no formato americano aaaa/mm/dd
scheduling_time (obrigatório)Horário de agendamento, sempre entre 6:00 e 22:00 e de 1 em 1 hora, ou seja, 11:00 / 12:00 / 13:00 / etc. Caso a data de agendamento seja o dia atual, o horário de agendamento tem que ser superior ao horário atual.
urgent_document (opcional)0 = não é um documento urgente e 1 = é um documento urgente.

Updated 5 days ago