ZapSign API
Search…
Criar documento via Upload
post
https://api.zapsign.com.br
/api/v1/docs/?api_token={{seu_token_de_acesso}}
Criar documento via Upload

Campos opcionais da requisição

    Documento - raiz do JSON:
      lang (string): idioma do documento. Valores possíveis: "pt-br" (português), "es" (espanhol), "en" (inglês). Default: "pt-br"
      disable_signer_emails (boolean): para desativar os e-mails enviados aos signatários, envie esse parâmetro como true. Default: false
      signed_file_only_finished (boolean): para desativar os botões "Baixar original" e "Baixar assinado" da experiência de signatário, ative este flag. Assim, você é quem se encarregará de entregar o signed_file ao signatário. Default: false
      brand_logo (string): se deseja personalizar a logomarca da experiência de assinatura deste documento específico, envie a URL da imagem (precisa ser um link publicamente acessível). Default: ""
      brand_primary_color (string): se deseja personalizar a cor primária (do botão) da experiência de assinatura deste documento específico, envie em rgb ou hexadecimal. Ex: "#0011ee". Default: ""
      brand_name (string): se deseja personalizar o nome do remetente dos e-mails enviados ao signatário, insira aqui o nome da marca. Por exemplo, se inserido "XPTO Advogados", o remetente do e-mail será "XPTO Advogados via ZapSign". Max-length: 100 caracteres. Default: ""
      external_id (string): ID do documento na sua aplicação. Default: ""
      folder_path (string): caminho da pasta dentro da ZapSign em que o documento será colocado. Se as pastas não existirem, serão criadas automaticamente. Requisitos: (1) o folder_path pode ter até 255 caracteres, (2) cada pasta pode ter até 50 caracteres, (3) há um limite de 5 níveis de pasta. Ex.: "/api/" ou "/pasta1/pasta2/pasta3/". Default: "/" (sem pasta).
      created_by (string): e-mail do usuário que será definido como criador do documento, para fins de organização interna. Caso o e-mail não exista ou não seja usuário da sua conta, este parâmetro será ignorado. Default: "" (documento terá como criador o proprietário da conta)
    Signers - para cada signer:
      auth_mode (string): Você pode escolher o método de autenticação do signatário. Valores possíveis são: "assinaturaTela" (default), "tokenEmail", "assinaturaTela-tokenEmail", "tokenSms", "assinaturaTela-tokenSms" e "certificadoDigital". Correspondem aos mesmos métodos disponíveis na interface web. Obs: o certificadoDigital tem um custo de R$ 0,50 por signatário que assinar com certificadoDigital.
      email (string): Você pode definir o e-mail do signatário
      send_automatic_email (boolean): Se true, a ZapSign irá enviar um e-mail ao signatário com o link para assinar o documento. Se false (default), você é quem se encarregará de compartilhar o link de assinatura com o signatário, seja pelo seu site, widget, WhatsApp, SMS, e-mail, chat etc. Observação: para isso funcionar, é obrigatório que o email do signatário seja definido.
      custom_message (string): (apenas relevante caso send_automatic_email: true). A custom_message é a mensagem personalizada que você pode inserir no e-mail enviado pela ZapSign ao signatário. Exemplo: "Olá Fulano, \n Este é o seu contrato de trabalho. \n Abraços, Equipe XPTO". O símbolo \n serve para "pular uma linha" no texto do e-mail. Default: ""
      phone_country (string): Você pode definir o telefone (código do país) do signatário. Default: "" (sugestão: utilizar "55" para código do Brasil)
      phone_number (string): Você pode definir o telefone (DDD + número) do signatário. Exemplo: "11998989222". Default: ""
      lock_email (boolean): Você pode bloquear alterações ao e-mail do signatário. Default: false
      lock_phone (boolean): Você pode bloquear alterações ao telefone do signatário. Default: false
      lock_name (boolean): Você pode bloquear alterações ao nome do signatário. Default: false
      require_selfie_photo (boolean): Você pode pedir que o signatário tire uma selfie enquanto assina. Default: false
      require_document_photo (boolean): Você pode pedir que o signatário tire uma foto de seu documento pessoal enquanto assina (ex: RG ou CNH). Default: false
      qualification (string): Qualificação para aparecer no relatório de assinaturas. Ex: valor "testemunha" irá resultar em "Assinou como testemunha". Default: ""
      external_id (string): ID do signatário na sua aplicação. Default: ""
      redirect_link (string): link para redirecionamento após signatário assinar. Por exemplo: "https://www.seusite.com.br/agradecimento". Irá aparecer como um botão "CONTINUAR" abaixo dos botões "Baixar original" e "Baixar assinado". Lembre-se de inserir o http:// ou https:// no começo do link. Default: ""

