Confira os endpoints para configuração de documentos

Endpoints Documentos

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

Listar todos os documentos

`GET`/documents

📘
O resultado será de 500 documentos por páginas
Utilize o parametro PG na URL para paginar o resultado.
Ex.: API link

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

Parâmetros de 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âmetro	Descriçã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.:
Ex.: API link

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âmetro	Descriçã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âmetro	Descriçã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. \n2= 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âmetro	Descriçã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âmetro	Descriçã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âmetro	Descriçã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âmetro	Descriçã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âmetro	Descrição
key_signer	Chave do signatário
email (obrigatório)	E-mail do signatário cadastrado
text	Clá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âmetro	Descriçã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 (ordem de assinatura).
	1 = Para seguir o workflow (ordem de assinatura).
	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âmetro	Descriçã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âmetro	Descriçã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 \n(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. Trazendo assim 3 arquivos: a frente do documento, o verso do documento e a foto selfie, caso tenho sido solicitada na autenticação. \nfalse: 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âmetro	Descriçã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âmetro	Descriçã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âmetro	Descriçã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.: API link
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âmetro	Descrição
type	Escolha 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.

Listar Anexos Vinculados a um Documento Principal

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

Download de Documentos, Anexos e Certificados de Assinaturas Desmembrados

Em seguida, você poderá 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":"pdf",  
	"documents": {  
		"uuid-slave-document1": "0",  
		"uuid-slave-document2": "0" 
	}  
}

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

Parâmetros de requisição

Parâmetro	Descrição
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.
type - Opcional	Para fazer em download em pdf, exclua o atributo, mas para baixar no formato pdf-a, escolha "pdfa" nesse atributo.
documents	Pode-se colocar mais Uuid de arquivos, caso necessário.
uuid-slave-document1	Onde o uuid-slave-document é o uuid do arquivo que se quer baixar (pode ser o doc principal ou anexo) e o 1-(true)/0-(false): se quer ou não baixar a hash (certificado digital) junto ao 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:

Seguir a documentação para Listar templates em https://docapi.d4sign.com.br/reference/listar-templates
O resultado gerado irá listar todos os seus templates. Então você deve copiar o código "id" do template que acabou de configurar;
Seguir a documentação para Listar Cofres em https://docapi.d4sign.com.br/reference/listar-cofres
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.
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âmetro	Descrição
name_document	Nome que deseja dar ao documento no cofre.
templates	Lista de templates, podendo ser mais de um.
MTE5Mg==	Uuid do template e seus respectivos tokens:
endereço_residencial	Campo do 1º token do template e como retorno irá trazer no campo a rubrica do e-mail do signatário correspondente.
bairro	Campo do 2º token do template e como retorno irá trazer no campo a rubrica do e-mail do signatário correspondente.
cidade	Campo do 3º token do template e como retorno irá trazer no campo a rubrica do e-mail do signatário correspondente.
CEP	Campo do 4º token do template e como retorno irá trazer no campo a rubrica do e-mail do signatário correspondente.
CPF	Campo do 5º token do template e como retorno irá trazer no campo a rubrica do e-mail do signatário correspondente.
CNPJ	Campo 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âmetro	Descrição
type	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.
encoding	Escolha "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âmetro	Descriçã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âmetro	Descriçã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âmetro	Descriçã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.

Listar Respostas do Novo Power Form

`GET` /documents/{uuid_documento}/powerformresponses

Testar endpoint 🧪

Esse objeto retornará apenas o documento solicitado.

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

{
    "uuid_documento_gerado": "abcd-efgh-ijkl-123456789123",
    "nome_documento": "Documento Teste",
    "respostas": [
        {
            "email_preenchedor": "e-mail do preenchedor 1",
            "dt_cadastro": "2025-03-24 17:04:10",
            "campos_respostas": {
                "toke1": "Resposta1",
                "token2": "Resposta2"
            }
        },
        {
            "whatsapp_preenchedor": "whatsapp do preenchedor 2",
            "dt_cadastro": "2025-03-24 17:03:37",
            "campos_respostas": {
                "CPF": "12345678900",
                "Cidade": "Cidade A",
                "Plano": "Plano A"
            }
        }
    ]
}

Parâmetro	Descrição
UUID-DOCUMENTO (obrigatório)	UUID do documento que deverá ter as respostas listadas.

Adicionar Trust ID (Verificação Extra)

Este endpoint ativa o método de verificação de identidade Trust ID para um signatário autenticado usando um documento com foto ou um documento com foto e selfie.

