Informações Gerais

Com esta API, você irá integrar o seu sistema ao nosso. Você poderá utilizar todos os recursos da plataforma através dessa API, como, por exemplo, enviar documentos para assinatura mantendo o usuário em seu ambiente.

Abaixo está as informações dos servidores que usamos

Ambiente Servidor Validade jurídica
Produção https://api.viasign.com.br/v1 Sim
Desenvolvimento (SandBox) http://demo.viasign.com.br/v1 Não

Nossa API é RESTful e todas as respostas são em json


require_once(__DIR__ . '/sdk/vendor/autoload.php');

use ViaSign\Client;

try{
    $client = new Client();
    // $client->setUrl('https://api.viasign.com.br/'); //Produção - A versão (v1) já está embutida na SDK
    $client->setUrl('http://demo.viasign.com.br/v1'); //Desenvolvimento (SandBox)
} catch (Exception $e) {
    echo $e->getMessage();
} 

            
Passos básicos para iniciar

  1. 1º - Realizar o upload do documento
  2. 2º - Cadastrar o webhook(POSTBack) //OPCIONAL
  3. 3º - Cadastrar os signatários
  4. 4º - Enviar o documento para assinatura
Autenticação

A autenticação é feita através dos parâmetros tokenAPI e cryptKey que automaticamente identifica e autentica o usuário.

Os parâmetros devem ser enviados no caminho da requisição, ou seja, toda requisição deverá conter no path ?tokenAPI={token_user}&cryptKey={crypt_key}

O parâmetro cryptKey só precisa ser enviado caso esteja habilitado em sua conta.

API Keys

A sua Chave de API está disponível em sua conta.Faça login e acesse o menu 'Dev API'.

Você terá um limite de 50 requisições por hora. Para aumentar esse limite, entre em contato com o suporte@viasign.com.br.

SDKs Disponíveis

SDK PHP em https://github.com/viasign/viasign-php

Configuração mínima: PHP 5 >= 5.5.0

Em breve novas SDKs estarão disponíveis.

API

No ViaSign, o processo de assinatura ocorre sempre através de um documento, ou seja, o documento precisa ser criado em seu ambiente (seu servidor) e enviado para o ViaSign através do método de (/documents/{uuid_safe}/upload).

Cada documento possui uma chave única que é criada no momento do upload do documento. Essa chave é muito importante e deve ser inserida em seu banco de dados para futuras interações com o documento.

Listar todos os cofres

Este objeto retornará TODOS os COFRES da sua conta.

GET /safes
Resposta (200)

Você receberá uma resposta em JSON com os seguintes objetos

    
    {
        "success": true,
        "safes": [
            {
                "uuid-safe": "ad218f46-0a8d-4de4-0eb7-1bb11016ea25",
                "name-safe": "Contratos"
            }
        ]
    }

Exemplo usando SDK PHP

require_once(__DIR__ . '/sdk/vendor/autoload.php');

use ViaSign\Client;
try{
    $client = new Client();
    $client->setAccessToken("{TOKEN-USER}");
    $client->setCryptKey("{CRYPT-KEY-USER}"); //Necessário apenas se o cryptKey estiver habilitado na conta
    
    $safes = $client->safes->find();
    
    //print_r($safes);
} catch (Exception $e) {
    echo $e->getMessage();
} 

                
Listar todos os documentos

Este objeto retornará TODOS os documentos da sua conta.

GET /documents

O resultado será de 500 documentos por páginas.

Utilize o parametro PG na URL para paginar o resultado. Ex.:

https://api.viasign.com.br/v1/documents?tokenAPI={SEU-TOKEN}&cryptKey={crypt-key}&pg=2

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

Resposta (200)

Você receberá uma resposta em JSON com os seguintes objetos


    {
        "success": true,
        "documents": [
            {
                "uuidDoc": "01141d09-12ec-46e6-46a8-d691053373fd",
                "nameDoc": "Sample",
                "uuidSafe": "ad218f46-0a8d-4de4-0eb7-1bb11016ea25",
                "safeName": "Contratos",
                "statusId": 3,
                "statusName": "Assinado"
            },
            {...}
        ]
    }