Exemplo de requisição

Os parâmetros devem estar em formato JSON no corpo da requisição
1
{
2
"name":"Contrato de Admissão João",
3
"base64_pdf":"JVBERi0xLjcNCiWhs8XXDQoxIDA...",
4
"brand_primary_color":"#000000",
5
"signers":[
6
{
7
"name":"João da Silva"
8
},
9
{
10
"name":"Fulano Siclano",
11
"email":"[email protected]",
12
"send_automatic_email":true,
13
"custom_message":"Olá Fulano, \n Este é o seu contrato de trabalho. \n Abraços, Equipe XPTO",
14
"lock_email":true,
15
"lock_phone":true,
16
"phone_country":"55",
17
"phone_number":"11977778600",
18
"auth_mode":"assinaturaTela-tokenSms"
19
}
20
]
21
}
Copied!

O que fazer com a resposta

Após uma requisição bem sucedida, você deverá receber uma resposta como essa:
1
{
2
"open_id": 5,
3
"token": "eb9c367a-e62f-4992-8360-b0219deaeecc",
4
"status": "pending",
5
"name": "Contrato de Admissão João",
6
"original_file": "https://zapsign.s3.amazonaws.com/pdf/62xxxxx-d8fc-4392-8575-f3c46c3cfc7a/df6bac91-2766-4182-8c8b-ded5287e4c0f.pdf",
7
"signed_file": null,
8
"created_at": "2020-04-16T03:33:46.241747Z",
9
"last_update_at": "2020-04-16T03:33:46.241775Z",
10
"signers": [
11
{
12
"token": "921c115d-4a6e-445d-bdca-03fadedbbc0b",
13
"status": "new",
14
"name": "João da Silva",
15
"email": "",
16
"phone_country": "",
17
"phone_number": "",
18
"times_viewed": 0,
19
"last_view_at": null,
20
"signed_at": null
21
},
22
{
23
"token": "07fb0a0a-4b7d-49a5-bd7b-4958265c4e46",
24
"status": "new",
25
"name": "Fulano Siclano",
26
"email": "",
27
"phone_country": "",
28
"phone_number": "",
29
"times_viewed": 0,
30
"last_view_at": null,
31
"signed_at": null
32
}
33
]
34
}
Copied!
O que você deverá fazer com essa resposta é enviar o link de assinatura para os signatários através da sua aplicação.
O link de assinatura consiste na rota: https://app.zapsign.com.br/verificar/{{signer_token}}
Ou seja, no exemplo acima, em que temos dois signatários, você deve enviar dois links de assinatura, cada signatário com seu respectivo token: - João da Silva: https://app.zapsign.com.br/verificar/921c115d-4a6e-445d-bdca-03fadedbbc0b - Fulano Siclano: https://app.zapsign.com.br/verificar/07fb0a0a-4b7d-49a5-bd7b-4958265c4e46
E agora é só aguardar que os signatários assinem!

Sobre o base64

Base64 é uma maneira simples de converter um arquivo em texto. Veja aqui uma definição mais completa https://pt.wikipedia.org/wiki/Base64. Assim, converter o arquivo em base64 e enviar como texto no corpo da requisição é mais fácil do que lidar com multipart/form-data, por exemplo.
Para testar a API, você pode converter manualmente seu PDF em base64 através de vários sites, como esse: https://base64.guru/converter/encode/pdf
Quando a API já estiver integrada em seu sistema, procure a função adequada na sua linguagem de programação que pode converter o arquivo em base64.
Observação: você deve enviar o parâmetro base64_pdf apenas com a conversão do arquivo em base64. Não insira data:application/pdf;base64, na sua string.
Não quer trabalhar com base64? Suba seu PDF em uma url pública e use o parâmetro url_pdf.

