| REST API: Use GET and POST. Send and receive data in JSON. | |||||
Null Strings: Do not send null for string fields. Use "" or omit the field. | |||||
Booleans vs. Strings: Use real booleans. true and false are not the same as "true" and "false". |
| Environment | Endpoint | Legal Validity |
|---|---|---|
| Sandbox | https://sandbox.api.zapsign.com.br | Does not have legal validity |
| Production | https://api.zapsign.com.br | Has legal validity |
User navigating to obtain their API token.
| Implement Caching: Use caching techniques to reduce the number of repeated requests to the server. | /files/lTQ3RRm2s3TeQUhyxRUc | ||
| Request Optimization: Aggregate multiple operations into a single request when possible. | /files/lTQ3RRm2s3TeQUhyxRUc | ||
| Error Management: Implement exponential backoff logic to handle rate limit exceeded responses (HTTP 429). | /files/lTQ3RRm2s3TeQUhyxRUc |
ZapSign service status page
Remember that you will always need an API plan to integrate tools with ZapSign.
const apiToken: string = "YOUR TOKEN";
const apiToken: string = "YOUR TOKEN";
const apiToken: string = "YOUR TOKEN";
const fromToTemplateName: DeParaTemplateBuilder = deParaTemplateBuilder()
.de("{{FULL NAME}}") // the variable
.para("Jhon Doe") // the value to replace
.build();
const fromToTemplateSocialSecurty: DeParaTemplateBuilder = deParaTemplateBuilder()
.de("{{Social Security Number}}")
.para("9999999999")
.build();
const fromToTemplateAdress: DeParaTemplateBuilder = deParaTemplateBuilder()
.de("{{Full address}}")
.para("999 N Main St")
.build();
let fromToTemplates: DeParaTemplatesBuilder[] = [];
fromToTemplates.push(fromToTemplateName, fromToTemplateSocialSecurty, fromToTemplateAdress);
import { DeParaTemplateBuilder } from "sdk-node-typescript-zapsign/src/body/doc/builders/DeParaTemplateBuilder";
import DocRequests from "sdk-node-typescript-zapsign/src/docs/DocRequests";
import { JsonConverter } from "sdk-node-typescript-zapsign/src/services/JsonConverter";
import { DocFromTemplate } from "sdk-node-typescript-zapsign/src/body/doc/builders/DocFromTemplate";
const apiToken: string = "YOUR TOKEN";
const fromToTemplateName: DeParaTemplateBuilder = DeParaTemplateBuilder()
.de("{{Full Name}}")
.para("Jhon Doe")
.build();
const fromToTemplateCpf: DeParaTemplateBuilder = DeParaTemplateBuilder()
.de("{{Social Security Number}}")
.para("9999999999")
.build();
const fromToTemplateEndereco: DeParaTemplateBuilder = DeParaTemplateBuilder()
.de("{{Full address}}")
.para("999 N Main St")
.build();
let fromToTemplates: DeParaTemplatesBuilder[] = [];
fromToTemplates.push(fromToTemplateName, fromToTemplateCpf, fromToTemplateEndereco);
const docFromTemplate: DocFomTemplateBuilder = new DocFromTemplateBuilder()
.withSandbox(false)
.withPrimaryColor("#000000")
.withSignerName("My Signer for Template")
.withTemplateId("YOUR TEMPLATE ID")
.withData(fromToTemplates)
.build();
async function exempleCreateDocFromTemplate() {
try {
docResponse: DocResponse = await new DocRequests(apiToken).createDocFromTemplate(docFromTemplate);
jsonDocResponse: string = new JsonConverter().docAsyncResponseToJson(docResponse);
console.log(jsonDocResponse);
} catch(Err) {
console.log(Err);
}
}
const apiToken: string = "YOUR TOKEN";
const fromToTemplateName: DeParaTemplateBuilder = deParaTemplateBuilder()
.de("{{FULL NAME}}") // the variable
.para("Jhon Doe") // the value to replace
.build();
const fromToTemplateSocialSecurty: DeParaTemplateBuilder = deParaTemplateBuilder()
.de("{{Social Security Number}}")
.para("9999999999")
.build();
const fromToTemplateAdress: DeParaTemplateBuilder = deParaTemplateBuilder()
.de("{{Full address}}")
.para("999 N Main St")
.build();
let fromToTemplates: DeParaTemplatesBuilder[] = [];
fromToTemplates.push(fromToTemplateName, fromToTemplateSocialSecurty, fromToTemplateAdress);
import { DeParaTemplateBuilder } from "sdk-node-typescript-zapsign/src/body/doc/builders/DeParaTemplateBuilder";
import DocRequests from "sdk-node-typescript-zapsign/src/docs/DocRequests";
import { JsonConverter } from "sdk-node-typescript-zapsign/src/services/JsonConverter";
import { DocFromTemplate } from "sdk-node-typescript-zapsign/src/body/doc/builders/DocFromTemplate";
const apiToken: string = "YOUR TOKEN";
const fromToTemplateName: DeParaTemplateBuilder = DeParaTemplateBuilder()
.de("{{Full Name}}")
.para("Jhon Doe")
.build();
const fromToTemplateCpf: DeParaTemplateBuilder = DeParaTemplateBuilder()
.de("{{Social Security Number}}")
.para("9999999999")
.build();
const fromToTemplateEndereco: DeParaTemplateBuilder = DeParaTemplateBuilder()
.de("{{Full address}}")
.para("999 N Main St")
.build();
let fromToTemplates: DeParaTemplatesBuilder[] = [];
fromToTemplates.push(fromToTemplateName, fromToTemplateCpf, fromToTemplateEndereco);
const docFromTemplate: DocFomTemplateBuilder = new DocFromTemplateBuilder()
.withSandbox(false)
.withPrimaryColor("#000000")
.withSignerName("My Signer for Template")
.withTemplateId("YOUR TEMPLATE ID")
.withData(fromToTemplates)
.build();
async function exempleCreateDocFromTemplate() {
try {
docResponse: DocResponse = await new DocRequests(apiToken).createDocFromTemplate(docFromTemplate);
jsonDocResponse: string = new JsonConverter().docAsyncResponseToJson(docResponse);
console.log(jsonDocResponse);
} catch(Err) {
console.log(Err);
}
}
const apiToken: string = "YOUR TOKEN";
const docToken: string = "ORIGINAL DOCUMENT TOKEN";
async function exempleAddExtraDoc() {
try {
docResponse: DocResponse = await new DocRequests(apiToken).addExtraDoc(docToken, extraDoc);
jsonDocResponse: string = new JsonConverter().extraDocToJson(docResponse);
console.log(jsonDocResponse);
} catch(Err) {
console.log(Err);
}
}
}
import DocRequests from "sdk-node-typescript-zapsign/src/docs/DocRequests";
import { JsonConverter } from "sdk-node-typescript-zapsign/src/services/JsonConverter";
import { ExtraDocBuilder } from "sdk-node-typescript-zapsign/src/body/doc/builders/ExtraDocBuilder";
const apiToken: string = "YOUR TOKEN";
const docToken: string = "DOCUMENT ORIGINAL TOKEN";
const extraDoc: ExtraDocBuilder = ExtraDocBuilder()
.withName("Extra Doc Name")
.withUrlPdf("https://zapsign.s3.amazonaws.com/2022/1/pdf/63d19807-cbfa-4b51-8571-215ad0f4eb98/ca42e7be-c932-482c-b70b-92ad7aea04be.pdf")
.build();
async function exempleAddExtraDoc() {
try {
docResponse: DocResponse = await new DocRequests(apiToken).addExtraDoc(docToken, extraDoc);
jsonDocResponse: string = new JsonConverter().extraDocToJson(docResponse);
console.log(jsonDocResponse);
} catch(Err) {
console.log(Err);
}
}
const apiToken: string = "YOUR TOKEN";
const docToken: string = "ORIGINAL DOCUMENT TOKEN";
import DocRequests from "sdk-node-typescript-zapsign/src/docs/DocRequests";
import { JsonConverter } from "sdk-node-typescript-zapsign/src/services/JsonConverter";
const apiToken: string = "YOUR TOKEN";
const docToken: string = "ORIGINAL DOCUMENT TOKEN";
async function exempleDetailDoc() {
try {
const docResponse: DocResponse = await new DocRequests(apiToken).detailDoc(docToken);
const jsonDocResponse: string = new JsonConverter().docResponseToJson(docResponse);
console.log(jsonDocResponse);
} catch(Err) {
console.log(Err);
}
}
const apiToken: string = "YOUR TOKEN";
const apiToken: string = "YOUR TOKEN";
const docToken: string = "ORIGINAL DOCUMENT TOKEN";
const apiToken: string = "YOUR TOKEN";
const docToken: string = "ORIGINAL DOCUMENT TOKEN";
import DocRequests from "sdk-node-typescript-zapsign/src/docs/DocRequests";
import { JsonConverter } from "sdk-node-typescript-zapsign/src/services/JsonConverter";
import { RubricaBuilder } from "sdk-node-typescript-zapsign/src/body/doc/builders/RubricaBuilder";
import { RubricasArray } from "sdk-node-typescript-zapsign/src/body/doc/RubricasArray";
const apiToken: string = "YOUR TOKEN";
const docToken: string = "ORIGINAL DOCUMENT TOKEN";
const rubrica1: RubricaBuilder = RubricaBuilder()
.withPage(0)
.withtRelativePositionBottom(52.50)
.withRelativePositionLeft(75.71)
.withRelativeSizeX(19.55)
.withRelativePositionSizeY(9.42)
.withType("signature")
.withSignerToken("SIGNER TOKEN")
.build();
const rubrica2: RubricaBuilder = rubricaBuilder()
.withPage(0)
.withtRelativePositionBottom(13.50)
.withRelativePositionLeft(20.71)
.withRelativeSizeX(19.55)
.withRelativePositionSizeY(9.42)
.withType("signature")
.withSignerToken("SIGNER TOKEN")
.build();
let rubricas = RubricaBuilder[];
rubricas.push(rubrica1, rubrica2);
const rubricasArray = new RubricasArray(rubricas);
async function exempleAddExtraDoc() {
try {
statusCode: number = await new DocRequests(apiToken).placeSignatures(docToken, rubricasArray);
console.log(statusCode);
} catch(Err) {
console.log(Err);
}
}
}
const apiToken: string = "YOUR TOKEN";
try {
docResponse = new DocRequests(apiToken).createDocFromPdfBase64(docFromPdfBase64);
jsonDocResponse: string = new JsonConverter().docResponseToJson(docResponse);
console.log(jsonDocResponse);
} catch {
console.log(Err);
}
const apiToken: string = "YOUR TOKEN";
const apiToken: string = "YOUR TOKEN";
import SignerRequest from "sdk-node-typescript-zapsign/src/signer/SignerRequest";
import { JsonConverter } from "sdk-node-typescript-zapsign/src/services/JsonConverter";
const apiToken: string = "YOUR TOKEN";
const signerToken: string = "SIGNER TOKEN";
async function exempleDetailSigner() {
try {
const signerRequest: SignerRequest = await new SignerRequest(apiToken).detailSigner(signerToken);
const jsonDocResponse: string = new JsonConverter().signerToJson(docResponse);
console.log(jsonDocResponse);
} catch(Err) {
console.log(Err);
}
}
}
const apiToken: string = "YOUR TOKEN";
import SignerRequest from "sdk-node-typescript-zapsign/src/signer/SignerRequest";
import { JsonConverter } from "sdk-node-typescript-zapsign/src/services/JsonConverter";
import { SignerBuilder } from "sdk-node-typescript-zapsign/src/body/signer/builders/SignerBuilder";
const apiToken: string = "YOUR TOKEN";
const signerToken: string = "SIGNER TOKEN";
const signerBuilder = SignerBuilder()
.withName("New Signer Name")
.withEmail("newEmail@test.com")
.withLockEmail(true)
.withLockPhone(true)
.withPhoneCountry("55")
.withPhoneNumber("999999999")
.withAuthMode("assinaturaTela") // draw on screen
.withSendAutomaticAemail(false)
.withSendAutomaticWhatsApp(false)
.build();
async function exempleUpdateSigner() {
try {
signerResponse: string = new SignerRequest(apiToken).updateSigner(signerToken, signer);
jsonDocResponse: string = new JsonConverter().signerToJson(signerResponse);
console.log(jsonDocResponse);
}
catch(Err) {
console.log(Err);
}
}
const apiToken: string = "YOUR TOKEN";
import SignerRequest from "sdk-node-typescript-zapsign/src/signer/SignerRequest";
import { JsonConverter } from "sdk-node-typescript-zapsign/src/services/JsonConverter";
import { SignerBuilder } from "sdk-node-typescript-zapsign/src/body/signer/builders/SignerBuilder";
const apiToken: string = "SEU TOKEN";
const docToken: string = "TOKEN DOCUMENTO";
const signerBuilder = SignerBuilder()
.withName("New Signer Name")
.withEmail("newEmail@test.com")
.withLockEmail(true)
.withLockPhone(true)
.withPhoneCountry("55")
.withPhoneNumber("999999999")
.withAuthMode("assinaturaTela") // draw on screen
.withSendAutomaticAemail(false)
.withSendAutomaticWhatsApp(false)
.build();
async function exempleAddSigner() {
try {
signerResponse: string = new SignerRequest(apiToken).addSigner(signerToken, signer);
jsonDocResponse: string = new JsonConverter().signerToJson(signerResponse);
console.log(jsonDocResponse);
}
catch(Err) {
console.log(Err);
}
}
const apiToken: string = "YOUR TOKEN";
import SignerRequest from "sdk-node-typescript-zapsign/src/signer/SignerRequest";
const apiToken: string = "YOUR TOKEN";
const signerToken: string = "SIGNER TOKEN";
async function exempleDeleteSigner() {
try {
response: string = new SignerRequest(apiToken).deleteSigner(signerToken);
console.log(response);
}
catch(Err) {
console.log(Err);
}
}
const apiToken: string = "YOUR TOKEN";
import SignerRequest from "sdk-node-typescript-zapsign/src/signer/SignerRequest";
import { JsonConverter } from "sdk-node-typescript-zapsign/src/services/JsonConverter";
import { SignBatchBuilder } from "sdk-node-typescript-zapsign/src/body/signer/builders/SignBatchBuilder";
const apiToken: string = "YOUR TOKEN";
const userToken: string = "USER TOKEN";
const signerToken1: string = "FIRST SIGNER TOKEN";
const signerToken2: string = "SECOND SIGNER TOKEN";
let signersToken: string[] = [];
signersToken.push(signerToken1, signerToken2);
const signBatch = SignBatchBuilder()
.withUserToken(userToken)
.withSignerTokens(signersToken)
.build();
async function exempleSignInBatch() {
try {
signerResponse: string = new SignerRequest(apiToken).signInBatch(signBatch);
jsonDocResponse: string = new JsonConverter().signerToJson(signerResponse);
console.log(jsonDocResponse);
}
catch(Err) {
console.log(Err);
}
}
| name | type | description |
|---|---|---|
| name | string | document name |
| lang | string | document language. Possible values: "pt-br" (Portuguese), "es" (Spanish), "en" (English). Default: "pt-br" |
| disable_signer_emails | boolean | To disable emails sent to signers, send this parameter to true. Default: false |
| signed_file_only_finished | boolean | To disable the "Download Original" and "Download Signed" buttons from the signer experience, enable this flag. Thus, you are the one who will be in charge of delivering the signed_file to the signer. Default: false |
| brand_logo | string | If you want to customize the logo of the signing experience for this specific document, submit the image URL (must be a publicly accessible link). Default: "" |
| brand_primary_color | string | If you want to customize the primary (button) color of the signing experience for this specific document, send it in rgb or hexadecimal. Ex: "#0011ee". Default: "" |
| brand_name | string | if you want to customize the sender name of emails sent to the signer, enter the brand name here. For example, if you entered "XPTO Advogados", the sender of the email will be "XPTO Advogados via ZapSign". Max-length: 100 characters. Default: "" |
| external_id | string | ID of the document in your application. Default: "" |
| folder_path | string | path of the folder inside ZapSign where the document will be placed. If the folders do not exist, they will be created automatically. Requirements: (1) folder_path can be up to 255 characters long, (2) each folder can be up to 50 characters long, (3) there is a limit of 5 folder levels. Ex.: "/api/" or "/folder1/folder2/folder3/". Default: "/" (no folder). |
| date_limit_to_sign | Date | Deadline for signing the document. (Accepted formats: YYYY-MM-DD, YYYY-MM-DDTH:m:s.ssssssZ) |
| signature_order_active | boolean | If true, the signer's signatures will be ordered sequentially. Default: false |
| observers | string[] | Represents document observers (limit 20), i.e. email addresses that will be notified upon completion of the signature flow. It's an array of strings. |
| signers | Signer[] | Represents the document signers |
| reminder_every_n_days | int | Represents the interval of days between reminders that will be sent to signers, as long as they don`t sign. There will be 3 tries at most. Observation: this field must only be filled if send_automatic_whatsapp or send_automatic_email are true. Example: if setted to 8 it will be sent one email every 7 days, until it's signed, for at most 21 days. |
| created_by | CreateBy | email of the user who will be defined as creator of the document, for internal organization purposes. If the email does not exist or is not your account user, this parameter will be ignored. Default: "" (document will have account owner as creator) |
| name | type | description |
|---|---|---|
| url_docx | string | docx url for document creation |
| name | type | description |
|---|---|---|
| signer_name | string | Signer name |
| template_id | string | Template Id |
| data | DeParaTemplate[] | class list of variables |
| send_automatic_email | boolean | If true, ZapSign will send an email to the signer with the link to sign the document. If false (default), you will be responsible for sharing the subscription link with the signatory, whether through your website, widget, WhatsApp, SMS, email, chat etc. Note: For this to work, it is mandatory that the signer's email address is defined. |
| send_automatic_whatsapp | boolean | If true, ZapSign will send a whatsapp to the signer with the link to sign the document. If false (default), you will be responsible for sharing the subscription link with the signatory, whether through your website, widget, WhatsApp, SMS, email, chat etc. Note: For this to work, it is mandatory that the signer's cell phone is defined. |
| custom_message | string | The custom_message is the personalized message that you can insert in the email sent by ZapSign to the signer. Example: "Hello So-and-so, \n This is your employment contract. \n Hugs, Team XPTO". The \n symbol serves to "skip a line" in the email text. Default: "" |
| signer_has_incomplete_fields | boolean | If set to true, the signer will be redirected to fill out the template form before signing the document. Default: false |
You can hide the signer's phone number in the signature report.
Default: false
| | lock\_name | boolean |You can lock changes to the signer's name.
Default: false
| | require\_selfie\_photo | boolean | You can ask the signer to take a selfie while signing. Default: false. | | selfie\_validation\_type | string |You can ask the signer to take a photo of your personal document while signing. Default: falseIf you want to use facial recognition (liveness+document match validation) provided by Truora, please also define this field as "liveness-document-match".
Default: "none". Note that this feature has an extra cost, please contact sales.
| | qualification | string | Qualification to appear in the signatures report. Ex: "Witness" value will result in "Signed as a witness". Default: "" | | external\_id | string |ID of the signer in your application.
Default: ""
| | redirect\_link | string | link to redirect after signer signs. For example: "| name | type | description |
|---|---|---|
| open_id | int | sequencial number of this document inside your company |
| token | string | Document token |
| status | string | Document status: "em-curso", "assinado", "recusado" or "lixeira" |
| original_file | string | Url of original file saved on amazon |
| signed_file | string | Signed file url saved on amazon |
| created_through | string | Where this document was created: "web" or "api" |
| extra_docs | ExtraDocResponse[] | Document extra documents list |
| deleted | boolean | If True, the document has been deleted |
| deleted_at | string | Date the document was deleted |
| created_at | string | Date the document was created |
| last_update_at | string | Last date the document was updated |
| template | Template | If the document was created by a model, it contains the model token |
| answers | Answers[] | List of variables and values for creating this document |
| auto_reminder | int | Number of times this document will notify signers |
| signers | Signer[] | represents the list of signers saved in the document |
| name | type | description |
|---|---|---|
| name | string | You can set the signer's name. |
| string | You can set the signer's email. | |
| auth_mode | string | You can choose the signer's authentication method. Possible values are: "assinaturaTela" (default) (signature on screen), "tokenEmail", "assinaturaTela-tokenEmail", "tokenSms" and "assinaturaTela-tokenSms". They correspond to the same methods available in the web interface. |
| send_automatic_email | boolean | If true, ZapSign will send an email to the signer with the link to sign the document. If false (default), you will be responsible for sharing the subscription link with the signatory, whether through your website, widget, WhatsApp, SMS, email, chat etc. Note: For this to work, it is mandatory that the signer's email address is defined. |
| send_automatic_whatsapp | boolean | If true, ZapSign will send a whatsapp to the signer with the link to sign the document. If false (default), you will be responsible for sharing the subscription link with the signatory, whether through your website, widget, WhatsApp, SMS, email, chat etc. Note: For this to work, it is mandatory that the signer's cell phone is defined. |
| order_group | int | In case "signature_order_active" is active in the document, this field controls the signing order. Example: If the field is set to 0, then this signer will be the first to sign. If the field is set to 1, then this signer will be the second to sign and so on. |
| custom_message | string | (only relevant if send_automatic_email: true). The custom_message is the personalized message that you can insert in the email sent by ZapSign to the signer. Example: "Hello So-and-so, \n This is your employment contract. \n Hugs, Team XPTO". The \n symbol serves to "skip a line" in the email text. Default: "" |
| phone_country | string | You can set the phone (country code) of the signer. Default: "" (ie. US is "1") |
| phone_number | string | You can set the phone number of the signer. Example: "11998989222". Default: "" |
| lock_email | boolean | You can lock changes to the signer's email. Default: false |
| blank_email | boolean | You may not request the signer's email. Default: false |
| hide_email | boolean | You can hide the signer's email in the signatures report. Default: false |
| lock_phone | boolean | You can lock changes to the signer's phone. Default: false |
| blank_phone | boolean | You may not ask for the signer's phone number. Default: false |
| hide_phone | boolean | You can hide the signer's phone number in the signature report. Default: false |
| lock_name | boolean | You can lock changes to the signer's name. Default: false |
| require_selfie_photo | boolean | You can ask the signer to take a selfie while signing. Default: false. |
| selfie_validation_type | string | You can ask the signer to take a photo of your personal document while signing. Default: falseIf you want to use facial recognition (liveness+document match validation) provided by Truora, please also define this field as "liveness-document-match". Default: "none". Note that this feature has an extra cost, please contact sales. |
| qualification | string | Qualification to appear in the signatures report. Ex: "Witness" value will result in "Signed as a witness". Default: "" |
| external_id | string | ID of the signer in your application. Default: "" |
| redirect_link | string | link to redirect after signer signs. For example: "https://www.seusite.com.br/agracimento". It will appear as a "CONTINUE" button below the "Download Original" and "Download Signed" buttons. Remember to insert http:// or https:// at the beginning of the link. Default: "" |
| sign_url | string | url for the signer to sign the document |
| token | string | signer token |
| status | string | signer status: "novo" = new, "abriu-link" = link-opened or "assinou" = signed |
| times_viewed | int | how many times the signer has seen the document |
| last_view_at | string | data da ultima vez que o signatário viu o documento |
| signed_at | string | date when the signer signed the document |
| geo_latitude | string | latitude from where the signer signed the document (if they allow it) |
| geo_longitude | string | longitude from where the signer signed the document (if he allows it) |
| signature_image | string | image containing the signer's signature |
| visto_image | string | image containing the signer's rubric |
| document_photo_url | string | url containing the signer's document photo |
| document_verse_photo_url | string | url containing the back of the signer's photo |
| selfie_photo_url | string | url containing the signer's selfie photo |
| selfie_photo_url2 | string | url containing the signer's selfie photo |
| send_via | string | how the document was sent to the signer: "email", "whatsapp" or null |
import docs.DocRequests;
import response.DocsResponse;
import services.JsonConverter;
public class GetDocs {
public static void main(String[] args) throws Exception {
String apiToken = "YOUR TOKEN";
try {
DocsResponse docsResponse = new DocRequests(apiToken).getDocs();
String jsonDocResponse = new JsonConverter().docsResponseToJson(docsResponse);
System.out.println(jsonDocResponse);
}
catch(Exception exceptionError) {
System.out.println(exceptionError.getMessage());
}
}
}
import body.doc.Rubrica;
import body.doc.RubricaList;
import docs.DocRequests;
import java.util.ArrayList;
public class PlaceSignatures {
public static void main(String[] args) throws Exception {
String apiToken = "YOUR TOKEN";
String docToken = "DOC TOKEN";
Rubrica rubrica1 = Rubrica.builder()
.page(0)
.relative_position_bottom(52.50)
.relative_position_left(75.71)
.relative_size_x(19.55)
.relative_size_y(9.42)
.type("signature")
.signer_token("TOKEN SIGNER")
.build();
Rubrica rubrica2 = Rubrica.builder()
.page(0)
.relative_position_bottom(13.50)
.relative_position_left(20.71)
.relative_size_x(19.55)
.relative_size_y(9.42)
.type("visto")
.signer_token("TOKEN SIGNER")
.build();
ArrayList<Rubrica> _rubricas = new ArrayList<>();
_rubricas.add(rubrica1);
_rubricas.add(rubrica2);
RubricaList rubricaList = RubricaList.builder()
.rubricas(_rubricas)
.build();
try {
int statusCode = new DocRequests(apiToken).placeSignatures(docToken, rubricaList);
System.out.println(statusCode);
}
catch(Exception exceptionError) {
System.out.println(exceptionError.getMessage());
}
}
}
document language. Possible values:
"pt-br" (Portuguese),
"es" (Spanish),
"en" (English).
Default: "pt-br"
| | disable\_signer\_emails | boolean |To disable emails sent to signers, send this parameter to true.
Default: false
| | signed\_file\_only\_finished | boolean |To disable the "Download Original" and "Download Signed" buttons from the signer experience, enable this flag. Thus, you are the one who will be in charge of delivering the signed\_file to the signer.
Default: false
| | brand\_logo | String |If you want to customize the logo of the signing experience for this specific document, submit the image URL (must be a publicly accessible link).
Default: ""
| | brand\_primary\_color | String |If you want to customize the primary (button) color of the signing experience for this specific document, send it in rgb or hexadecimal.
Ex: "#0011ee".
Default: ""
| | brand\_name | String |if you want to customize the sender name of emails sent to the signer, enter the brand name here. For example, if you entered "XPTO Advogados", the sender of the email will be "XPTO Advogados via ZapSign".
Max-length: 100 characters.
Default: ""
| | external\_id | String |ID of the document in your application.
Default: ""
| | folder\_path | String |path of the folder inside ZapSign where the document will be placed. If the folders do not exist, they will be created automatically. Requirements: (1) folder\_path can be up to 255 characters long, (2) each folder can be up to 50 characters long, (3) there is a limit of 5 folder levels.
Ex.: "/api/" or "/folder1/folder2/folder3/". Default: "/" (no folder).
| | date\_limit\_to\_sign | Date | Deadline for signing the document. (Accepted formats: YYYY-MM-DD, YYYY-MM-DDTH:m:s.ssssssZ) | | signature\_order\_active | boolean |If true, the signer's signatures will be ordered sequentially.
Default: false
| | observers | ArrayList\email of the user who will be defined as creator of the document, for internal organization purposes. If the email does not exist or is not your account user, this parameter will be ignored.
Default: ""
(document will have account owner as creator)
| # DocFromDocx Class to create documents Class inherited from the [Doc ](/english/facilitators/sdks/java-sdk/used-classes/body/doc)class. ### Properties: | name | type | description | | --------- | :----: | ------------------------------ | | url\_docx | String | docx url for document creation | # DocFromPdf Class to create documents Class inherited from the [Doc ](/english/facilitators/sdks/java-sdk/used-classes/body/doc)class. ### Properties: | name | type | description | | -------- | :----: | ----------------------------- | | url\_pdf | String | pdf url for document creation | # DocFromPdfBase64 Class to create documents Class inherited from the [Doc ](/english/facilitators/sdks/java-sdk/used-classes/body/doc)class. ### Properties: | name | type | description | | ----------- | :----: | ------------ | | base64\_pdf | String | pdf's Base64 | # DocFromTemplate Class to create documents Class inherited from the [Doc ](/english/facilitators/sdks/java-sdk/used-classes/body/doc)class. ### Properties:| name | type | description |
|---|---|---|
| signer_name | String | Signer name |
| template_id | String | Template Id |
| data | List<DeParaTemplate> | class list of variables |
| send_automatic_email | boolean | If true, ZapSign will send an email to the signer with the link to sign the document. If false (default), you will be responsible for sharing the subscription link with the signatory, whether through your website, widget, WhatsApp, SMS, email, chat etc. Note: For this to work, it is mandatory that the signer's email address is defined. |
| send_automatic_whatsapp | boolean | If true, ZapSign will send a whatsapp to the signer with the link to sign the document. If false (default), you will be responsible for sharing the subscription link with the signatory, whether through your website, widget, WhatsApp, SMS, email, chat etc. Note: For this to work, it is mandatory that the signer's cell phone is defined. |
| custom_message | String | The custom_message is the personalized message that you can insert in the email sent by ZapSign to the signer. Example: "Hello So-and-so, \n This is your employment contract. \n Hugs, Team XPTO". The \n symbol serves to "skip a line" in the email text. Default: "" |
| signer_has_incomplete_fields | boolean | If set to true, the signer will be redirected to fill out the template form before signing the document. Default: false |
If true, ZapSign will send an email to the signer with the link to sign the document. If false (default), you will be responsible for sharing the subscription link with the signatory, whether through your website, widget, WhatsApp, SMS, email, chat etc.
Note: For this to work, it is mandatory that the signer's email address is defined.
| | send\_automatic\_whatsapp | boolean |If true, ZapSign will send a whatsapp to the signer with the link to sign the document. If false (default), you will be responsible for sharing the subscription link with the signatory, whether through your website, widget, WhatsApp, SMS, email, chat etc.
Note: For this to work, it is mandatory that the signer's cell phone is defined.
| | order\_group | int | In case "signature\_order\_active" is active in the document, this field controls the signing order. Example: If the field is set to 1, then this signer will be the first to sign. If the field is set to 2, then this signer will be the second to sign and so on. | | custom\_message | String |(only relevant if send\_automatic\_email: true). The custom\_message is the personalized message that you can insert in the email sent by ZapSign to the signer.
Example: "Hello So-and-so, \n This is your employment contract. \n Hugs, Team XPTO". The \n symbol serves to "skip a line" in the email text.
Default: ""
| | phone\_country | String | You can set the phone (country code) of the signer. Default: "" (ie. US is "1") | | phone\_number | String | You can set the phone number of the signer. Example: "11998989222". Default: "" | | lock\_email | boolean |You can lock changes to the signer's email.
Default: false
| | blank\_email | boolean |You may not request the signer's email.
Default: false
| | hide\_email | boolean |You can hide the signer's email in the signatures report.
Default: false
| | lock\_phone | boolean |You can lock changes to the signer's phone.
Default: false
| | blank\_phone | boolean | You may not ask for the signer's phone number. Default: false | | hide\_phone | boolean |You can hide the signer's phone number in the signature report.
Default: false
| | lock\_name | boolean |You can lock changes to the signer's name.
Default: false
| | require\_selfie\_photo | boolean | You can ask the signer to take a selfie while signing. Default: false. | | selfie\_validation\_type | String |You can ask the signer to take a photo of your personal document while signing. Default: falseIf you want to use facial recognition (liveness+document match validation) provided by Truora, please also define this field as "liveness-document-match".
Default: "none". Note that this feature has an extra cost, please contact sales.
| | qualification | String |Qualification to appear in the signatures report.
Ex: "Witness" value will result in "Signed as a witness".
Default: ""
| | external\_id | String |ID of the signer in your application.
Default: ""
| | redirect\_link | String | link to redirect after signer signs. For example: "| name | type | description |
|---|---|---|
| open_id | int | the sequential number of this document inside your company |
| token | String | Document token |
| status | String | Document status: "em-curso", "assinado", "recusado" or "lixeira" |
| original_file | String | Url of original file saved on amazon |
| signed_file | String | Signed file url saved on amazon |
| created_through | String | Where this document was created: "web" or "api" |
| extra_docs | ArrayList<ExtraDocResponse> | Document extra documents list |
| deleted | boolean | If True, the document has been deleted |
| deleted_at | String | Date the document was deleted |
| created_at | String | Date the document was created |
| last_update_at | String | Last date the document was updated |
| template | Template | If the document was created by a model, it contains the model token |
| answers | ArrayList<Answers> | List of variables and values for creating this document |
| auto_reminder | int | Number of times this document will notify signers |
| signers | List<Signer> | represents the list of signers saved in the document |
| name | type | description |
|---|---|---|
| name | String | You can set the signer's name. |
| String | You can set the signer's email. | |
| auth_mode | String | You can choose the signer's authentication method. Possible values are: "assinaturaTela" (default) (signature on screen), "tokenEmail", "assinaturaTela-tokenEmail", "tokenSms" and "assinaturaTela-tokenSms". They correspond to the same methods available in the web interface. |
| send_automatic_email | boolean | If true, ZapSign will send an email to the signer with the link to sign the document. If false (default), you will be responsible for sharing the subscription link with the signatory, whether through your website, widget, WhatsApp, SMS, email, chat etc. Note: For this to work, it is mandatory that the signer's email address is defined. |
| send_automatic_whatsapp | boolean | If true, ZapSign will send a whatsapp to the signer with the link to sign the document. If false (default), you will be responsible for sharing the subscription link with the signatory, whether through your website, widget, WhatsApp, SMS, email, chat etc. Note: For this to work, it is mandatory that the signer's cell phone is defined. |
| order_group | int | In case "signature_order_active" is active in the document, this field controls the signing order. Example: If the field is set to 0, then this signer will be the first to sign. If the field is set to 1, then this signer will be the second to sign and so on. |
| custom_message | String | (only relevant if send_automatic_email: true). The custom_message is the personalized message that you can insert in the email sent by ZapSign to the signer. Example: "Hello So-and-so, \n This is your employment contract. \n Hugs, Team XPTO". The \n symbol serves to "skip a line" in the email text. Default: "" |
| phone_country | String | You can set the phone (country code) of the signer. Default: "" (ie. US is "1") |
| phone_number | String | You can set the phone number of the signer. Example: "11998989222". Default: "" |
| lock_email | boolean | You can lock changes to the signer's email. Default: false |
| blank_email | boolean | You may not request the signer's email. Default: false |
| hide_email | boolean | You can hide the signer's email in the signatures report. Default: false |
| lock_phone | boolean | You can lock changes to the signer's phone. Default: false |
| blank_phone | boolean | You may not ask for the signer's phone number. Default: false |
| hide_phone | boolean | You can hide the signer's phone number in the signature report. Default: false |
| lock_name | boolean | You can lock changes to the signer's name. Default: false |
| require_selfie_photo | boolean | You can ask the signer to take a selfie while signing. Default: false. |
| selfie_validation_type | String | You can ask the signer to take a photo of your personal document while signing. Default: falseIf you want to use facial recognition (liveness+document match validation) provided by Truora, please also define this field as "liveness-document-match". Default: "none". Note that this feature has an extra cost, please contact sales. |
| qualification | String | Qualification to appear in the signatures report. Ex: "Witness" value will result in "Signed as a witness". Default: "" |
| external_id | String | ID of the signer in your application. Default: "" |
| redirect_link | String | link to redirect after signer signs. For example: "https://www.seusite.com.br/agracimento". It will appear as a "CONTINUE" button below the "Download Original" and "Download Signed" buttons. Remember to insert http:// or https:// at the beginning of the link. Default: "" |
| sign_url | String | url for the signer to sign the document |
| token | String | signer token |
| status | String | signer status: "novo" = new, "abriu-link" = link-opened or "assinou" = signed |
| times_viewed | int | how many times the signer has seen the document |
| last_view_at | String | data da ultima vez que o signatário viu o documento |
| signed_at | String | date when the signer signed the document |
| geo_latitude | String | latitude from where the signer signed the document (if they allow it) |
| geo_longitude | String | longitude from where the signer signed the document (if he allows it) |
| signature_image | String | image containing the signer's signature |
| visto_image | String | image containing the signer's rubric |
| document_photo_url | String | url containing the signer's document photo |
| document_verse_photo_url | String | url containing the back of the signer's photo |
| selfie_photo_url | String | url containing the signer's selfie photo |
| selfie_photo_url2 | String | url containing the signer's selfie photo |
| send_via | String | how the document was sent to the signer: "email", "whatsapp" or null |