Exemplo usando SDK PHP
    
    require_once(__DIR__ . '/sdk/vendor/autoload.php');
    
    use ViaSign\Client;
    try{
        $client = new Client();
        $client->setAccessToken("{TOKEN-USER}");
        $client->setCryptKey("{CRYPT-KEY-USER}"); //Necessário apenas se o cryptKey estiver habilitado na conta
        
        $docs = $client->documents->find();
        
        //print_r($docs);
    } catch (Exception $e) {
        echo $e->getMessage();
    } 
    
    
Listar um documento específico

Este objeto retornará TODOS os documentos da sua conta.

GET /documents/{UUID-DOCUMENT}
Requisição
Parâmetro Descrição
UUID-DOCUMENTO (obrigatório) UUID do documento que deverá ser listado.
Resposta (200)

Você receberá uma resposta em JSON com o seguinte objeto


    {
        "success": true,
        "document": {
            "uuidDoc": "01141d09-12ec-46e6-46a8-d691053373fd",
            "nameDoc": "Sample",
            "uuidSafe": "ad218f46-0a8d-4de4-0eb7-1bb11016ea25",
            "safeName": "Contratos",
            "statusId": 3,
            "statusName": "Assinado"
        }
    }

                
Exemplo usando SDK PHP
                    
    require_once(__DIR__ . '/sdk/vendor/autoload.php');
    
    use ViaSign\Client;
    try{
        $client = new Client();
        $client->setAccessToken("{TOKEN-USER}");
        $client->setCryptKey("{CRYPT-KEY-USER}"); //Necessário apenas se o cryptKey estiver habilitado na conta
        
        $docs = $client->documents->find("{UUID-DOCUMENT}");
        
        //print_r($docs);
    } catch (Exception $e) {
        echo $e->getMessage();
    } 
    
Listar todos os documentos de um cofre

Esse objeto retornará todos os documentos que estiverem associados ao cofre informado.

GET /documents/{UUID-SAFE}/safe

O resultado será de 500 documentos por páginas.

Utilize o parametro PG na URL para paginar o resultado. Ex.:

https://api.viasign.com.br/v1/documents/{UUID-SAFE}/safe?tokenAPI={SEU-TOKEN}&cryptKey={crypt-key}&pg=2

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

Requisição
Parâmetro Descrição
UUID-SAFE (obrigatório) UUID do COFRE que deverá ser listado.
Resposta (200)

Você receberá uma resposta em JSON com o seguinte objeto

    
    {
        "success": true,
        "documents": [
            {
                "uuidDoc": "01141d09-12ec-46e6-46a8-d691053373fd",
                "nameDoc": "Sample",
                "uuidSafe": "ad218f46-0a8d-4de4-0eb7-1bb11016ea25",
                "safeName": "Contratos",
                "statusId": 3,
                "statusName": "Assinado"
            },
            {. . .}
        ]
    }
    
                    
Exemplo usando SDK PHP
                        
        require_once(__DIR__ . '/sdk/vendor/autoload.php');
        
        use ViaSign\Client;
        try{
            $client = new Client();
            $client->setAccessToken("{TOKEN-USER}");
            $client->setCryptKey("{CRYPT-KEY-USER}"); //Necessário apenas se o cryptKey estiver habilitado na conta
            
            $docs = $client->documents->safe("{UUID-SAFE}");
            
            //print_r($docs);
        } catch (Exception $e) {
            echo $e->getMessage();
        } 
        
    
Listar todos os documentos de uma fase

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

GET /documents/{ID-FASE}/status

O resultado será de 500 documentos por páginas.

Utilize o parametro PG na URL para paginar o resultado. Ex.:

https://api.viasign.com.br/v1/documents/{ID-FASE}/status?tokenAPI={SEU-TOKEN}&cryptKey={crypt-key}&pg=2

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

Requisição
Parâmetro Descrição
ID-FASE (obrigatório) ID da FASE que deverá ser listado.
  • ID 1 - Aguardando signatários
  • ID 2 - Aguardando Assinaturas
  • ID 3 - Assinado
  • ID 99 - Cancelado
Resposta (200)

