Confira os endpoints para configuração de documentos

Document Endpoints

🚧
Important
Don’t forget to include the tokenAPI and cryptKey parameters in your request.
Ex.: API link

List all documents

`GET`/documents

📘
The response returns up to 500 documents per page.
Use the pg parameter in the URL to paginate the result.
Ex.: API link

The first block of the response will display the total number of available pages.

Request Parameters

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

[{
    "uuidDoc": "9f08bf18-bf4b-410f-9701-c286e5b1cad1",
    "nameDoc": "test.pdf",
    "type": "application/pdf",
    "size": "118990",
    "pages": "6",
    "uuidSafe": "06b3ddb1-abc9-4ab8-b944-0d7c940486af",
    "safeName": "Support",
    "statusId": "3",
    "statusName": "Waiting for Signatures",
    "statusComment": "Cancellation comment",
    "whoCanceled": "Email of the user who canceled the document"
},
{...}]

List a specific document

`GET`/documents/{UUID-DOCUMENT}

Test Endpoint 🧪

Esse objeto retornará apenas o documento solicitado.

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

{
    "uuidDoc": "9f08bf18-bf4b-410f-9701-c286e5b1cad1",
    "nameDoc": "test.pdf",
    "type": "application/pdf",
    "size": "118990",
    "pages": "6",
    "uuidSafe": "06b3ddb1-abc9-4ab8-b944-0d7c940486af",
    "safeName": "Support",
    "statusId": "3",
    "statusName": "Waiting for Signatures",
    "statusComment": "Cancellation comment",
    "whoCanceled": "Email of the user who canceled the document"
}

Parameter	Description
UUID-DOCUMENT (required)	UUID of the document to be retrieved.

Get document dimensions

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

This endpoint returns the width and height of each page in the document.

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

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

List all documents by phase

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

Test endpoint 🧪

This endpoint returns all documents currently in the specified phase.

📘
The response will return up to 500 documents per page.
Use the pg parameter in the URL to paginate the result.
Ex.: API link

The first block of the response will display the total number of available pages.

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

{
    "uuidDoc": "9f08bf18-bf4b-410f-9701-c286e5b1cad1",
    "nameDoc": "test.pdf",
    "type": "application/pdf",
    "size": "118990",
    "pages": "6",
    "uuidSafe": "06b3ddb1-abc9-4ab8-b944-0d7c940486af",
    "safeName": "Support",
    "statusId": "3",
    "statusName": "Waiting for Signatures",
    "statusComment": "Cancellation comment",
    "whoCanceled": "Email of the user who canceled the document"
}

Parameter	Description
ID-PHASE (required)	The phase ID used to filter documents.
	ID 1 - Processing
	ID 2 - Waiting for Signers
	ID 3 - Waiting for Signatures
	ID 4 - Completed
	ID 5 - Archived
	ID 6 - Canceled
	ID 7 - Editing

Upload a main document

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

Test Endpoint 🧪

This endpoint uploads your document to D4Sign's servers.

🚧
Attention!
After the upload, the document will be encrypted in our vaults and stamped with a serial number.

A preview will be generated after processing. The processing runs in background, meaning the request will not be blocked.

All documents are stored in encrypted vaults. The UUID-SAFE parameter is required and determines which vault the document will be stored in.

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

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

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

Parameter	Description
File (required)	File to be uploaded to D4Sign's servers. Accepted MIME types: `PDF, DOC, DOCX, JPG, PNG, BMP`
uuid_folder (optional)	UUID of the folder where the document should be stored.
workflow (optional)	1 = Follow the signing order based on the `after_position` parameter in the signer registration request. \n2= 2 = Do not follow the signing order from `after_position`.

Upload an attachment to a main document

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

Test Endpoint 🧪

This endpoint uploads a file to D4Sign's servers as an attachment to the main document.

A preview will be generated after processing. The processing runs in background, meaning the request will not be blocked.

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

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

{
    "message": "File created"
}

Parameter	Description
File (required)	File to be uploaded to D4Sign’s servers. Accepted MIME types: `PDF,DOC,DOCX,JPG,PNG,BMP`

Upload a main document (Binary)

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

Test endpoint 🧪

This endpoint UPLOADS your document (as a base64-encoded binary) to D4Sign's servers.

After the UPLOAD, the document is encrypted and stored in our vaults, stamped with a serial number.

A preview is generated after processing. The process runs in background, so the request is non-blocking.