Exemplos de requisição em algumas linguagens de programação

PHP

1
<?php
2
3
$url = "https://api.zapsign.com.br/api/v1/docs/?api_token=1e19d1f9-69e0-4a66-b93d-e515fdf081c693b8b613-25e9-4536-b5df-76d25120449a";
4
$ch = curl_init( $url );
5
6
$base64 = 'JVBERi0xLjMNCiXi48/TDQoNCjEgMCBvYmoNCjw8DQovVHlwZSAvQ2F0YWxvZw0KL091dGxpbmVzIDIgMCBSDQovUGFnZXMgMyAwIFINCj4+DQplbmRvYmoNCg0KMiAwIG9iag0KPDwNCi9UeXBlIC9PdXRsaW5lcw0KL0NvdW50IDANCj4+DQplbmRvYmoNCg0KMyAwIG9iag0KPDwNCi9UeXBlIC9QYWdlcw0KL0NvdW50IDINCi9LaWRzIFsgNCAwIFIgNiAwIFIgXSANCj4+DQplbmRvYmoNCg0KNCAwIG9iag0KPDwNCi9UeXBlIC9QYWdlDQovUGFyZW50IDMgMCBSDQovUmVzb3VyY2VzIDw8DQovRm9udCA8PA0KL0YxIDkgMCBSIA0KPj4NCi9Qcm9jU2V0IDggMCBSDQo+Pg0KL01lZGlhQm94IFswIDAgNjEyLjAwMDAgNzkyLjAwMDBdDQovQ29udGVudHMgNSAwIFINCj4+DQplbmRvYmoNCg0KNSAwIG9iag0KPDwgL0xlbmd0aCAxMDc0ID4+DQpzdHJlYW0NCjIgSg0KQlQNCjAgMCAwIHJnDQovRjEgMDAyNyBUZg0KNTcuMzc1MCA3MjIuMjgwMCBUZA0KKCBBIFNpbXBsZSBQREYgRmlsZSApIFRqDQpFVA0KQlQNCi9GMSAwMDEwIFRmDQo2OS4yNTAwIDY4OC42MDgwIFRkDQooIFRoaXMgaXMgYSBzbWFsbCBkZW1vbnN0cmF0aW9uIC5wZGYgZmlsZSAtICkgVGoNCkVUDQpCVA0KL0YxIDAwMTAgVGYNCjY5LjI1MDAgNjY0LjcwNDAgVGQNCigganVzdCBmb3IgdXNlIGluIHRoZSBWaXJ0dWFsIE1lY2hhbmljcyB0dXRvcmlhbHMuIE1vcmUgdGV4dC4gQW5kIG1vcmUgKSBUag0KRVQNCkJUDQovRjEgMDAxMCBUZg0KNjkuMjUwMCA2NTIuNzUyMCBUZA0KKCB0ZXh0LiBBbmQgbW9yZSB0ZXh0LiBBbmQgbW9yZSB0ZXh0LiBBbmQgbW9yZSB0ZXh0LiApIFRqDQpFVA0KQlQNCi9GMSAwMDEwIFRmDQo2OS4yNTAwIDYyOC44NDgwIFRkDQooIEFuZCBtb3JlIHRleHQuIEFuZCBtb3JlIHRleHQuIEFuZCBtb3JlIHRleHQuIEFuZCBtb3JlIHRleHQuIEFuZCBtb3JlICkgVGoNCkVUDQpCVA0KL0YxIDAwMTAgVGYNCjY5LjI1MDAgNjE2Ljg5NjAgVGQNCiggdGV4dC4gQW5kIG1vcmUgdGV4dC4gQm9yaW5nLCB6enp6ei4gQW5kIG1vcmUgdGV4dC4gQW5kIG1vcmUgdGV4dC4gQW5kICkgVGoNCkVUDQpCVA0KL0YxIDAwMTAgVGYNCjY5LjI1MDAgNjA0Ljk0NDAgVGQNCiggbW9yZSB0ZXh0LiBBbmQgbW9yZSB0ZXh0LiBBbmQgbW9yZSB0ZXh0LiBBbmQgbW9yZSB0ZXh0LiBBbmQgbW9yZSB0ZXh0LiApIFRqDQpFVA0KQlQNCi9GMSAwMDEwIFRmDQo2OS4yNTAwIDU5Mi45OTIwIFRkDQooIEFuZCBtb3JlIHRleHQuIEFuZCBtb3JlIHRleHQuICkgVGoNCkVUDQpCVA0KL0YxIDAwMTAgVGYNCjY5LjI1MDAgNTY5LjA4ODAgVGQNCiggQW5kIG1vcmUgdGV4dC4gQW5kIG1vcmUgdGV4dC4gQW5kIG1vcmUgdGV4dC4gQW5kIG1vcmUgdGV4dC4gQW5kIG1vcmUgKSBUag0KRVQNCkJUDQovRjEgMDAxMCBUZg0KNjkuMjUwMCA1NTcuMTM2MCBUZA0KKCB0ZXh0LiBBbmQgbW9yZSB0ZXh0LiBBbmQgbW9yZSB0ZXh0LiBFdmVuIG1vcmUuIENvbnRpbnVlZCBvbiBwYWdlIDIgLi4uKSBUag0KRVQNCmVuZHN0cmVhbQ0KZW5kb2JqDQoNCjYgMCBvYmoNCjw8DQovVHlwZSAvUGFnZQ0KL1BhcmVudCAzIDAgUg0KL1Jlc291cmNlcyA8PA0KL0ZvbnQgPDwNCi9GMSA5IDAgUiANCj4+DQovUHJvY1NldCA4IDAgUg0KPj4NCi9NZWRpYUJveCBbMCAwIDYxMi4wMDAwIDc5Mi4wMDAwXQ0KL0NvbnRlbnRzIDcgMCBSDQo+Pg0KZW5kb2JqDQoNCjcgMCBvYmoNCjw8IC9MZW5ndGggNjc2ID4+DQpzdHJlYW0NCjIgSg0KQlQNCjAgMCAwIHJnDQovRjEgMDAyNyBUZg0KNTcuMzc1MCA3MjIuMjgwMCBUZA0KKCBTaW1wbGUgUERGIEZpbGUgMiApIFRqDQpFVA0KQlQNCi9GMSAwMDEwIFRmDQo2OS4yNTAwIDY4OC42MDgwIFRkDQooIC4uLmNvbnRpbnVlZCBmcm9tIHBhZ2UgMS4gWWV0IG1vcmUgdGV4dC4gQW5kIG1vcmUgdGV4dC4gQW5kIG1vcmUgdGV4dC4gKSBUag0KRVQNCkJUDQovRjEgMDAxMCBUZg0KNjkuMjUwMCA2NzYuNjU2MCBUZA0KKCBBbmQgbW9yZSB0ZXh0LiBBbmQgbW9yZSB0ZXh0LiBBbmQgbW9yZSB0ZXh0LiBBbmQgbW9yZSB0ZXh0LiBBbmQgbW9yZSApIFRqDQpFVA0KQlQNCi9GMSAwMDEwIFRmDQo2OS4yNTAwIDY2NC43MDQwIFRkDQooIHRleHQuIE9oLCBob3cgYm9yaW5nIHR5cGluZyB0aGlzIHN0dWZmLiBCdXQgbm90IGFzIGJvcmluZyBhcyB3YXRjaGluZyApIFRqDQpFVA0KQlQNCi9GMSAwMDEwIFRmDQo2OS4yNTAwIDY1Mi43NTIwIFRkDQooIHBhaW50IGRyeS4gQW5kIG1vcmUgdGV4dC4gQW5kIG1vcmUgdGV4dC4gQW5kIG1vcmUgdGV4dC4gQW5kIG1vcmUgdGV4dC4gKSBUag0KRVQNCkJUDQovRjEgMDAxMCBUZg0KNjkuMjUwMCA2NDAuODAwMCBUZA0KKCBCb3JpbmcuICBNb3JlLCBhIGxpdHRsZSBtb3JlIHRleHQuIFRoZSBlbmQsIGFuZCBqdXN0IGFzIHdlbGwuICkgVGoNCkVUDQplbmRzdHJlYW0NCmVuZG9iag0KDQo4IDAgb2JqDQpbL1BERiAvVGV4dF0NCmVuZG9iag0KDQo5IDAgb2JqDQo8PA0KL1R5cGUgL0ZvbnQNCi9TdWJ0eXBlIC9UeXBlMQ0KL05hbWUgL0YxDQovQmFzZUZvbnQgL0hlbHZldGljYQ0KL0VuY29kaW5nIC9XaW5BbnNpRW5jb2RpbmcNCj4+DQplbmRvYmoNCg0KMTAgMCBvYmoNCjw8DQovQ3JlYXRvciAoUmF2ZSBcKGh0dHA6Ly93d3cubmV2cm9uYS5jb20vcmF2ZVwpKQ0KL1Byb2R1Y2VyIChOZXZyb25hIERlc2lnbnMpDQovQ3JlYXRpb25EYXRlIChEOjIwMDYwMzAxMDcyODI2KQ0KPj4NCmVuZG9iag0KDQp4cmVmDQowIDExDQowMDAwMDAwMDAwIDY1NTM1IGYNCjAwMDAwMDAwMTkgMDAwMDAgbg0KMDAwMDAwMDA5MyAwMDAwMCBuDQowMDAwMDAwMTQ3IDAwMDAwIG4NCjAwMDAwMDAyMjIgMDAwMDAgbg0KMDAwMDAwMDM5MCAwMDAwMCBuDQowMDAwMDAxNTIyIDAwMDAwIG4NCjAwMDAwMDE2OTAgMDAwMDAgbg0KMDAwMDAwMjQyMyAwMDAwMCBuDQowMDAwMDAyNDU2IDAwMDAwIG4NCjAwMDAwMDI1NzQgMDAwMDAgbg0KDQp0cmFpbGVyDQo8PA0KL1NpemUgMTENCi9Sb290IDEgMCBSDQovSW5mbyAxMCAwIFINCj4+DQoNCnN0YXJ0eHJlZg0KMjcxNA0KJSVFT0YNCg==';
7
$payload = array(
8
"name"=>"Contrato de Admissão João",
9
"signers"=>array(
10
array(
11
"name"=>"João da Silva"
12
),
13
array(
14
"name"=>"Fulano Siclano",
15
"email"=>"[email protected]",
16
"auth_mode"=>"tokenEmail"
17
)
18
),
19
"base64_pdf"=>$base64
20
);
21
$json_payload = json_encode($payload);
22
23
curl_setopt( $ch, CURLOPT_POSTFIELDS, $json_payload );
24
curl_setopt( $ch, CURLOPT_HTTPHEADER, array('Content-Type:application/json'));
25
curl_setopt( $ch, CURLOPT_RETURNTRANSFER, true );
26
curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, 0);
27
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, 0);
28
29
$result = curl_exec($ch);
30
31
// A depender da versão de php, curl e OpenSSL do seu servidor,
32
// você pode testar também outras opções do curl, como:
33
// curl_setopt ($ch, CURLOPT_SSL_VERIFYPEER, 0);
34
// curl_setopt ($ch, CURLOPT_SSL_VERIFYHOST, 0);
35
// curl_setopt ($ch, CURLOPT_FOLLOWLOCATION, TRUE);
36
// curl_setopt ($ch, CURLOPT_SSLVERSION, 6);
37
// curl_setopt ($ch, CURLOPT_USERAGENT, "Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/42.0.2311.135 Safari/537.36");
38
// curl_setopt ($ch, CURLOPT_COOKIESESSION, TRUE);
39
// curl_setopt ($ch, CURLOPT_RETURNTRANSFER, 1);
40
// curl_setopt( $ch, CURLOPT_POSTFIELDS, $json_payload );
41
// curl_setopt( $ch, CURLOPT_HTTPHEADER, array('Content-Type:application/json'));
42
// curl_setopt ($ch, CURLOPT_HEADER, 1);
43
// curl_setopt ($ch, CURLOPT_POST, true);
44
// curl_setopt ($ch, CURLOPT_FRESH_CONNECT , 1);
45
// curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
46
// curl_setopt($ch, CURLOPT_HTTPAUTH, CURLAUTH_BASIC);
47
48
// Para testes/debug, descomentar:
49
// echo $result;
50
// echo curl_getinfo($ch);
51
// echo curl_errno($ch);
52
// echo curl_error($ch);
53
54
curl_close($ch);
Copied!