🚧
Importante
Não se esqueça de incluir tokenAPI e cryptKey na sua requisição.

O Trust ID permite adicionar uma camada extra de segurança ao seu processo de assinatura. Uma vez ativado, o signatário deve enviar uma foto do seu documento de identidade (e uma selfie, se exigido). O recurso Trust ID irá escanear e validar se as informações do documento correspondem à foto.

O processo é dividido em duas etapas:

Registrar o signatário no documento com docauth ou docauthandselfie ativado.

Adicionar o Trust ID para um signatário no documento utilizando o endpoint /addtrustID.

Adicionando signatários a um documento

O primeiro passo é adicionar um signatário ao seu documento, para que você possa fornecer as informações de e-mail ao usar o endpoint do Trust ID.

`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)(opcional),
        },
        {...}
        ]
}

{
    "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âmetro	Descrição
email (obrigatório)	E-mail do signatário
act (obrigatório)	Ação da assinatura. Valores permitidos:<br>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<br>1 = Assinatura com Certificado ICP-Brasil
assinatura_presencial (obrigatório)	1 = Assinatura presencial<br>0 = Não presencial
docauth (opcional)	1 = Exige documento com foto<br>0 = Não exige
docauthandselfie (opcional)	1 = Documento + selfie<br>0 = Não exige selfie
embed_methodauth (opcional)	Método de autenticação: email, password, sms, whats
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
certificadoicpbr_tipo (opcional)	1 = Qualquer certificado<br>2 = e-CPF<br>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	Nome obrigatório se auth_pix = 1
auth_pix_cpf	CPF obrigatório se auth_pix = 1
sms-number (obrigatório)	NOVO número de SMS do signatário
key-signer	Chave do signatário
videoselfie	1 = Exige vídeo selfie
d4sign_score (opcional)	Ativa D4Sign Score. Requer CNH + docauthandselfie = 1 ou videoselfie = 1
d4sign_score_nome	Nome obrigatório se d4sign_score = 1
d4sign_score_cpf	CPF obrigatório se d4sign_score = 1
d4sign_score_similarity	Nível de similaridade exigida (min: 70, max: 90)

🚧
Importante
Certifique-se de que o parâmetro docauth ou docauthandselfie esteja definido como "1" ao registrar o signatário. Isso é necessário antes de usar o endpoint /addtrustid

Adicionando Trust ID ao(s) signatário(s) na lista

A segunda etapa é adicionar a validação Trust ID para cada signatário desejado na lista:

`POST`/documents/{UUID-DOCUMENT}/addtrustid

Testar Endpoint 🧪

{
  "trustid": [
    {
      "email": "[email protected]",  (obrigatório)
      "name": "Primeiro nome do signatário",  (opcional)  
      "last_name": "Sobrenome do signatário", (opcional)    
      "document_type": 1, (obrigatório)
      "document_number": "12a34b567c" (opcional)
    },
    {
      // ... outros signatários, se necessário
    }
  ]
}

{
    "message": {
        "success": "1",
        "data": [
            {
                "email": "[email protected]",
                "name": "Signer's first name",
                "last_name": "Signer's last Name",
                "document_type": 1,
                "document_number": "12a34b567c"
            }
        ]
    }
}

Parameter	Description
uuid-document (obrigatório)	UUID do documento
email (obrigatório)	E-mail do signatário ao qual o Trust ID será adicionado. O signatário deve já ter sido adicionado ao documento, com o ponto de autenticação 'Documento com foto' ou 'Documento com foto + Selfie' ativado.
name (opcional)	Primeiro nome do signatário
last _name (opcional)	Sobrenome do signatário
document_type (obrigatório)	1 = Documento de identidade nacional, 2 = Passaporte, 3 = Permissão de residência, 4 = Outro.
document_number (opcional)	Número do documento diretamente associado ao document_type.

✅ Após adicionar os dados do Trust ID, o signatário receberá uma solicitação para enviar a foto do seu documento (e uma selfie, se exigido). Uma vez validado, o processo de assinatura poderá prosseguir normalmente.

Remover Trust ID

Este endpoint remove a verificação extra do Trust ID de um ou mais signatários previamente adicionados a um documento.

`POST`/documents/{UUID-DOCUMENT}/removetrustid

Testar Endpoint 🧪

{
    "trustid": [

        {
            "email": "email@domínio.com"
        }
        
    ]
}

{
    "message": {
        "success": "1",
        "data_message": "TrustID removed",
        "data": [
            {
                "email": "email@domínio.com"
            }
        ]
    }
}

Parameter	Description
uuid-document (obrigatório)	UUID do documento principal
email (obrigatório)	Endereço de e-mail do signatário cuja validação Trust ID será removida.

Endpoints Documentos

Importante

Listar todos os documentos

GET/documents

Parâmetros de requisição

Listar um documento específico

GET /documents/{UUID-DOCUMENT}

Verificar as dimensões de um documento

GET /documents/{UUID-DOCUMENT}/dimensions

Listar todos os documentos de uma fase

GET /documents/{ID-FASE}/status

UPLOAD de um documento principal

POST /documents/{UUID-SAFE}/upload

Atenção!

UPLOAD de um documento anexo ao principal

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

UPLOAD de um documento principal (Binário)

POST/documents/{UUID-SAFE}/uploadbinary

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

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

UPLOAD de um hash de documento (HASH)

POST/documents/{UUID-SAFE}/uploadhash

Destacar cláusulas

POST/documents/{UUID-DOCUMENT}/addhighlight

Enviar documento para assinatura

POST/documents/{UUID-DOCUMENT}/sendtosigner

Cancelar um documento

POST/documents/{UUID-DOCUMENT}/cancel

DOWNLOAD de um documento

POST/documents/{UUID-DOCUMENT}/download

Reenviar link de assinatura

POST/documents/{UUID-DOCUMENT}/resend

Listar templates

POST/templates

Documento a partir do template HTML

POST/documents/{UUID-SAFE}/makedocumentbytemplate

Documento a partir do template WORD

POST/documents/{UUID-SAFE}/makedocumentbytemplateword

Importante

Download em formato PDF/A

POST documents/{uuid-document}/download

Parâmetros de requisição

Listar Anexos Vinculados a um Documento Principal

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

Download de Documentos, Anexos e Certificados de Assinaturas Desmembrados

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

Parâmetros de requisição

Posicionamento XY de Rubricas

POST documents/{uuid-safe}/createrubricintemplateword

Parâmetros de requisição

Download Documentos Base 64

POST documents/{uuid-document}/download

Parâmetros de requisição

UPLOAD de Big File - Documento principal acima de 20MB

POST /documents/{UUID-SAFE}/uploadbigfile

Atenção!

Documento a partir do template WORD com mais de 1 preenchedor

POST/documents/{UUID-SAFE}/makedocumentbytemplateword

Importante

Agendamento de envio de documentos para assinatura

POST/documents/{uuid-document}/scheduling

Listar Respostas do Novo Power Form

GET /documents/{uuid_documento}/powerformresponses

Adicionar Trust ID (Verificação Extra)

Importante

POST/documents/{UUID-DOCUMENT}/createlist

Importante

POST/documents/{UUID-DOCUMENT}/addtrustid

Remover Trust ID

POST/documents/{UUID-DOCUMENT}/removetrustid

`GET`/documents

`GET` /documents/{UUID-DOCUMENT}

`GET` /documents/{UUID-DOCUMENT}/dimensions

`GET` /documents/{ID-FASE}/status

`POST` /documents/{UUID-SAFE}/upload

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

`POST`/documents/{UUID-SAFE}/uploadbinary

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

`POST`/documents/{UUID-SAFE}/uploadhash

`POST`/documents/{UUID-DOCUMENT}/addhighlight

`POST`/documents/{UUID-DOCUMENT}/sendtosigner

`POST`/documents/{UUID-DOCUMENT}/cancel

`POST`/documents/{UUID-DOCUMENT}/download

`POST`/documents/{UUID-DOCUMENT}/resend

`POST`/templates

`POST`/documents/{UUID-SAFE}/makedocumentbytemplate

`POST`/documents/{UUID-SAFE}/makedocumentbytemplateword

`POST` documents/{uuid-document}/download

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

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

`POST` documents/{uuid-safe}/createrubricintemplateword

`POST` documents/{uuid-document}/download

`POST` /documents/{UUID-SAFE}/uploadbigfile

`POST`/documents/{UUID-SAFE}/makedocumentbytemplateword

`POST`/documents/{uuid-document}/scheduling

`GET` /documents/{uuid_documento}/powerformresponses

`POST`/documents/{UUID-DOCUMENT}/createlist

`POST`/documents/{UUID-DOCUMENT}/addtrustid

`POST`/documents/{UUID-DOCUMENT}/removetrustid