All documents are stored in encrypted VAULTS, and the UUID-SAFE parameter is required to define the destination vault.

{
    "base64_binary_file": "JVhsdCAdwesAD2dsadfASDQW...",
    "mime_type": "application/pdf",
    "name": "My sales contract",
    "uuid_folder": "{FOLDER UUID}"
}

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

Parameter	Description
base64_binary_file (required)	File content encoded in BASE64. NOTE: You must send the binary file encoded in BASE64 format.
mime_type (required)	MIME type of the file
name (optional)	File name
uuid_folder (optional)	UUID of the folder where the document should be stored

Upload an attachment (Binary)

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

Test Endpoint 🧪

This endpoint uploads a document (as a base64-encoded binary) as an attachment to an existing main document.

After upload, the document is encrypted and stamped with a serial number. Processing is handled asynchronously in background.

{
    "base64_binary_file": "JVhsdCAdwesAD2dsadfASDQW...",
    "mime_type": "application/pdf",
    "name": "My sales contract"
}

{
    "message": "File created"
}

Parameter	Descrição
base64_binary_file (required)	File content encoded in BASE64. NOTE: You must send the binary file encoded in BASE64 format.
mime_type (required)	MIME type of the file
name (optional)	File name

Upload a document hash (HASH)

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

Test Endpoint 🧪

This endpoint uploads a hash (SHA) of a document to D4Sign's servers.

After the upload, the hash will be encrypted and stored securely in our vaults, stamped with a serial number.

All hashes are stored in encrypted VAULTS. The UUID-SAFE parameter is required and determines which vault the hash will be stored in.

{
    "sha256": "13f2a91a9e85d5240ff32754eba41c02...",
    "sha512": "9ddd2c2659ae6cd6790d1f31780c904145bd80272b51cb...",
    "name": "My sales contract",
    "uuid_folder": "{FOLDER UUID}"
}

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

Parameter	Description
sha256 (required)	SHA-256 hash of the file in hexadecimal (64 characters).Attention: Do not send the hash in binary.
sha512 (required)	SHA-512 hash of the file in hexadecimal.(64 characters). Do not send the hash in binary.
name (optional)	Name of the document
uuid_folder (optional)	UUID of the folder where the hash should be stored

Highlight clauses

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

Test Endpoint 🧪

This endpoint registers the text content that should be highlighted for the signer.

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

{
    "key_signer": "NwYj=",
    "email": "[email protected]",
    "text": "Clause to be highlighted"
}

{
    "success": 1,
    "email": "[email protected]",
    "key_signer": "ODkyMzI0",
    "text": "Clause to be highlighted"
}

Parameter	Description
key_signer	Signer's key
email (obrigatório)	Email of the registered signer
text	Text of the clause to be highlighted

Send document for signing

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

Test Endpoint 🧪

This endpoint sends the document for signing. Once triggered, the document enters the "Waiting for Signatures" phase, enabling signers to access and sign it.

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

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

{
    "message": "File sent to successfully signing"
}

Parameter	Description
message (optional)	Custom message sent to signers (only if `skip_email` is set to `0` ).
skip_email (required)	Options:
	0 = Signers will receive an email notification to sign.
	1 = Email will not be sent.
	NOTE: If you're using EMBED or In-Person Signing (e.g. through your website or a tablet),`skip_email` MUST be set to 1
workflow (required)	Options:
	0 = Do not follow signing order. All signers can sign simultaneously.
	1 = Enforce signing order. Each signer will only receive the notification after the previous signer completes their signature.
	If the `workflow` parameter is set to `1`, the second signer will only receive the message that a document is awaiting their signature AFTER the first signer completes their signing — and so on sequentially.
	However, if it is set to `0`, all signers will be able to sign the document at the same time.

Cancel a document

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

Test Endpoint 🧪

This object will cancel the document.

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

{
	"comment": "comment about the cancellation"
}

{
    "uuidDoc": "9f08bf18-bf4b-410f-9701-c286e5b1cad1",
    "nameDoc": "test.pdf",
    "type": "application/pdf",
    "size": "118990",
    "pages": "6",
    "uuidSafe": "06b3ddb1-abc9-4ab8-b944-0d7c940486af",
    "safeName": "Support",
    "statusId": "6",
    "statusName": "Canceled",
    "statusComment": "Comment about cancellation",
    "whoCanceled": "Email of the user who canceled the document"
}