Python

1
import requests
2
3
url = "https://api.zapsign.com.br/api/v1/docs/?api_token=1e19d1f9-69e0-4a66-b93d-e515fdf081c693b8b613-25e9-4536-b5df-76d25120449a"
4
5
payload = "{\"name\":\"Contrato de Admissão João\",\"signers\":[{\"name\":\"João da Silva\"},{ \"name\":\"Fulano Siclano\"}],\"base64_pdf\":\"JVBERi0xLjcNCiWhs8XXDQoxIDA...\"}"
6
headers = {
7
'Content-Type': 'application/json'
8
}
9
10
response = requests.request("POST", url, headers=headers, data = payload)
11
12
print(response.text.encode('utf8'))
Copied!

Node.js

1
var request = require('request');
2
var options = {
3
'method': 'POST',
4
'url': 'https://api.zapsign.com.br/api/v1/docs/?api_token=1e19d1f9-69e0-4a66-b93d-e515fdf081c693b8b613-25e9-4536-b5df-76d25120449a',
5
'headers': {
6
'Content-Type': 'application/json'
7
},
8
body: JSON.stringify({"name":"Contrato de Admissão João","signers":[{"name":"João da Silva"},{"name":"Fulano Siclano"}],"base64_pdf":"JVBERi0xLjcNCiWhs8XXDQoxIDA..."})
9
10
};
11
request(options, function (error, response) {
12
if (error) throw new Error(error);
13
console.log(response.body);
14
});
15
Copied!

