Buscar assinatura

curl --request GET \
  --url https://api.juridiq.com.br/signature/{id} \
  --header 'x-juridiq-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-juridiq-api-key': '<api-key>'}};

fetch('https://api.juridiq.com.br/signature/{id}', 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/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "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"
	"net/http"
	"io"
)

func main() {

	url := "https://api.juridiq.com.br/signature/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-juridiq-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.juridiq.com.br/signature/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-juridiq-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "documentName": "<string>",
  "documentKey": "<string>",
  "status": "<string>",
  "updatedAt": "2023-11-07T05:31:56Z",
  "createdAt": "2023-11-07T05:31:56Z",
  "signName": "<string>",
  "signingKey": "<string>",
  "signatories": [
    {
      "contact": "<string>",
      "contactType": "whatsapp",
      "signed": true,
      "hasLinkedPerson": true,
      "linkedPersonId": "<string>",
      "linkedPersonName": "<string>",
      "linkedPersonImageUrl": "<string>",
      "signingKey": "<string>",
      "url": "<string>"
    }
  ],
  "responsibleId": "<string>",
  "responsible": {
    "id": "<string>",
    "name": "<string>",
    "imageUrl": "<string>"
  },
  "isPrivate": true,
  "autoSendLink": true,
  "personOnSignatures": "<unknown>",
  "history": "<unknown>",
  "plugsignUnavailable": true
}

{
  "message": "<string>",
  "statusCode": 123,
  "translateMessage": "<string>"
}

GET

signature

{id}

Buscar assinatura

curl --request GET \
  --url https://api.juridiq.com.br/signature/{id} \
  --header 'x-juridiq-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-juridiq-api-key': '<api-key>'}};

fetch('https://api.juridiq.com.br/signature/{id}', 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/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "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"
	"net/http"
	"io"
)

func main() {

	url := "https://api.juridiq.com.br/signature/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-juridiq-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.juridiq.com.br/signature/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-juridiq-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "documentName": "<string>",
  "documentKey": "<string>",
  "status": "<string>",
  "updatedAt": "2023-11-07T05:31:56Z",
  "createdAt": "2023-11-07T05:31:56Z",
  "signName": "<string>",
  "signingKey": "<string>",
  "signatories": [
    {
      "contact": "<string>",
      "contactType": "whatsapp",
      "signed": true,
      "hasLinkedPerson": true,
      "linkedPersonId": "<string>",
      "linkedPersonName": "<string>",
      "linkedPersonImageUrl": "<string>",
      "signingKey": "<string>",
      "url": "<string>"
    }
  ],
  "responsibleId": "<string>",
  "responsible": {
    "id": "<string>",
    "name": "<string>",
    "imageUrl": "<string>"
  },
  "isPrivate": true,
  "autoSendLink": true,
  "personOnSignatures": "<unknown>",
  "history": "<unknown>",
  "plugsignUnavailable": true
}

{
  "message": "<string>",
  "statusCode": 123,
  "translateMessage": "<string>"
}

Authorizations

x-juridiq-api-key

string

header

required

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).

Path Parameters

string<uuid>

required

ID da assinatura

Response

Default Response

string<uuid>

required

ID da assinatura

documentName

string

required

Nome do documento

documentKey

string

required

Chave do documento no PlugSign

status

string

required

Status. Ex: pending, signed, cancelled

updatedAt

required

Atualizado em

createdAt

required

Criado em

signName

string | null

Nome exibido da assinatura

signingKey

string | null

Chave de assinatura

signatories

object[]

Signatários com status e link

Show child attributes

responsibleId

string | null

ID do responsável

responsible

object | null

Show child attributes

isPrivate

boolean | null

Documento privado

autoSendLink

boolean

Envio automático do link de assinatura aos signatários

personOnSignatures

any

Pessoas vinculadas

history

any

Histórico do PlugSign

plugsignUnavailable

boolean

true quando o detalhe veio só do banco (PlugSign falhou ou em skip)

Primeiros Passos

API Reference

Buscar assinatura

Authorizations

Path Parameters

Response