Você receberá uma resposta em JSON com os seguintes objetos

    
    {
        "success": true,
        "documents": [
            {
                "uuidDoc": "01141d09-12ec-46e6-46a8-d691053373fd",
                "nameDoc": "Sample",
                "uuidSafe": "ad218f46-0a8d-4de4-0eb7-1bb11016ea25",
                "safeName": "Contratos",
                "statusId": 3,
                "statusName": "Assinado"
            },
            {. . .}
        ]
    }
    
                    
Exemplo usando SDK PHP
                        
        require_once(__DIR__ . '/sdk/vendor/autoload.php');
        
        use ViaSign\Client;
        try{
            $client = new Client();
            $client->setAccessToken("{TOKEN-USER}");
            $client->setCryptKey("{CRYPT-KEY-USER}"); //Necessário apenas se o cryptKey estiver habilitado na conta
            
            $docs = $client->documents->status("{ID-FASE}");
            
            //print_r($docs);
        } catch (Exception $e) {
            echo $e->getMessage();
        } 
        
    
Realizar o UPLOAD de um documento principal

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

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.

POST /documents/{UUID-SAFE}/upload
Requisição
Header

{
    "Content-Type": "multipart/form-data;"
}

                
Parâmetro Descrição
file (obrigatório) Arquivo que será enviado para os servidores do ViaSign. MIME Types aceito: PDF
Resposta (200)

Você receberá uma resposta em JSON com o seguinte objeto


    {
        "success": true,
        "uuid": "7609b559-8b3c-20aa-b59f-22165d6cda59"
    }

                
Exemplo usando SDK PHP

require_once(__DIR__ . '/sdk/vendor/autoload.php');

use ViaSign\Client;
try{
    $client = new Client();
    $client->setAccessToken("{TOKEN-USER}");
    $client->setCryptKey("{CRYPT-KEY-USER}"); //Necessário apenas se o cryptKey estiver habilitado na conta
    
    $path_file = '/pasta/arquivo.pdf';
    $id_doc = $client->documents->upload('{UUID-SAFE}', $path_file);
    
    //print_r($id_doc);
} catch (Exception $e) {
    echo $e->getMessage();
} 

                
Realizar o UPLOAD de um documento anexo ao principal

Esse objeto realizará o UPLOAD do seu documento para os servidores da ViaSign 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.

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.

POST /documents/{UUID-DOC-PRINCIPAL}/uploadslave
Requisição
Header
    
    {
        "Content-Type": "multipart/form-data;"
    }
    
                    
Parâmetro Descrição
file (obrigatório) Arquivo que será enviado para os servidores do ViaSign. MIME Types aceito: PDF
Resposta (200)

Você receberá uma resposta em JSON com o seguinte objeto

    
        {
            "success": true
        }
    
                    
Exemplo usando SDK PHP
    
    require_once(__DIR__ . '/sdk/vendor/autoload.php');
    
    use ViaSign\Client;
    try{
        $client = new Client();
        $client->setAccessToken("{TOKEN-USER}");
        $client->setCryptKey("{CRYPT-KEY-USER}"); //Necessário apenas se o cryptKey estiver habilitado na conta
        
        $path_file = '/pasta/arquivo.pdf';
        $id_doc = $client->documents->uploadslave('{UUID-DOC-PRINCIPAL}', $path_file);
        
        //print_r($id_doc);
    } catch (Exception $e) {
        echo $e->getMessage();
    } 
    
                    
Realizar o UPLOAD de um documento principal (Binário)

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

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.

POST /documents/{UUID-SAFE}/uploadbinary
Requisição
Parâmetro Descrição
base64_binary_file (obrigatório) Arquivo que será enviado para os servidores do ViaSign.

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
Resposta (200)

Você receberá uma resposta em JSON com o seguinte objeto

    
        {
            "success": true,
            "uuid": "7609b559-8b3c-20aa-b59f-22165d6cda59"
        }
    
                    