Delphi

1
var
2
json : string;
3
ArraySigner : TJSONArray;
4
ObjDoc, ObjSigner : TJSONObject;
5
begin
6
ObjDoc := TJSONObject.Create;
7
ObjDoc.AddPair('name', 'Contrato de Locação');
8
ObjDoc.AddPair('base64_pdf', 'ASFASDFKÇLKÇGÇO#OP%$%#WERP#@&*OSADFJF...'); // Arquivo base64
9
10
ArraySigner := TJSONArray.Create;
11
12
ObjSigner := TJSONObject.Create;
13
ObjSigner.AddPair('name', 'João da Silva');
14
ObjSigner.AddPair('email', '[email protected]');
15
ObjSigner.AddPair('phone_country', '55');
16
ObjSigner.AddPair('phone_number', '11888121111');
17
// Opcional caso queira impedir alteração
18
ObjSigner.AddPair('lock_name', TJSONTrue.Create);
19
ObjSigner.AddPair('lock_email', TJSONTrue.Create);
20
ObjSigner.AddPair('lock_phone', TJSONTrue.Create);
21
22
ArraySigner.AddElement(ObjSigner);
23
24
ObjDoc.AddPair('signers', ArraySigner);
25
json := ObjDoc.ToString;
26
27
ObjDoc.DisposeOf;
28
29
RESTClient.BaseURL := 'https://api.zapsign.com.br/api/v1/docs/?api_token=...seu token..';
30
Request_remete.ClearBody;
31
Request_remete.Body.Add(json,ContentTypeFromString('application/json'));
32
Request_remete.Execute;
33
end;
Copied!
Last modified 1mo ago