Parameter	Description
comment (optional)	Add a comment about the cancellation.

DOWNLOAD a document

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

Test Endpoint 🧪

This endpoint generates a final URL to download the document.

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

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

{
    "url": "https://secure.d4sign.com.br/CODE",
    "name": "test.pdf"
}

Parameter	Description
type (optional)	To download the full document package, use ZIP. To download only the PDF file, use PDF.
language (optional)	To download the file in English, use "en". To download it in Portuguese, use "pt".
document \n(optional)	true: Includes the signer's ID document photos in base64 format in the response, if identity verification by document/photo was used. This will return 3 files: front of the document, back of the document, and selfie (if requested). false: Does not include signer's ID document photos in the response.

Resend signature link

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

Test Endpoint 🧪

This endpoint will resend the signature link to the signer.

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

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

{
    "message": "Message sent"
}

Parameter	Description
email or WhatsApp (required)	Email or WhatsApp number of the signer who should receive the link again.
key_signer (required)	Signer's key.

The signature link can be resent using the following time intervals:

1st attempt: after 1 minute

2nd attempt: after 5 minutes

3rd attempt: after 30 minutes

After that: every 60 minutes

List templates

`POST`/templates

Test Endpoint 🧪

This endpoint will return all templates created in your account.

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

{
    "id": "MzE=",
    "name": "Template name",
    "variables": 
    	array {
    		"0": "variable 1",
		"1": "variable 2",
		"2": "variable 3"
	}

}

Document from HTML template

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

Test Endpoint 🧪

This endpoint will generate a document in your safe based on a template.

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

{
    "name_document": "Document name",
    "uuid_folder (opcional)": "{FOLDER UUID}",
    "templates": {
	    "id_template 1": {
	    	"variavel 1": "value 1",
	    	"variavel 2": "value 2",
	    	{...}
	    }
   }
}

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

Example template_id


"MzE=" => array (
			'CLIENT_NAME' => 'João',
			'ID' => '222222222-22')

Parameter	Description
name_document (optional)	Defines the document name. If not provided, the document will be named "Document" by default.
uuid_folder (optional)	To store the document inside a specific folder, provide its UUID.
id_template (required)	Array where the KEY is the template ID and the VALUE contains the variables.
	You must provide at least one template. The variable names for custom fields (e.g., drag-and-drop, block, CLIENT_NAME, etc.) must exactly match the template configuration. Example: `'CLIENT_NAME' => 'John'` will replace the placeholder CLIENT_NAME with John. The system is case sensitive—uppercase and lowercase must match exactly.

Note: To create a document in a shared safe from an HTML template, you must have either "Admin" or "Standard" access permissions.

Document from WORD template

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

Test Endpoint 🧪

This endpoint will generate a document in your vault based on a Word template.

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

{
    "name_document": "Document name",
    "uuid_folder (optional)": "{FOLDER UUID}",
    "templates": {
        "(Insert template ID)": {
            "variable_1": "value 1",
            "variable_2": "value 2",
            {...}
	    }
   }
}

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

Example template_id:


"MzE=" => array (
			'CLIENT_NAME' => 'John Doe',
			'ID' => '222222222-22')

Parameter	Description
name_document (optional)	Defines the document name. If not provided, the default name will be "Document"
uuid_folder (optional)	To store the document inside a specific folder, provide its UUID. If not provided, the document will be saved directly in the safe specified in the request.
id_template (required)	Array where the KEY is the template ID and the VALUE contains the variables.
	You must provide at least one template. The variables used in the custom fields (e.g., CLIENT_NAME, etc.) must match exactly as registered in the template. Example: 'CLIENT_NAME' => 'John Doe' will replace the CLIENT_NAME field with "John Doe". The system is case sensitive—uppercase and lowercase letters must match exactly.

🚧
Important
Do not forget to include both tokenAPI and cryptKey in your request.
Ex.: API link
Note: To create a document in a shared safe from a Word template, you must have either "Admin" or "Standard" access permissions..

Download in PDF/A format

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

Test Endpoint 🧪

This endpoint will generate a final URL for downloading the document converted to PDF/A.

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

{
   "url": "https://secure.d4sign.com.br/CODE",
   "name": "test.pdf"
}

Request Parameters

Parameter	Parameter
type	Choose "pdfa" in this field.
language (Opcional)	To download the file in English, choose "en". To download it in Portuguese, choose "pt".

List Attachments Linked to a Main Document