Exemplo usando SDK PHP
    
        require_once(__DIR__ . '/sdk/vendor/autoload.php');
        
        use ViaSign\Client;
        try{
            $client = new Client();
            $client->setAccessToken("{TOKEN-USER}");
            $client->setCryptKey("{CRYPT-KEY-USER}"); //Necessário apenas se o cryptKey estiver habilitado na conta
            
            $uuid_safe 		= '{UUID-SAFE}';
            $name 			= 'Documento teste';
            $mime_type		= 'application/pdf';
            $base64_binary		= base64_encode("BINARIO_DO_ARQUIVO");
        
            $id_doc = $client->documents->uploadbinary($uuid_safe, $base64_binary, $mime_type, $name);
            //print_r($id_doc);
            
        } catch (Exception $e) {
            echo $e->getMessage();
        } 
    
                    
Realizar o UPLOAD de um documento anexo ao principal (Binário)

Esse objeto realizará o UPLOAD do seu documento para os servidores da ViaSign 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.

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.

POST /documents/{UUID-DOC-MASTER}/uploadslavebinary
Requisição
Header
    
    {
        "Content-Type": "multipart/form-data;"
    }
    
                    
Parâmetro Descrição
base64_binary_file (obrigatório) Arquivo que será enviado para os servidores do ViaSign.

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
Resposta (200)

Você receberá uma resposta em JSON com o seguinte objeto

    
        {
            "success": true
        }
    
                    
Exemplo usando SDK PHP
    
        require_once(__DIR__ . '/sdk/vendor/autoload.php');
        
        use ViaSign\Client;
        try{
            $client = new Client();
            $client->setAccessToken("{TOKEN-USER}");
            $client->setCryptKey("{CRYPT-KEY-USER}"); //Necessário apenas se o cryptKey estiver habilitado na conta
            
            $uuid_doc_master	= '{UUID-DOC-MASTER}';
            $name 				= 'Documento teste';
            $mime_type			= 'application/pdf';
            $base64_binary		= base64_encode("BINARIO_DO_ARQUIVO");
        
            $id_doc = $client->documents->uploadslavebinary($uuid_doc_master, $base64_binary, $mime_type, $name);
            //print_r($id_doc);
            
        } catch (Exception $e) {
            echo $e->getMessage();
        } 
    
                        
Cadastrar signatários

Esse objeto realizará o cadastro dos signatários do documento, ou seja, quais pessoas precisam assinar esse documento.

POST /documents/{UUID-DOCUMENT}/createlist
Requisição
Body

    {
        "signers" : [
            {
                "email": "email@dominio.com",
                "act":"1",
                "access_code": false,
                "docauth":"0",
                "docauthandselfie":"0"
            },
            {...}
            ]
    }

                
Parâmetro Descrição
email (obrigatório) E-mail do signatário (pessoa que precisa assinar o documento)
act (obrigatório) Ação da assinatura. Ações permitidas:
  • 1 = Assinar
  • 2 = Aprovar
  • 3 = Reconhecer
  • 4 = Assinar como parte
  • 5 = Assinar como testemunha
  • 6 = Assinar como interveniente
  • 7 = Acusar recebimento
  • 8 = Assinar como Emissor, Endossante e Avalista
  • 9 = Assinar como Emissor, Endossante, Avalista, Fiador
  • 10 = Assinar como fiador
  • 11 = Assinar como parte e fiador
  • 12 = Assinar como responsável solidário
  • 13 = Assinar como parte e responsável solidário
access_code (opcional) Entre com um código para o acesso do signatário. O VALOR 'FALSE' REMOVE O CÓDIGO ANTERIOR.
docauth

Indica se o signatário DEVE efetuar a assinatura apresentando um documento com foto. 1 = Será efetuada a assinatura exigindo um documento com foto.

0 = Não será efetuada a assinatura exigindo um documento com foto.

docauthandselfie

Indica se o signatário DEVE efetuar a assinatura apresentando um documento com foto e depois registrar uma selfie segurando o mesmo documento. 1 = Será efetuada a assinatura exigindo um documento com foto e uma selfie segurando o documento.

0 = Não será efetuada a assinatura exigindo um documento com foto e uma selfie segurando o documento.

Resposta (200)

