Veja a lista de endpoints de signatários

Signers Endpoints

🚧
Important
Don’t forget to include the tokenAPI and cryptKey in your request.)
Ex.:[[[[[[[[https://secure.d4sign.com.br/api/v1/safes?tokenAPI={YOUR-TOKEN}&cryptKey={YOUR-CRYPT-KEY](https://secure.d4sign.com.br/api/v1/safes?tokenAPI={YOUR-TOKEN}&cryptKey={YOUR-CRYPT-KEY)}]

List Document Signers

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

Test Endpoint 🧪

This endpoint returns all signers of a document.

{
    "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": "Support",
    "statusId": "3",
    "statusName": "Awaiting Signatures",
    "statusComment": "Comment about cancellation",
    "whoCanceled": "Email of the user who canceled the document",
    "list": {
    	"key_signer": "NwYj=",
    	"user_name": "Signer 1",
    	"user_document": "000000000000 (CPF)",
    	"email": "[email protected]",
    	"signed": "1",
    	"sign_info": {
    		"ip": "192.168.0.1",
    		"ip_reverser": "bfb467a6.virtua.com.br port: 33421",
    		"geolocation": "-23 -23",
    		"user_agent": "Mozilla",
    		"date_signed": "2038-03-29 11:05:34",
    		"date_signed_atom": "2038-03-29T11:05:34-03:00"
    	},
    	"type": "1",
    	"foreign": "0",
    	"certificadoicpbr": "0",
    	"assinatura_presencial": "0",
    	"assinatura_presencial_link": "LINK FOR IN-PERSON SIGNATURE" – The link is only shown after the document is sent for signature,
    	"embed_methodauth": "email",
    	"embed_smsnumber": "",
    	"email_sent": "1",
    	"email_sent_status": "Delivery",
    	"email_sent_message": "Message successfully delivered.",
    	"upload_allowed": "0",
    	"upload_obs": "Description of the documents",
    	"documents_attached": "[]",
    	"date": "2016-04-17 13:56:21",
    	"docauth": "1",
    	"docauth_text": "DATA CAPTURED FROM THE REGISTERED DOCUMENT (REQUEST THIS FEATURE THROUGH OUR [email protected])",
    	"password_code": "Signer's access code"
	}
}

Parameter	Description
UUID-DOCUMENT (required)	UUID of the document whose signers will be listed.

List Signature Groups

`GET` /groups/{UUID-SAFE}

Test Endpoint 🧪

This method will list all signature groups from the safe.

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

{
    "uuid_grupo": "018715xc-054b-409f-b122-f683951e5460",
    "nome": "Legal Group"
}

Parameter	Description
UUID-SAFE (required)	UUID of the VAULT to be listed.

Register Signers

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

Test Endpoint 🧪

This endpoint registers the document signers, i.e., the people who need to sign the document.

{
    "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": "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)	Signing action. Allowed values: 1 = Sign, 2 = Approve, 3 = Acknowledge, 4 = Sign as a party, 5 = Sign as a witness, 6 = Sign as an intervenor, 7 = Acknowledge receipt, 8 = Sign as Issuer, Endorser, and Guarantor, 9 = Sign as Issuer, Endorser, Guarantor, and Surety, 10 = Sign as Surety, 11 = Sign as party and Surety, 12 = Sign as jointly liable party, 13 = Sign as party and jointly liable party,
foreign (required)	Indicates if the signer is a foreigner. 0 = Has CPF; 1 = Does not have CPF
foreign_lang	Foreigner's language: en = English, es = Spanish, pt = Portuguese
certificadoicpbr (required)	0 = Standard D4Sign signature, 1 = ICP-Brasil Certificate signature
assinatura_presencial (required)	1 = In-person signing , 0 = Remote signing
docauth (optional)	1 = Requires photo document , 0 = Does not require
docauthandselfie (optional)	1 = Document + selfie , 0 = Selfie not required
embed_methodauth (optional)	Authentication method: email, password, sms, whats
embed_smsnumber (optional)	SMS or WhatsApp number in format (e.g., +5511953020202)
upload_allow (optional)	Indicates if signer can upload other documents
upload_obs (optional)	Which documents the signer must upload (if upload_allow = 1)
after_position (optional)	Sets the position after which the signer will be inserted in the order
skipemail (optional)	1 = Do not send emails to signer
whatsapp_number (optional)	WhatsApp number for signing
uuid_grupo (optional)	UUID of the signing group
password_code (optional)	Signer's access code. Blank removes previous code
sms-number (required)	NEW SMS number of the signer
key-signer	Signer’s key
videoselfie	1 = Requires video selfie

Change Signer

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

Test Endpoint 🧪

This endpoint updates the signer's email address.

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

{
  "email-before": "[email protected]" or "+5511981764321",
  "email-after": "[email protected]" or "+5511981764321",
  "key-signer": "NyWx="
}

{
    "message": "E-mail changed"
}

Parameter	Description
email-before (required)	Previous email or WhatsApp number of the signer
email-after (required)	New email or WhatsApp number of the signer
key-signer	Signer's key (related to the previous email/number)

The key-signer can be found by listando os signatários de um documento.

Change SMS Number

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

Test Endpoint 🧪

This endpoint updates the signer's SMS number.

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

{
    "email": "[email protected]",
    "sms-number": "+5511953874555",
    "key-signer": "NyWx="
}

{
    "message": "SMS number changed"
}

Parameter	Description
email (required)	Signer's email address
sms-number (required)	New SMS number for the signer
key-signer	Signer’s key

Change Signer's Access Code

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

Test Endpoint 🧪

This endpoint updates the access code for the signer.

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

{
    "email": "[email protected]",
    "password-code": "Access code for the document",
    "key-signer": "NyWx="
}

{
    "message": "Password code changed",
}

Parameter	Description
email (required)	Signer’s email address
password-code	Access code for the document. Leave it blank to remove the current code.
key-signer	Signer's key

Remove Signer

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

Test Endpoint 🧪

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

{
    "email-signer": "[email protected]",
    "key-signer": "NyWx="
}

{
    "message": "E-mail has removed"
}

Parameter	Description
email-signer (required)	Signer’s email address
key-signer (required)	Signer's key

Add Positioned Signature to Main Document or Attachment with Signature Pins

`POST`/documents/{UUID-MAIN-DOCUMENT}/addpins

Test Endpoint 🧪

This endpoint adds a signature at the specified position in the document.

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

{
  "pins": [
    { 
      "document": "uuid-of-document",
      "email": "[email protected]",
      "page_width": 794,
      "page_height": 1123,
      "page": 1,
      "position_x": 397,
      "position_y": 560,
      "type": 0
    }
  ]
}

{
  "message": "success"
}

Parameter	Description
document (required)	UUID of the main or slave/attachment document
email (required)	Email of the signer to receive the pin. The signer must have already been added to the document.
page_height (required)	Height of the document page in pixels
page_width (required)	Width of the document page in pixels
page (required)	Page number where the pin will be placed in the document selected in the first parameter
position_x (required)	X-axis position of the signature in pixels
position_y (required)	Y-axis position of the signature in pixels
type	0 = Signature, 1 = Initials (rubrica), 2 = Stamp

The example above uses a standard A4 portrait page layout.

*To obtain the slave UUID, use the following previously documented endpoint:

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

Test Endpoint 🧪

Once you receive a success message, refresh the viewblob screen — the pin should appear on the page at the specified position.

Remove Positioned Signature from Document

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

This endpoint removes a signature at a specified position in the document.

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

{
  "pins": [
    {
      "email": "[email protected]",
      "page": 1,
      "position_x": 30,
      "position_y": 30
    }
  ]
}

{
  "message": "success"
}

Parameter	Description
email (required)	Email of the signer
page (required)	Page number
position_x (required)	X-axis position of the signature
position_y (required)	Y-axis position of the signature

List Positioned Signatures in Document

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

This endpoint lists all positioned signatures and their coordinates within the document.

{
    "Accept": "application/json"
}

{
  "pins": [
    {
      "page_height": "300",
      "page_width": "500",
      "pagina": "1",
      "position_x": "1",
      "position_y": "1",
      "email": "[email protected]"
    }
  ]
}

Register Signer Information

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

Test Endpoint 🧪

🚧
Important
FOR IN-PERSON SIGNATURES ONLY

This endpoint registers additional information (name, ID, and birth date) for a previously created signer. It is recommended to use this endpoint when performing in-person signatures. If you already have the signer's information, pre-register it to avoid asking for it at signing time.

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

{
    "key_signer": "NwYj=",
    "email": "[email protected]",
    "display_name": "Signer’s Name",
    "documentation": "Signer's ID",
    "birthday": "Signer's Birth Date",
    "tokenAPI": "{token-user}"
}

{
    "uuid-doc": "00004fa2-a361-42e3-a923-bb088b1809fe",
    "email": "[email protected]",
    "name": "Signer’s Name",
    "documentation": "Signer's ID",
    "birthday": "Signer's Birth Date",
    "status": "changed"
}

Parameter	Description
key_signer	Signer's key
email (required)	Signer's registered e-mail
display_name (optional)	Inform signer's name
documentation (optional)	Inform signer's ID
birthday (optional)	Inform signer's Birthday

Create a Custom "Sign As" Label

`POST` documents/{UUID-USUARIO}/addsignaturetype

Test Endpoint 🧪

This endpoint returns an "Act" number that can be used to register signers, allowing you to customize the "Sign as" description.

You can retrieve the user's UUID via the User Verification endpoint.

{
    "tipo": "Test Signature Role"
}

{
    "act": 373,
    "tipo_assinatura": "Test Signature Role",
    "sucesso": 1
}

Request Parameters

Parameter	Descriptions
tipo	Label/Title to be added under "Sign as"

The API documentation provides 13 default Act numbers:

act(required)	Signature Action
tipo	Label/Title to be added under "Sign as"
	Allowed actions:
	1 = Sign
	2 = Approve
	3 = Acknowledge
	4 = Sign as a party
	5 = Sign as a witness
	6 = Sign as an intervening party
	7 = Acknowledge receipt
	8 = Sign as Issuer, Endorser, and Guarantor
	9 = Sign as Issuer, Endorser, Guarantor, and Co-signer
	10 = Sign as a guarantor
	11 = Sign as a party and guarantor
	12 = Sign as a jointly liable party
	13 = Sign as a party and jointly liable party

After using this endpoint to generate a custom Act number (e.g., 347), you must associate it with a new signer using the Register Signers. endpoint

The newly created Act number is global to the platform, not linked to a specific user. Any account can use the number as long as they know it.

You may create a new "Sign as" label even if it already exists (duplicate name). Each registration will generate a new, unique Act number.

If multiple Act numbers are created using the same name, they will coexist and function independently without conflict.

Once created, the custom Act will be available on the platform for use.

Retrieve Signature Group Details

`GET`/groups/{UUID-COFRE}/groupdetails/{UUID-GROUP}

Test Endpoint 🧪

This endpoint returns the details of a signature group, only if the tokenAPI belongs to the group owner account, or if the group has been shared with the provided uuid_safe.

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

{
    "name_group": "[email protected]",
    "group_details": [
        {
            "uuid_conta": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
            "uuid_grupo": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
            "email": "[email protected]",
            "tipo_assinatura": "1",
            "certificado_digital": "0",
            "doc_auth": "0",
            "assinatura_presencial": "0",
            "estrangeiro": "0",
            "removido": "0",
            "dt_cadastro": "2024-01-04 11:48:31",
            "desativar_remocao": "0",
            "signatario_editavel": "0",
            "doc_authselfie": "0",
            "sequencia": "1",
            "upload_permitido": "0",
            "upload_obs": null,
            "clausula_destaque": "0",
            "nome_tipo_assinatura": "Sign"
        },
        {
            "uuid_conta": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
            "uuid_grupo": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
            "email": "[email protected]",
            "tipo_assinatura": "1",
            "certificado_digital": "0",
            "doc_auth": "0",
            "assinatura_presencial": "0",
            "estrangeiro": "0",
            "removido": "0",
            "dt_cadastro": "2024-01-04 11:48:41",
            "desativar_remocao": "0",
            "signatario_editavel": "0",
            "doc_authselfie": "0",
            "sequencia": "2",
            "upload_permitido": "0",
            "upload_obs": null,
            "clausula_destaque": "0",
            "nome_tipo_assinatura": "Sign"
        },
        {
            "uuid_conta": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
            "uuid_grupo": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
            "email": "[email protected]",
            "tipo_assinatura": "1",
            "certificado_digital": "0",
            "doc_auth": "0",
            "assinatura_presencial": "0",
            "estrangeiro": "0",
            "removido": "0",
            "dt_cadastro": "2024-01-04 11:49:02",
            "desativar_remocao": "0",
            "signatario_editavel": "0",
            "doc_authselfie": "0",
            "sequencia": "3",
            "upload_permitido": "0",
            "upload_obs": null,
            "clausula_destaque": "0",
            "nome_tipo_assinatura": "Sign"
        }
    ]
}

Parameter	Description
uuid-safe	UUID of any safe that has been shared with the group.
uuid-group	UUID of the group to retrieve details for.

Retrieve Signature Link

`GET`/documents/{UUID-DOCUMENTO}/signaturelink/{ID_LINKASSINATURA}

Test Endpoint 🧪

This endpoint allows you to retrieve the signature link of a specific signer in a specific document via API.

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

{
    "link": "https://sandbox.d4sign.com.br/w/i/{document-uuid}/xxxxxxxxxxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx/xxxx"
}

Parameter	Description
uuid-documento	UUID of the document
ID_linkassinatura	ID of the signer's signature link (base64-decoded key-signer value)

The signature link is only available after the document has been sent to the signer.

If the request is made before this phase, an error will be returned.

Only the following roles can access this endpoint:

Owner of the safe ;
Admin permission, if the safe | vault is shared;
Default permission, if the safe| vault is shared.

Insert Initials Pin from Signature Group into the Document

This process is divided into three steps:

Add signature groups to a document;
List the groups added as signers to retrieve the designated email address
Insert initials pins directly associated with the groups in the document.

Add Signature Groups to a Document

The first step is to allow a signature group to be assigned as a signer on a document. The only restrictions—besides basic permission requirements—are:

The document must be in the "Waiting for Signers" phase;
The group must be available in the same safe (vault) as the document.

Once these conditions are met, you can use the following endpoint to add a group to the document:

`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",
            "certificadoicpbr": "0",
            "assinatura_presencial": "0",
            "docauth": "0",
            "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	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 (required)	NEW SMS number of the signer
key-signer	Signer’s key
videoselfie	1 = Requires video selfie

According to the image above (where act indicates the type of action this group will perform in the signing process, such as signing, approving, etc.; and uuid_grupo is the UUID of the group located in the same safe as the document, which can be retrieved using another already available and functional endpoint in the documentation):

`GET` /groups/{UUID-SAFE}

Test Endpoint 🧪

Retrieves all signature groups associated with the specified safe.

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

{
    "uuid_grupo": "018715xc-054b-409f-b122-f683951e5460",
    "nome": "Legal Group"
}

Parameter	Description
UUID-SAFE (required)	UUID of the safe whose signature groups should be retrieved.

List groups added as document signers to identify the email assigned to the group

After successfully adding a group as a signer to a document, it is necessary to confirm that the group is properly listed as a signer through the API. This is an essential step in order to allow pins to be added in the third step.

Using the endpoint below, you can retrieve all signers of a document:

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

Test Endpoint 🧪

This object will return all signers of a document.

{
    "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": "Awaiting Signatures",
    "statusComment": "Comment regarding cancellation",
    "whoCanceled": "Email of the user who canceled the document",
    "list": {
    	"key_signer": "NwYj=",
    	"user_name": "Signer 1",
    	"user_document": "000000000000 (CPF)",
    	"email": "[email protected]",
    	"signed": "1",
    	"sign_info": {
    		"ip": "192.168.0.1",
    		"ip_reverser": "bfb467a6.virtua.com.br port: 33421",
    		"geolocation": "-23 -23",
    		"user_agent": "Mozilla",
    		"date_signed": "2038-03-29 11:05:34",
    		"date_signed_atom": "2038-03-29T11:05:34-03:00"
    	},
    	"type": "1",
    	"foreign": "0",
    	"certificadoicpbr": "0",
    	"assinatura_presencial": "0",
    	"assinatura_presencial_link": "LINK FOR IN-PERSON SIGNATURE", - Only shown after the document has been sent for signing


    	"embed_methodauth": "email",
    	"embed_smsnumber": "",
    	"email_sent": "1",
    	"email_sent_status": "Delivery",
    	"email_sent_message": "Message successfully delivered",
    	"upload_allowed": "0",
    	"upload_obs": "Description of required documents",
    	"documents_attached": "[]",
    	"date": "2016-04-17 13:56:21",
    	"docauth": "1",
    	"docauth_text": "DATA EXTRACTED FROM REGISTERED DOCUMENT (TO ENABLE THIS FEATURE, CONTACT [email protected])",
    	"password_code": "Access code for the signer"
    	
	}
}

Parameter	Description
UUID-DOCUMENT (required)	UUID of the VAULT to be listed.

Insert signature pins directly linked to groups added to the document

In a typical workflow, we only need to provide the pin positioning data within the document and the email of the signer that the pin should be assigned to. In this case, we can simply use the group email retrieved in the previous step.

The request below uses this email to verify if the pin can be inserted and linked. As shown in the previous steps, the pin’s email must match the one in the document’s list of signers.

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

Test Endpoint 🧪

This object adds the selected signer’s signature pin to the attached document.

{
"pins": [
{ 
"document": "uuid_document",
"email" : "[email protected]",
"page_height": 300,
"page_width": 500,
"page":1,
"position_x":30,
"position_y":30
}
]
}

{
    "message": "success"
}

Parameter	Description
document (required)	UUID of the main or attached (slave) document
email (required)	Email of the signer to whom the pin will be assigned. This signer must already be added to the document.
page_height (required)	Height of the document page in mm
page_width (required)	Width of the document page in mm
page (required)	Page number where the pin will be placed
position_x (required)	X coordinate for the signature pin in mm
position_y (required)	Y coordinate for the signature pin in mm

If the response returns a success message, the signature pin will be available on the platform, positioned according to the coordinates provided in the API request.

Replicate signature position across all pages of a document and attachments

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

Test Endpoint 🧪

This endpoint replicates signature positions across all pages of the main document and its attachments.

{
    "pins": {
        "email": "[email protected]",
        "page_height": "1097px",
        "page_width": "790px",
        "position_x": 360,
        "position_y": 150,
        "type": 1,
        "document_slaves": [
            {
                "uuid": "{uuid-slave}"
            },
            {
                "uuid": "{uuid-slave}"
            }
        ]
    }
}

{
    "message": "success"
}

Parameter	Description
uuid-document (required)	UUID of the main document
email (required)	Email of the signer to whom the pin will be added. The signer must have already been added to the document.
page_height (required)	Page height in pixels
page_width (required)	Page width in pixels
position_x (required)	X coordinate of the signature in millimeters
position_y (required)	Y coordinate of the signature in millimeters
type (optional)	Type of signature position - 0: signature; 1: initials; 2: stamp
uuid (optional)	To replicate the signature position on attachments, add the UUID of the corresponding slave document(s).

If the response returns a success message, the signature pin will be available on all pages of the document and its attachments, positioned as specified via API.

Remove replicated signature positions from document and attachments

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

Test Endpoint 🧪

This endpoint removes replicated signature positions from the main document and its attachments.

{
    "pins": {
        "email": "[email protected]",
        "position_x": 360,
        "position_y": 150
    }
}

{
    "message": "success"
}

Parameter	Description
uuid-document (required)	UUID of the main document
email (required)	Email of the signer whose pin will be removed. The signer must have already been added to the document.
position_x (required)	X coordinate of the signature in millimeters
position_y (required)	Y coordinate of the signature in millimeters

Signers Endpoints

Important

List Document Signers

GET /documents/{UUID-DOCUMENT}/list

List Signature Groups

GET /groups/{UUID-SAFE}

Register Signers

POST/documents/{UUID-DOCUMENT}/createlist

Change Signer

POST/documents/{UUID-DOCUMENT}/changeemail

Change SMS Number

POST/documents/{UUID-DOCUMENT}/changesmsnumber

Change Signer's Access Code

POST/documents/{UUID-DOCUMENT}/changepasswordcode

Remove Signer

POST/documents/{UUID-DOCUMENT}/removeemaillist

Add Positioned Signature to Main Document or Attachment with Signature Pins

POST/documents/{UUID-MAIN-DOCUMENT}/addpins

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

Remove Positioned Signature from Document

POST/documents/{UUID-DOCUMENT}/removepins

List Positioned Signatures in Document

GET/documents/{UUID-DOCUMENT}/listpins

Register Signer Information

POST/documents/{UUID-DOCUMENT}/addinfo

Important

Create a Custom "Sign As" Label

POST documents/{UUID-USUARIO}/addsignaturetype

Request Parameters

Retrieve Signature Group Details

GET/groups/{UUID-COFRE}/groupdetails/{UUID-GROUP}

Retrieve Signature Link

GET/documents/{UUID-DOCUMENTO}/signaturelink/{ID_LINKASSINATURA}

Insert Initials Pin from Signature Group into the Document

POST/documents/{UUID-DOCUMENT}/createlist

GET /groups/{UUID-SAFE}

GET /documents/{UUID-DOCUMENT}/list

POST/documents/{uuid-document}/addpins

Replicate signature position across all pages of a document and attachments

POST/documents/{uuid-document}/addpinswithreplics

Remove replicated signature positions from document and attachments

POST/documents/{uuid-document}/removepinswithreplics

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

`GET` /groups/{UUID-SAFE}

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

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

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

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

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

`POST`/documents/{UUID-MAIN-DOCUMENT}/addpins

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

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

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

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

`POST` documents/{UUID-USUARIO}/addsignaturetype

`GET`/groups/{UUID-COFRE}/groupdetails/{UUID-GROUP}

`GET`/documents/{UUID-DOCUMENTO}/signaturelink/{ID_LINKASSINATURA}

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

`GET` /groups/{UUID-SAFE}

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

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

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

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