You can list the attachments linked to a main document using the following endpoint:

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

Test Endpoint 🧪

Use the following parameters:

{
    "Accept": "application/json"
}

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

Download of Individual Documents, Attachments and Signature Certificates

You can then download the attachments linked to a main document, as well as their hashes (signature certificates), using the parameters below:

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

Test Endpoint 🧪

{
    "Accept": "application/json"
}

{  
	"language": "pt",  
            "type":"pdf",  
	"documents": {  
		"uuid-slave-document1": "0",  
		"uuid-slave-document2": "0" 
	}  
}

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

Request Parameters

Parameter	Description
language - Optional	To download the file in English, choose "en". To download it in Portuguese, choose "pt".
type - Optional	To download in PDF format, omit this field. To download in PDF/A format, set this field to "pdfa".
documents	You can include multiple UUIDs if needed.
uuid-slave-document1	Where uuid-slave-document is the UUID of the file to download (can be main or attachment) and the 1-(true)/0-(false) flag determines whether to include the digital certificate hash with the file.

The response of this POST is the URL used to download a ZIP file with the selected documents and their hashes (this is the default method for downloading via our API).

⚠️ The document must be finalized, meaning all signers must have signed the document.

XY Positioning of Initials

After configuring the template on the platform and managing your tokens with the type “Initials”, you must:

Follow the documentation to List Templates at https://docapi.d4sign.com.br/reference/listar-templates
The result will list all your templates. Then, you should copy the “id” of the template you just configured;
Follow the documentation to List Safes at https://docapi.d4sign.com.br/reference/listar-cofres
The result will list all your personal and shared safes. Then, you should copy the “uuid_safe”, which is the code of the safe where you want to store the file.
Next, use the “uuid_safe” to run the following request:

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

Test Endpoint 🧪

This request will create the document in the selected safe and the initials should be visible on the page as follows:

{   "name_document": "XY Positioning of Initials test ",
    "templates": {
    "MTE5Mg==": {
            "complete_name": "[email protected]",
            "adress": "[email protected]",
            "city": "[email protected]",
            "ZIP CODE": "[email protected]",
            "ID": "[email protected]",
            "TAX ID": "[email protected]"
        }
    }
}

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

Request Parameters

Parameter	Description
name_document	The name you want to assign to the document in the safe.
templates	List of templates, allowing more than one.
MTE5Mg==	UUID of the template and its respective tokens:
complete_name	First template token field — the corresponding signer's email will be used for initials in this field.
adress	Second template token field — the corresponding signer's email will be used for initials in this field.
city	Third template token field — the corresponding signer's email will be used for initials in this field.
ZIP CODE	Fourth template token field — the corresponding signer's email will be used for initials in this field.
ID	Fifth template token field — the corresponding signer's email will be used for initials in this field.
TAX ID	Sixth template token field — the corresponding signer's email will be used for initials in this field.

The return from this POST is the document available on the platform with initials positioned in each field defined in the token configuration, with the respective signer email, in addition to the document UUID.

Download Document as Base64

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

Test Endpoint 🧪

This endpoint will generate a final URL to download the document encoded in Base64.

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

{
   "url": "https://secure.d4sign.com.br/CODE",
   "name": "test.pdf"
}

Request Parameters

Parameter	Description
type	(Required) Set to `pdf`to download the file in PDF format.
language (Optional)	To download the file in English, set this field to `en`. For Portuguese, use `pt`
encoding	(Required) Set to `true` to return the document content encoded in Base64.

After generating the URL, you must handle the & characters in the link properly by escaping them (e.g., using '^&') or wrapping the URL in quotes, especially when using terminal tools like PowerShell:

curl.exe {PROCESSED URL} > {DOCUMENT NAME}.txt

📝 The content will be saved as a .txt file containing the Base64-encoded document. You can decode it later as needed.

Big File Upload – Main Document Over 20MB

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

Test Endpoint 🧪

This endpoint allows you to upload a document larger than 20MB and smaller than 500MB to D4Sign’s servers.

🚧
Warning!
After the upload, the document will be encrypted in our safes and marked with a serial number.

After processing, a preview will be generated. Processing occurs in the background, meaning the request will not be blocked.

All documents are stored in encrypted SAFES, so the UUID-SAFE parameter is required and defines where the document will be stored.

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

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

{
    "uuid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx"
}