Você receberá uma resposta em JSON com o seguinte objeto


    {
        "success": true,
        "signatarios": [
            {
                "key_signer": "5932b05c-16fd-57e6-b6d5-94ce6cb5c620",
                "email": "email@dominio.com",
                "act": "Assinar",
                "access_code": null,
                "ponto_de_autenticacao": null,
                "status": "created"
            }
        ]
    }

                
Exemplo usando SDK PHP

    require_once(__DIR__ . '/sdk/vendor/autoload.php');
    
    use ViaSign\Client;
    try{
        $client = new Client();
        $client->setAccessToken("{TOKEN-USER}");
        $client->setCryptKey("{CRYPT-KEY-USER}"); //Necessário apenas se o cryptKey estiver habilitado na conta
        
        $signers = array(
            array("email" => "email1@dominio.com", "act" => '1'),
            array("email" => "email2@dominio.com", "act" => '1'),
            array("email" => "email3@dominio.com", "act" => '1')    
        );
        
        $return = $client->documents->createList("{UUID-DOCUMENT}", $signers);
        
        //print_r($return);
    } catch (Exception $e) {
        echo $e->getMessage();
    } 

                    
Remover signatário

Esse objeto removerá o signatário

POST /documents/{UUID-DOCUMENT}/removeemaillist
Requisição
Parâmetro Descrição
email-signer (obrigatório) E-mail do signatário
key-signer (obrigatório) Chave do signatário
Resposta (200)

Você receberá uma resposta em JSON com o seguinte objeto


    {
        "success": true
    }

                
Exemplo usando SDK PHP

    require_once(__DIR__ . '/sdk/vendor/autoload.php');
    
    use ViaSign\Client;
    try{
        $client = new Client();
        $client->setAccessToken("{TOKEN-USER}");
        $client->setCryptKey("{CRYPT-KEY-USER}"); //Necessário apenas se o cryptKey estiver habilitado na conta
        
        $signatario		= 'email@email.com';
        $key_signer		= '06b3ddb1-abc9-4ab8-b944-0d7c940486af';
        $return = $client->documents->removeemail("{UUID-DOCUMENT}",$signatario ,$key_signer);
        
        //print_r($return);
    } catch (Exception $e) {
        echo $e->getMessage();
    } 

                
Enviar um documento para assinatura

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.

POST /documents/{UUID-DOCUMENT}/sendtosigner
Requisição
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.

workflow (obrigatório) Opções:

0 = Para não seguir o workflow.

1 = Para seguir o workflow.

Caso o parâmetro workflow seja definido como 1, o segundo signatário só receberá a mensagem de que há um documento aguardando sua assinatura DEPOIS que o primeiro signatário efetuar a assinatura, e assim sucessivamente. Porém, caso seja definido como 0, todos os signatários poderão assinar o documento ao mesmo tempo.

Resposta (200)

Você receberá uma resposta em JSON com o seguinte objeto


    {
        "success": true,
        "message": "Emails foram enviados"
    }

                
Exemplo usando SDK PHP

    require_once(__DIR__ . '/sdk/vendor/autoload.php');
    
    use ViaSign\Client;
    try{
        $client = new Client();
        $client->setAccessToken("{TOKEN-USER}");
        $client->setCryptKey("{CRYPT-KEY-USER}"); //Necessário apenas se o cryptKey estiver habilitado na conta
        
        $message = 'Prezados, segue o contrato eletrônico para assinatura.';
        $workflow = 0 //Todos podem assinar ao mesmo tempo;
        $skip_email = 1 //Não disparar email com link de assinatura (usando EMBED);
        
        $doc = $client->documents->sendToSigner("{UUID-DOCUMENT}", $message, $workflow, $skip_email);
        
        //print_r($doc);
    } catch (Exception $e) {
        echo $e->getMessage();
    } 

                
Cancelar um documento

Esse objeto irá cancelar o documento.

POST /documents/{UUID-DOCUMENT}/cancel
Resposta (200)

Você receberá uma resposta em JSON com o seguinte objeto


    {
        "success": true
    }

                
