Enviar documento para assinatura com o PDF em JSON (base64)
curl --request POST \
--url https://api.juridiq.com.br/signature/json \
--header 'Content-Type: application/json' \
--header 'x-juridiq-api-key: <api-key>' \
--data '
{
"file": {
"name": "<string>",
"content_base64": "<string>"
},
"signatories": [
"<string>"
],
"people": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"value": "<string>",
"type": "<string>",
"request_selfie": true,
"request_document": true
}
],
"signatory_options": [
{
"value": "<string>",
"request_selfie": true,
"request_document": true
}
],
"subject": "<string>",
"message": "<string>",
"expire_date": "<string>",
"request_selfie": true,
"request_document": true,
"request_rubric": true,
"due_months": 1,
"has_chain": true,
"isPrivate": true,
"fields": [
{
"signer": "<string>",
"page": 123,
"type": "<string>",
"width": 123,
"height": 123,
"xPos": 123,
"yPos": 123
}
],
"width_page": 123,
"signName": "<string>"
}
'import requests
url = "https://api.juridiq.com.br/signature/json"
payload = {
"file": {
"name": "<string>",
"content_base64": "<string>"
},
"signatories": ["<string>"],
"people": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"value": "<string>",
"type": "<string>",
"request_selfie": True,
"request_document": True
}
],
"signatory_options": [
{
"value": "<string>",
"request_selfie": True,
"request_document": True
}
],
"subject": "<string>",
"message": "<string>",
"expire_date": "<string>",
"request_selfie": True,
"request_document": True,
"request_rubric": True,
"due_months": 1,
"has_chain": True,
"isPrivate": True,
"fields": [
{
"signer": "<string>",
"page": 123,
"type": "<string>",
"width": 123,
"height": 123,
"xPos": 123,
"yPos": 123
}
],
"width_page": 123,
"signName": "<string>"
}
headers = {
"x-juridiq-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-juridiq-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
file: {name: '<string>', content_base64: '<string>'},
signatories: ['<string>'],
people: [
{
id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
value: '<string>',
type: '<string>',
request_selfie: true,
request_document: true
}
],
signatory_options: [{value: '<string>', request_selfie: true, request_document: true}],
subject: '<string>',
message: '<string>',
expire_date: '<string>',
request_selfie: true,
request_document: true,
request_rubric: true,
due_months: 1,
has_chain: true,
isPrivate: true,
fields: [
{
signer: '<string>',
page: 123,
type: '<string>',
width: 123,
height: 123,
xPos: 123,
yPos: 123
}
],
width_page: 123,
signName: '<string>'
})
};
fetch('https://api.juridiq.com.br/signature/json', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.juridiq.com.br/signature/json",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'file' => [
'name' => '<string>',
'content_base64' => '<string>'
],
'signatories' => [
'<string>'
],
'people' => [
[
'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'value' => '<string>',
'type' => '<string>',
'request_selfie' => true,
'request_document' => true
]
],
'signatory_options' => [
[
'value' => '<string>',
'request_selfie' => true,
'request_document' => true
]
],
'subject' => '<string>',
'message' => '<string>',
'expire_date' => '<string>',
'request_selfie' => true,
'request_document' => true,
'request_rubric' => true,
'due_months' => 1,
'has_chain' => true,
'isPrivate' => true,
'fields' => [
[
'signer' => '<string>',
'page' => 123,
'type' => '<string>',
'width' => 123,
'height' => 123,
'xPos' => 123,
'yPos' => 123
]
],
'width_page' => 123,
'signName' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-juridiq-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.juridiq.com.br/signature/json"
payload := strings.NewReader("{\n \"file\": {\n \"name\": \"<string>\",\n \"content_base64\": \"<string>\"\n },\n \"signatories\": [\n \"<string>\"\n ],\n \"people\": [\n {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"value\": \"<string>\",\n \"type\": \"<string>\",\n \"request_selfie\": true,\n \"request_document\": true\n }\n ],\n \"signatory_options\": [\n {\n \"value\": \"<string>\",\n \"request_selfie\": true,\n \"request_document\": true\n }\n ],\n \"subject\": \"<string>\",\n \"message\": \"<string>\",\n \"expire_date\": \"<string>\",\n \"request_selfie\": true,\n \"request_document\": true,\n \"request_rubric\": true,\n \"due_months\": 1,\n \"has_chain\": true,\n \"isPrivate\": true,\n \"fields\": [\n {\n \"signer\": \"<string>\",\n \"page\": 123,\n \"type\": \"<string>\",\n \"width\": 123,\n \"height\": 123,\n \"xPos\": 123,\n \"yPos\": 123\n }\n ],\n \"width_page\": 123,\n \"signName\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-juridiq-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.juridiq.com.br/signature/json")
.header("x-juridiq-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"file\": {\n \"name\": \"<string>\",\n \"content_base64\": \"<string>\"\n },\n \"signatories\": [\n \"<string>\"\n ],\n \"people\": [\n {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"value\": \"<string>\",\n \"type\": \"<string>\",\n \"request_selfie\": true,\n \"request_document\": true\n }\n ],\n \"signatory_options\": [\n {\n \"value\": \"<string>\",\n \"request_selfie\": true,\n \"request_document\": true\n }\n ],\n \"subject\": \"<string>\",\n \"message\": \"<string>\",\n \"expire_date\": \"<string>\",\n \"request_selfie\": true,\n \"request_document\": true,\n \"request_rubric\": true,\n \"due_months\": 1,\n \"has_chain\": true,\n \"isPrivate\": true,\n \"fields\": [\n {\n \"signer\": \"<string>\",\n \"page\": 123,\n \"type\": \"<string>\",\n \"width\": 123,\n \"height\": 123,\n \"xPos\": 123,\n \"yPos\": 123\n }\n ],\n \"width_page\": 123,\n \"signName\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.juridiq.com.br/signature/json")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-juridiq-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"file\": {\n \"name\": \"<string>\",\n \"content_base64\": \"<string>\"\n },\n \"signatories\": [\n \"<string>\"\n ],\n \"people\": [\n {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"value\": \"<string>\",\n \"type\": \"<string>\",\n \"request_selfie\": true,\n \"request_document\": true\n }\n ],\n \"signatory_options\": [\n {\n \"value\": \"<string>\",\n \"request_selfie\": true,\n \"request_document\": true\n }\n ],\n \"subject\": \"<string>\",\n \"message\": \"<string>\",\n \"expire_date\": \"<string>\",\n \"request_selfie\": true,\n \"request_document\": true,\n \"request_rubric\": true,\n \"due_months\": 1,\n \"has_chain\": true,\n \"isPrivate\": true,\n \"fields\": [\n {\n \"signer\": \"<string>\",\n \"page\": 123,\n \"type\": \"<string>\",\n \"width\": 123,\n \"height\": 123,\n \"xPos\": 123,\n \"yPos\": 123\n }\n ],\n \"width_page\": 123,\n \"signName\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body"<unknown>"{
"message": "<string>",
"statusCode": 123,
"translateMessage": "<string>"
}{
"message": "<string>",
"statusCode": 123,
"translateMessage": "<string>"
}{
"message": "<string>",
"statusCode": 123,
"translateMessage": "<string>"
}Signatures
Enviar documento para assinatura com o PDF em JSON (base64)
POST
/
signature
/
json
Enviar documento para assinatura com o PDF em JSON (base64)
curl --request POST \
--url https://api.juridiq.com.br/signature/json \
--header 'Content-Type: application/json' \
--header 'x-juridiq-api-key: <api-key>' \
--data '
{
"file": {
"name": "<string>",
"content_base64": "<string>"
},
"signatories": [
"<string>"
],
"people": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"value": "<string>",
"type": "<string>",
"request_selfie": true,
"request_document": true
}
],
"signatory_options": [
{
"value": "<string>",
"request_selfie": true,
"request_document": true
}
],
"subject": "<string>",
"message": "<string>",
"expire_date": "<string>",
"request_selfie": true,
"request_document": true,
"request_rubric": true,
"due_months": 1,
"has_chain": true,
"isPrivate": true,
"fields": [
{
"signer": "<string>",
"page": 123,
"type": "<string>",
"width": 123,
"height": 123,
"xPos": 123,
"yPos": 123
}
],
"width_page": 123,
"signName": "<string>"
}
'import requests
url = "https://api.juridiq.com.br/signature/json"
payload = {
"file": {
"name": "<string>",
"content_base64": "<string>"
},
"signatories": ["<string>"],
"people": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"value": "<string>",
"type": "<string>",
"request_selfie": True,
"request_document": True
}
],
"signatory_options": [
{
"value": "<string>",
"request_selfie": True,
"request_document": True
}
],
"subject": "<string>",
"message": "<string>",
"expire_date": "<string>",
"request_selfie": True,
"request_document": True,
"request_rubric": True,
"due_months": 1,
"has_chain": True,
"isPrivate": True,
"fields": [
{
"signer": "<string>",
"page": 123,
"type": "<string>",
"width": 123,
"height": 123,
"xPos": 123,
"yPos": 123
}
],
"width_page": 123,
"signName": "<string>"
}
headers = {
"x-juridiq-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-juridiq-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
file: {name: '<string>', content_base64: '<string>'},
signatories: ['<string>'],
people: [
{
id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
value: '<string>',
type: '<string>',
request_selfie: true,
request_document: true
}
],
signatory_options: [{value: '<string>', request_selfie: true, request_document: true}],
subject: '<string>',
message: '<string>',
expire_date: '<string>',
request_selfie: true,
request_document: true,
request_rubric: true,
due_months: 1,
has_chain: true,
isPrivate: true,
fields: [
{
signer: '<string>',
page: 123,
type: '<string>',
width: 123,
height: 123,
xPos: 123,
yPos: 123
}
],
width_page: 123,
signName: '<string>'
})
};
fetch('https://api.juridiq.com.br/signature/json', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.juridiq.com.br/signature/json",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'file' => [
'name' => '<string>',
'content_base64' => '<string>'
],
'signatories' => [
'<string>'
],
'people' => [
[
'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'value' => '<string>',
'type' => '<string>',
'request_selfie' => true,
'request_document' => true
]
],
'signatory_options' => [
[
'value' => '<string>',
'request_selfie' => true,
'request_document' => true
]
],
'subject' => '<string>',
'message' => '<string>',
'expire_date' => '<string>',
'request_selfie' => true,
'request_document' => true,
'request_rubric' => true,
'due_months' => 1,
'has_chain' => true,
'isPrivate' => true,
'fields' => [
[
'signer' => '<string>',
'page' => 123,
'type' => '<string>',
'width' => 123,
'height' => 123,
'xPos' => 123,
'yPos' => 123
]
],
'width_page' => 123,
'signName' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-juridiq-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.juridiq.com.br/signature/json"
payload := strings.NewReader("{\n \"file\": {\n \"name\": \"<string>\",\n \"content_base64\": \"<string>\"\n },\n \"signatories\": [\n \"<string>\"\n ],\n \"people\": [\n {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"value\": \"<string>\",\n \"type\": \"<string>\",\n \"request_selfie\": true,\n \"request_document\": true\n }\n ],\n \"signatory_options\": [\n {\n \"value\": \"<string>\",\n \"request_selfie\": true,\n \"request_document\": true\n }\n ],\n \"subject\": \"<string>\",\n \"message\": \"<string>\",\n \"expire_date\": \"<string>\",\n \"request_selfie\": true,\n \"request_document\": true,\n \"request_rubric\": true,\n \"due_months\": 1,\n \"has_chain\": true,\n \"isPrivate\": true,\n \"fields\": [\n {\n \"signer\": \"<string>\",\n \"page\": 123,\n \"type\": \"<string>\",\n \"width\": 123,\n \"height\": 123,\n \"xPos\": 123,\n \"yPos\": 123\n }\n ],\n \"width_page\": 123,\n \"signName\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-juridiq-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.juridiq.com.br/signature/json")
.header("x-juridiq-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"file\": {\n \"name\": \"<string>\",\n \"content_base64\": \"<string>\"\n },\n \"signatories\": [\n \"<string>\"\n ],\n \"people\": [\n {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"value\": \"<string>\",\n \"type\": \"<string>\",\n \"request_selfie\": true,\n \"request_document\": true\n }\n ],\n \"signatory_options\": [\n {\n \"value\": \"<string>\",\n \"request_selfie\": true,\n \"request_document\": true\n }\n ],\n \"subject\": \"<string>\",\n \"message\": \"<string>\",\n \"expire_date\": \"<string>\",\n \"request_selfie\": true,\n \"request_document\": true,\n \"request_rubric\": true,\n \"due_months\": 1,\n \"has_chain\": true,\n \"isPrivate\": true,\n \"fields\": [\n {\n \"signer\": \"<string>\",\n \"page\": 123,\n \"type\": \"<string>\",\n \"width\": 123,\n \"height\": 123,\n \"xPos\": 123,\n \"yPos\": 123\n }\n ],\n \"width_page\": 123,\n \"signName\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.juridiq.com.br/signature/json")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-juridiq-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"file\": {\n \"name\": \"<string>\",\n \"content_base64\": \"<string>\"\n },\n \"signatories\": [\n \"<string>\"\n ],\n \"people\": [\n {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"value\": \"<string>\",\n \"type\": \"<string>\",\n \"request_selfie\": true,\n \"request_document\": true\n }\n ],\n \"signatory_options\": [\n {\n \"value\": \"<string>\",\n \"request_selfie\": true,\n \"request_document\": true\n }\n ],\n \"subject\": \"<string>\",\n \"message\": \"<string>\",\n \"expire_date\": \"<string>\",\n \"request_selfie\": true,\n \"request_document\": true,\n \"request_rubric\": true,\n \"due_months\": 1,\n \"has_chain\": true,\n \"isPrivate\": true,\n \"fields\": [\n {\n \"signer\": \"<string>\",\n \"page\": 123,\n \"type\": \"<string>\",\n \"width\": 123,\n \"height\": 123,\n \"xPos\": 123,\n \"yPos\": 123\n }\n ],\n \"width_page\": 123,\n \"signName\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body"<unknown>"{
"message": "<string>",
"statusCode": 123,
"translateMessage": "<string>"
}{
"message": "<string>",
"statusCode": 123,
"translateMessage": "<string>"
}{
"message": "<string>",
"statusCode": 123,
"translateMessage": "<string>"
}Authorizations
Chave de API do escritório (criada no painel). Envie o valor no header x-juridiq-api-key. A API aberta aplica rate limit por chave (veja a documentação de integradores).
Body
application/json
Documento PDF em base64
Show child attributes
Show child attributes
E-mails ou telefones dos signatários
Minimum string length:
1Pattern:
^[^,]+$Pessoas cadastradas que assinam; ficam vinculadas à assinatura
Show child attributes
Show child attributes
Overrides de selfie e documento por signatário livre
Show child attributes
Show child attributes
Assunto do envio
Mensagem enviada aos signatários
Data de expiração do pedido de assinatura, no formato AAAA-MM-DD
Pattern:
^\d{4}-\d{2}-\d{2}$Solicitar selfie do signatário. Padrão: false
Solicitar documento com foto. Padrão: false
Assinatura desenhada. Padrão: false (assinatura por texto)
Meses de validade do documento assinado
Required range:
x >= 0Assinatura em cadeia. Padrão: false
Documento privado no escritório. Padrão: false
Posições dos campos de assinatura por signatário
Show child attributes
Show child attributes
Largura da página em pixels. Padrão: 596
Nome exibido do documento. Padrão: nome do arquivo
Minimum string length:
1Response
Resposta do PlugSign
Resposta do PlugSign