Parameter	Description
file (required)	File to be uploaded to D4Sign’s servers. Accepted MIME Types: `PDF, DOC, DOCX, JPG, PNG, BMP`
uuid_folder (optional)	If you want the document to be stored inside a specific folder, provide its UUID.

Create Document from WORD Template with Multiple Fillers

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

Test Endpoint 🧪

This endpoint generates a document in your safe based on a Word template.

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

{
    "name_document": "Document name",
    "uuid_folder (optional)": "{FOLDER UUID}",
  
    "templates": {
       "id_template": {
         
        "persona 1":{
	    			"variable 1": "value  1",
	    			"variable 2": "value  2",
	    	{...},
        
        "persona 2":{
	    			"variable 1": "value  1",
	    			"variable 2": "value  2",
	    	{...},
         
         "tokens_gerais":{
	    			"variable 1": "value  1",
	    			"variable 2": "value  2",
	    	{...}
        
	    }
   }
}

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

To retrieve the id_template, start by using the List Templates endpoint:
https://docapi.d4sign.com.br/reference/listar-templates

id_template example:


{
   "name_document":"Template model for contract with 2 fillers via API",
   "templates":
      {
         "MTIwMDcy=":{
            "organizer": {
               "full_name":"VALUE TEST",
                "name":"VALUE TEST",
                "organizer_address":"VALUE TEST",
                "total_amount":"VALUE TEST",
                "company_name":"VALUE TEST",
                "company_representative_name":"VALUE TEST",
                "company_address":"VALUE TEST",
                "company_phone":"VALUE TEST 2",
                "company_representative_position":"VALUE TEST",
                "organizer_email":"VALUE TEST"
            },
            "client": {
                "full_name":"VALUE TEST 1",
                "name":"VALUE TEST 1",
                "client_address":"VALUE TEST 1",
                "client_full_address":"VALUE TEST 1",
                "client_phone":"VALUE TEST 1",
                "client_email":"VALUE TEST 1",
                "client_cpf_or_cnpj_number":"VALUE TEST 1"
            },
            "tokens_gerais": {
                "address":"VALUE General Tokens",
                "full_name":"VALUE General Tokens",
                "event_name":"VALUE General Tokens",
                "signature_date":"VALUE General Tokens",
                "event_title":"VALUE General Tokens",
                "event_date":"VALUE General Tokens",
                "event_start_time":"VALUE General Tokens",
                "event_end_time":"VALUE General Tokens",
                "event_location":"VALUE General Tokens",
                "description":"VALUE General Tokens",
                "state":"VALUE General Tokens",
                "location_and_signature_date":"VALUE General Tokens"
            }
        }
      }
}

Parameter	Description
name_document (optional)	Defines the document name. If omitted, it will default to "Document".
uuid_folder (optional)	If you want the document stored inside a specific folder, provide its UUID. If omitted, the document will be saved directly in the specified safe.
id_template (required)	Object containing the ID of the template as the key and the variables as the value.
persona (optional)	If the template has more than one filler, this field is required. You can add as many fillers as needed. If two fillers can complete the same field, use tokens_gerais — the first submitted value will be used.
	Remember: You must provide at least one template. The variables must exactly match those configured in your template (e.g., FULL_NAME, CLIENT_NAME, etc.). The system is case-sensitive.

🚧
Important
Don’t forget to include tokenAPI and cryptKey in your request.

Note: To create a document in a shared safe from a Word template, the user must have "Administrator" or "Standard" permissions.

Schedule Document for Signature

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

Test Endpoint 🧪

This endpoint schedules the document to be sent for signature.

{
  "message":"Optional sending message",
  "workflow":"1",
  "scheduling_date":"2026/09/10",
  "scheduling_time":"21:00",
  "urgent_document":"0"
}

{
    "message": "Scheduling created successfully",
    "mensagem_pt": "Agendamento criado com sucesso."
}

Parameter	Description
uuid-document (required)	UUID of the main document.
message (optional)	Message that will be sent to signers along with the document.
workflow (required)	1 = No signing order is enforced; 2 = Signing must follow the defined order.
scheduling_date (required)	Scheduling date. Must be the same as or later than the current date. Format: yyyy/mm/dd.
scheduling_time (required)	Scheduling time, must be between 06:00 and 22:00 in hourly intervals (e.g., 11:00 / 12:00 / 13:00). If the selected date is today, the time must be later than the current system time.
urgent_document (optional)	0 = Not urgent; 1 = Urgent document.

List Responses from the New Power Form

`GET` /documents/{uuid_documento}/powerformresponses

Test Endpoint 🧪

This endpoint returns the responses associated with the specified document.

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

{
  "uuid_documento_gerado": "abcd-efgh-ijkl-123456789123",
  "nome_documento": "Contract Template",
  "respostas": [
    {
      "email_preenchedor": "[email protected]",
      "dt_cadastro": "2025-03-24 17:04:10",
      "campos_respostas": {
        "token1": "John Doe",
        "token2": "Approved"
      }
    },
    {
      "whatsapp_preenchedor": "+55 11 91234-5678",
      "dt_cadastro": "2025-03-24 17:03:37",
      "campos_respostas": {
        "ID": "12345678900",
        "City": "São Paulo",
        "Plan": "Premium"
      }
    }
  ]
}

Parameter	Description
UUID-DOCUMENT (required)	UUID of the document from which the responses should be retrieved

Add Trust ID (Extra Verification)

This endpoint enables the Trust ID verification method for a signer authenticated using either a document with photo or a document with photo and selfie.

🚧
Important
Don’t forget to include tokenAPI and cryptKey in your request.

Trust ID allows you to add an extra layer of security to your signing process. Once enabled, the signer must submit a photo of their identification document (and a selfie, if required). The Trust ID feature will scan and validate whether the information on the document matches the photo.

The process is divided into two steps.

Register the signer to the document with docauth or docauthandselfie enabled.
Adding TrustID for a signer in the document using the /addtrustID endpoint.

Adding signers to a document

The first step is to add a signer to your document, so you can provide the e-mail info when using Trust ID endpoint.

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

Test Endpoint 🧪

This endpoint registers the signers for a document — i.e., the people who must sign it.

{
    "signers": [
        {
            "email": "[email protected]",
            "act": "1",
            "foreign": "1",
            "foreign_lang": "en",
            "certificadoicpbr": "0",
            "assinatura_presencial": "0",
            "docauth": "1",
            "docauthandselfie": "0",
       	    "embed_methodauth": "email",
      	    "embed_smsnumber": "",
      	    "upload_allow": "0",
      	    "upload_obs": "Articles of Incorporation and Utility Bill",
      	    "whatsapp_number": "+5511981876540" (optional),
      	    "uuid_grupo": "GROUP UUID" (optional),
      	    "certificadoicpbr_tipo": "2" (optional),
      	    "certificadoicpbr_cpf": "CPF" (optional),
      	    "certificadoicpbr_cnpj": "CNPJ" (optional),
      	    "password_code": "Access code" (optional),
      	    "videoselfie": "0" (optional),
        },
        {...}
    ]
}

{
    "key_signer": "NwYu=",
    "email": "[email protected]",
    "act": "1",
    "foreign": "0",
    "certificadoicpbr": "0",
    "assinatura_presencial": "0",
    "assinatura_presencial_link": "LINK FOR IN-PERSON SIGNATURE" - The link will only be displayed after the document is sent for signing,
    "doc_auth": "0",
    "embed_methodauth": "email",
    "embed_smsnumber": "",
    "upload_allow": "0",
    "upload_obs": "Articles of Incorporation and Utility Bill",
    "docauthandselfie": "0",
    "skipemail": "0",
    "whatsapp": "",
    "password_code": "",
    "status": "created"
}

Parameter	Description
email (required)	Signer's email address
act (required)	Type of action. Valid values: 1 = Sign, 2 = Approve, 3 = Acknowledge, 4 = Sign as party, 5 = Witness, 6 = Intervening party, 7 = Receipt acknowledgment , 8–13 = Specialized roles.
foreign (required)	Indicates if signer is foreign. 0 = Has CPF, 1 = No CPF.
foreign_lang (optional)	Language for foreign signers (en, es, pt).
certificadoicpbr (required)	0 = Standard D4Sign signature, 1 = ICP-Brasil Certificate signature
assinatura_presencial (required)	1 = Face-to-face signing<br>0 = Remote signing
docauth (optional)	1 = Requires photo ID<br>0 = Not required
docauthandselfie (optional)	1 = Photo ID + selfie<br>0 = Selfie not required
embed_methodauth (optional)	Authentication method: email, password, sms, whats
embed_smsnumber (optional)	SMS or WhatsApp number in standard format (e.g.: +5511953020202)
upload_allow (optional)	Indicates whether the signer can upload additional documents
upload_obs (optional)	Specifies which documents must be uploaded (if upload_allow = 1)
after_position (optional)	Defines the order position after which this signer will be inserted
skipemail (optional)	1 = Do not send emails to the signer
whatsapp_number (optional)	WhatsApp number for signing
uuid_grupo (optional)	UUID of the signature group
password_code (optional)	Signer’s access code. Leave blank to remove the current code
sms-number (optional)	NEW SMS number of the signer
videoselfie (optional)	1 = Requires video selfie
key-signer	Generated signer’s key

🚧
Important
Make sure that the parameter docauth or docauthandselfie is set to "1" when registering the signer. This is required before using the /addtrustid endpoint.

Adding Trust ID to signer(s) in the list

The second step is to add Trust ID validation for each desired signer in the list:

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

Test Endpoint 🧪

{
  "trustid": [
    {
      "email": "[email protected]" (required),
      "name": "Signer's first name" (optional),
      "last_name": "Signer's last name" (optional),
      "document_type": 1 (required),
      "document_number": "12a34b567c" (optional),
    }, 
    {...}
  ]
}

{
    "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 (required)	UUID of the main document
email (required)	Email of the signer whose Trust ID will be added. The signer must have already been added to the document, with 'Photo ID' or 'Photo ID + Selfie' authentication point enabled.
name (optional)	Signer's first name
last _name (optional)	Signer's last name
document_type (required)	1 = National ID, 2 = Passport, 3 = Residence permit, 4 = Other.
document_number (optional)	Document number directly associated with document_type

✅ After adding Trust ID data, the signer will receive a request to submit their document photo (and selfie, if required). Once validated, the signing process can proceed as usual.

Remove Trust ID

Test Endpoint 🧪

This endpoint removes the Trust ID extra verification from one or more signers previously added to a document.

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

{
    "trustid": [

        {
            "email": "[email protected]"
        }
        
    ]
}

{
    "message": {
        "success": "1",
        "data_message": "TrustID removed",
        "data": [
            {
                "email": "[email protected]"
            }
        ]
    }
}

Parameter	Description
uuid-document (required)	UUID of the main document
email (required)	Email address of the signer whose Trust ID validation will be removed.

Document Endpoints

Important

List all documents

GET/documents

Request Parameters

List a specific document

GET/documents/{UUID-DOCUMENT}

Get document dimensions

GET /documents/{UUID-DOCUMENT}/dimensions

List all documents by phase

GET /documents/{ID-FASE}/status

Upload a main document

POST /documents/{UUID-SAFE}/upload

Attention!

Upload an attachment to a main document

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

Upload a main document (Binary)

POST/documents/{UUID-SAFE}/uploadbinary

Upload an attachment (Binary)

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

Upload a document hash (HASH)

POST/documents/{UUID-SAFE}/uploadhash

Highlight clauses

POST/documents/{UUID-DOCUMENT}/addhighlight

Send document for signing

POST/documents/{UUID-DOCUMENT}/sendtosigner

Cancel a document

POST/documents/{UUID-DOCUMENT}/cancel

DOWNLOAD a document

POST/documents/{UUID-DOCUMENT}/download

Resend signature link

POST/documents/{UUID-DOCUMENT}/resend

List templates

POST/templates

Document from HTML template

POST/documents/{UUID-SAFE}/makedocumentbytemplate

Document from WORD template

POST/documents/{UUID-SAFE}/makedocumentbytemplateword

Important

Download in PDF/A format

POST documents/{UUID-DOCUMENT}/download

Request Parameters

List Attachments Linked to a Main Document

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

Download of Individual Documents, Attachments and Signature Certificates

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

Request Parameters

XY Positioning of Initials

POST documents/{uuid-safe}/createrubricintemplateword

Request Parameters

Download Document as Base64

POST documents/{uuid-document}/download

Request Parameters

Big File Upload – Main Document Over 20MB

POST /documents/{UUID-SAFE}/uploadbigfile

Warning!

Create Document from WORD Template with Multiple Fillers

POST/documents/{UUID-SAFE}/makedocumentbytemplateword

Important

Schedule Document for Signature

POST/documents/{uuid-document}/scheduling

List Responses from the New Power Form

GET /documents/{uuid_documento}/powerformresponses

Add Trust ID (Extra Verification)

Important

POST/documents/{UUID-DOCUMENT}/createlist

Important

POST/documents/{UUID-DOCUMENT}/addtrustid

Remove 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