Exemplo usando SDK PHP

    require_once(__DIR__ . '/sdk/vendor/autoload.php');
    
    use ViaSign\Client;
    try{
        $client = new Client();
        $client->setAccessToken("{TOKEN-USER}");
        $client->setCryptKey("{CRYPT-KEY-USER}"); //Necessário apenas se o cryptKey estiver habilitado na conta
        
        $docs = $client->documents->cancel("{UUID-DOCUMENT}",'comentário sobre o cancelamento');
        
        //print_r($docs);
    } catch (Exception $e) {
        echo $e->getMessage();
    } 

                
Realizar o DOWNLOAD de um documento

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

POST /documents/{UUID-DOCUMENT}/download
Requisição
Parâmetro Descrição
type (opcional)

Para realizar o download do arquivo original, escolha 'documento' nesse atributo.

Para realizar o download documento assinado, escolha 'assinatura' nesse atributo.

Resposta (200)

Você receberá o arquivo como resposta

Exemplo usando SDK PHP

    require_once(__DIR__ . '/sdk/vendor/autoload.php');
    
    use ViaSign\Client;
    try{
        $client = new Client();
        $client->setAccessToken("{TOKEN-USER}");
        $client->setCryptKey("{CRYPT-KEY-USER}"); //Necessário apenas se o cryptKey estiver habilitado na conta
        
        //Você poderá fazer download do arquivo original ou do arquivo assinado setando o último parametro.
        $doc = $client->documents->getfileurl("{UUID-DOCUMENT}",'assinatura');
        //print_r($doc);
    } catch (Exception $e) {
        echo $e->getMessage();
    } 

                
Webhooks (POSTBack)

Webhook é uma forma de recebimento de informações quando um evento acontece. O webhook na prática, é a forma de receber informações entre dois sistemas de uma forma passiva.

No ViaSign, quando um documento for assinado, ou cancelado, ou seja, atingir a fase ASSINADO ou CANCELADO, iremos disparar um evento HTTP POST para a URL que foi informada no documento.

Retornos enviados para a sua URL via POST

Retorno de documento assinado


    {
        "uuid": "UUID-DOCUMENT",
        "type_post": "3",
        "message": "Documento assinado"
    }

            

Retorno de documento cancelado


    {
        "uuid": "UUID-DOCUMENT",
        "type_post": "99",
        "message": "Documento cancelado"
    }

            
Listar Webhook de um documento

Esse objeto irá retornar o webhook cadastrado no documento.

GET /documents/{UUID-DOCUMENT}/webhooks
Resposta (200)

Você receberá uma resposta em JSON com os seguintes objetos

    
        {
            "success": true,
            "webhooks": [
                {
                    "uuid": "78e96490-5567-b6ed-7d44-c3fa019ad832",
                    "url": "http://seuendereco.com.br"
                }
            ]
        }

Exemplo usando SDK PHP

require_once(__DIR__ . '/sdk/vendor/autoload.php');

use ViaSign\Client;
try{
    $client = new Client();
    $client->setAccessToken("{TOKEN-USER}");
    $client->setCryptKey("{CRYPT-KEY-USER}"); //Necessário apenas se o cryptKey estiver habilitado na conta
    
    $webhook = $client->documents->webhooklist("{UUID-DOCUMENT}");
    
    //print_r($webhook);
} catch (Exception $e) {
    echo $e->getMessage();
} 

                
Cadastrar Webhook em um documento

Esse objeto irá cadastrar o webhook no documento.

POST /documents/{UUID-DOCUMENT}/webhooks
Requisição
Parâmetro Descrição
url (obrigatório) URL que receberá o POSTBack do ViaSign após o documento atingir a fase FINALIZADO
Resposta (200)

Você receberá uma resposta em JSON com os seguintes objetos


    {
        "success": true
    }       

                
Exemplo usando SDK PHP

    require_once(__DIR__ . '/sdk/vendor/autoload.php');
    
    use ViaSign\Client;
    try{
        $client = new Client();
        $client->setAccessToken("{TOKEN-USER}");
        $client->setCryptKey("{CRYPT-KEY-USER}"); //Necessário apenas se o cryptKey estiver habilitado na conta
        
        $url = 'http://seudominio.com.br/post.php';
        $webhook = $client->documents->webhookadd("{UUID-DOCUMENT}",$url);
            
        //print_r($webhook);
    } catch (Exception $e) {
        echo $e->getMessage();
    }