GuidesAPI Reference
Log In
Guides
Start typing to search…

Watcher Endpoints

Observer Endpoints

🚧

Important

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

Ex.: <https://secure.d4sign.com.br/api/v1/safes?tokenAPI=\{YOUR-TOKEN}&cryptKey=\{YOUR-CRYPT-KEY}>

List document watchers

GET/watcher/{UUID-DOCUMENT}

Test Endpoint 🧪

This method lists all watcher associated with a document.

{
    "Content-Type": "application/json"
}
{
    "uuid_arquivo": "uuid-of-the-document",
    "watchers": [
        {
            "email": "[email protected]",
            "perfil": "0"
        }
    ]
}

Add watcher to the document

POST/watcher/{UUID-DOCUMENT}/add

Test Endpoint 🧪

This method allows you to add an watcher to the document.

{
    "Content-Type": "application/json"
}
{
    "email": "[email protected]",
    "permission": "0"
}
{
    "message": "Email added successfully",
    "uuid": "uuid-document",
    "watcher": "[email protected]"
}
ParameterDescription
email (required)Observer's email address
permission (optional)0 - Basic role (can download documents)
1 - View-only (no download access)

Remove watcher from the document

POST/watcher/{UUID-DOCUMENT}/remove

Test Endpoint 🧪

This method will remove an watcher from the document.

{
    "Content-Type": "application/json"
}
{
    "email":"[email protected]"
}
{
    "message": "Email removed successfully",
    "watcher": "[email protected]"
}
ParameterDescription
email (required)Observer's email address

Remove ALL watchers from the document

POST/watcher/{UUID-DOCUMENT}/erase

Test Endpoint 🧪

This method will remove all watchers from the document.

{
    "Content-Type": "application/json"
}
{
    "message": "All watcher removed sucessfully"
}

Updated 9 months ago