Referência da API

curl "https://app.odsign.com.br/api/v1/envelopes?status=sent%2Cdelivered&per_page=25" \
  -H "Authorization: Bearer $ODSIGN_TOKEN" \
  -H "Accept: application/json"

<?php
// composer require guzzlehttp/guzzle
require 'vendor/autoload.php';

$client = new GuzzleHttp\Client([
    'base_uri' => 'https://app.odsign.com.br/api/v1/',
    'headers' => [
        'Authorization' => 'Bearer '.getenv('ODSIGN_TOKEN'),
        'Accept' => 'application/json',
    ],
    'http_errors' => false, // 4xx/5xx não lançam exceção: confira o status
]);

$response = $client->get('envelopes', [
    'query' => ['status' => 'sent,delivered', 'per_page' => 25],
]);

if ($response->getStatusCode() >= 400) {
    exit('Erro '.$response->getStatusCode().': '.$response->getBody());
}
$body = json_decode((string) $response->getBody(), true);
foreach ($body['data'] as $envelope) {
    echo $envelope['id'], ' ', $envelope['status'], PHP_EOL;
}

// Node.js 18 ou mais novo (fetch e FormData nativos), como módulo ES (.mjs).

const BASE = 'https://app.odsign.com.br/api/v1';
const headers = { Authorization: `Bearer ${process.env.ODSIGN_TOKEN}`, Accept: 'application/json' };

const res = await fetch(`${BASE}/envelopes?status=sent%2Cdelivered&per_page=25`, { method: 'GET', headers });
const body = await res.json();
if (!res.ok) throw new Error(`${res.status}: ${body.message}`);
console.log(body.data ?? body.message);

# pip install requests
import os

import requests

BASE = "https://app.odsign.com.br/api/v1"
HEADERS = {"Authorization": f"Bearer {os.environ['ODSIGN_TOKEN']}", "Accept": "application/json"}

resp = requests.get(
    f"{BASE}/envelopes",
    headers=HEADERS,
    params={"status": "sent,delivered", "per_page": 25},
    timeout=60,
)
resp.raise_for_status()  # 4xx/5xx: requests.HTTPError (o corpo traz "message" e "errors")
print(resp.json()["data"])

curl -X POST "https://app.odsign.com.br/api/v1/envelopes" \
  -H "Authorization: Bearer $ODSIGN_TOKEN" \
  -H "Accept: application/json" \
  -F "subject=Contrato de prestação de serviços" \
  -F "message=Olá! Segue o contrato para assinatura." \
  -F "recipients[0][name]=Maria Souza" \
  -F "recipients[0][email]=maria@exemplo.com.br" \
  -F "recipients[0][auth_method]=email" \
  -F "send=1" \
  -F "files[]=@contrato.pdf"

<?php
// composer require guzzlehttp/guzzle
require 'vendor/autoload.php';

$client = new GuzzleHttp\Client([
    'base_uri' => 'https://app.odsign.com.br/api/v1/',
    'headers' => [
        'Authorization' => 'Bearer '.getenv('ODSIGN_TOKEN'),
        'Accept' => 'application/json',
    ],
    'http_errors' => false, // 4xx/5xx não lançam exceção: confira o status
]);

$response = $client->post('envelopes', [
    'multipart' => [
        ['name' => 'subject', 'contents' => 'Contrato de prestação de serviços'],
        ['name' => 'message', 'contents' => 'Olá! Segue o contrato para assinatura.'],
        ['name' => 'recipients[0][name]', 'contents' => 'Maria Souza'],
        ['name' => 'recipients[0][email]', 'contents' => 'maria@exemplo.com.br'],
        ['name' => 'recipients[0][auth_method]', 'contents' => 'email'],
        ['name' => 'send', 'contents' => '1'],
        ['name' => 'files[]', 'contents' => fopen('contrato.pdf', 'r'), 'filename' => 'contrato.pdf'],
    ],
]);

if ($response->getStatusCode() >= 400) {
    exit('Erro '.$response->getStatusCode().': '.$response->getBody());
}
$envelope = json_decode((string) $response->getBody(), true)['data'];
echo $envelope['id'], ' ', $envelope['status'], PHP_EOL;

// Node.js 18 ou mais novo (fetch e FormData nativos), como módulo ES (.mjs).
import { readFile } from 'node:fs/promises';

const BASE = 'https://app.odsign.com.br/api/v1';
const headers = { Authorization: `Bearer ${process.env.ODSIGN_TOKEN}`, Accept: 'application/json' };

const form = new FormData();
form.append('subject', 'Contrato de prestação de serviços');
form.append('message', 'Olá! Segue o contrato para assinatura.');
form.append('recipients[0][name]', 'Maria Souza');
form.append('recipients[0][email]', 'maria@exemplo.com.br');
form.append('recipients[0][auth_method]', 'email');
form.append('send', '1');
form.append('files[]', new Blob([await readFile('contrato.pdf')], { type: 'application/pdf' }), 'contrato.pdf');

const res = await fetch(`${BASE}/envelopes`, { method: 'POST', headers, body: form });
const body = await res.json();
if (!res.ok) throw new Error(`${res.status}: ${body.message}`);
console.log(body.data ?? body.message);

# pip install requests
import os

import requests

BASE = "https://app.odsign.com.br/api/v1"
HEADERS = {"Authorization": f"Bearer {os.environ['ODSIGN_TOKEN']}", "Accept": "application/json"}

resp = requests.post(
    f"{BASE}/envelopes",
    headers=HEADERS,
    data={
        "subject": "Contrato de prestação de serviços",
        "message": "Olá! Segue o contrato para assinatura.",
        "recipients[0][name]": "Maria Souza",
        "recipients[0][email]": "maria@exemplo.com.br",
        "recipients[0][auth_method]": "email",
        "send": "1",
    },
    files=[("files[]", ("contrato.pdf", open("contrato.pdf", "rb"), "application/pdf"))],
    timeout=60,
)
resp.raise_for_status()  # 4xx/5xx: requests.HTTPError (o corpo traz "message" e "errors")
print(resp.json()["data"])

curl "https://app.odsign.com.br/api/v1/envelopes/01a1cc92-f28f-73b8-8dcc-f15232d31a3f" \
  -H "Authorization: Bearer $ODSIGN_TOKEN" \
  -H "Accept: application/json"

<?php
// composer require guzzlehttp/guzzle
require 'vendor/autoload.php';

$client = new GuzzleHttp\Client([
    'base_uri' => 'https://app.odsign.com.br/api/v1/',
    'headers' => [
        'Authorization' => 'Bearer '.getenv('ODSIGN_TOKEN'),
        'Accept' => 'application/json',
    ],
    'http_errors' => false, // 4xx/5xx não lançam exceção: confira o status
]);

$response = $client->get('envelopes/01a1cc92-f28f-73b8-8dcc-f15232d31a3f');

if ($response->getStatusCode() >= 400) {
    exit('Erro '.$response->getStatusCode().': '.$response->getBody());
}
$envelope = json_decode((string) $response->getBody(), true)['data'];
echo $envelope['id'], ' ', $envelope['status'], PHP_EOL;

// Node.js 18 ou mais novo (fetch e FormData nativos), como módulo ES (.mjs).

const BASE = 'https://app.odsign.com.br/api/v1';
const headers = { Authorization: `Bearer ${process.env.ODSIGN_TOKEN}`, Accept: 'application/json' };

const res = await fetch(`${BASE}/envelopes/01a1cc92-f28f-73b8-8dcc-f15232d31a3f`, { method: 'GET', headers });
const body = await res.json();
if (!res.ok) throw new Error(`${res.status}: ${body.message}`);
console.log(body.data ?? body.message);

# pip install requests
import os

import requests

BASE = "https://app.odsign.com.br/api/v1"
HEADERS = {"Authorization": f"Bearer {os.environ['ODSIGN_TOKEN']}", "Accept": "application/json"}

resp = requests.get(
    f"{BASE}/envelopes/01a1cc92-f28f-73b8-8dcc-f15232d31a3f",
    headers=HEADERS,
    timeout=60,
)
resp.raise_for_status()  # 4xx/5xx: requests.HTTPError (o corpo traz "message" e "errors")
print(resp.json()["data"])

curl -X POST "https://app.odsign.com.br/api/v1/envelopes/01a1cc92-f28f-73b8-8dcc-f15232d31a3f/send" \
  -H "Authorization: Bearer $ODSIGN_TOKEN" \
  -H "Accept: application/json"

<?php
// composer require guzzlehttp/guzzle
require 'vendor/autoload.php';

$client = new GuzzleHttp\Client([
    'base_uri' => 'https://app.odsign.com.br/api/v1/',
    'headers' => [
        'Authorization' => 'Bearer '.getenv('ODSIGN_TOKEN'),
        'Accept' => 'application/json',
    ],
    'http_errors' => false, // 4xx/5xx não lançam exceção: confira o status
]);

$response = $client->post('envelopes/01a1cc92-f28f-73b8-8dcc-f15232d31a3f/send');

if ($response->getStatusCode() >= 400) {
    exit('Erro '.$response->getStatusCode().': '.$response->getBody());
}
$envelope = json_decode((string) $response->getBody(), true)['data'];
echo $envelope['id'], ' ', $envelope['status'], PHP_EOL;

// Node.js 18 ou mais novo (fetch e FormData nativos), como módulo ES (.mjs).

const BASE = 'https://app.odsign.com.br/api/v1';
const headers = { Authorization: `Bearer ${process.env.ODSIGN_TOKEN}`, Accept: 'application/json' };

const res = await fetch(`${BASE}/envelopes/01a1cc92-f28f-73b8-8dcc-f15232d31a3f/send`, { method: 'POST', headers });
const body = await res.json();
if (!res.ok) throw new Error(`${res.status}: ${body.message}`);
console.log(body.data ?? body.message);

# pip install requests
import os

import requests

BASE = "https://app.odsign.com.br/api/v1"
HEADERS = {"Authorization": f"Bearer {os.environ['ODSIGN_TOKEN']}", "Accept": "application/json"}

resp = requests.post(
    f"{BASE}/envelopes/01a1cc92-f28f-73b8-8dcc-f15232d31a3f/send",
    headers=HEADERS,
    timeout=60,
)
resp.raise_for_status()  # 4xx/5xx: requests.HTTPError (o corpo traz "message" e "errors")
print(resp.json()["data"])

curl -X POST "https://app.odsign.com.br/api/v1/envelopes/01a1cc92-f28f-73b8-8dcc-f15232d31a3f/resend" \
  -H "Authorization: Bearer $ODSIGN_TOKEN" \
  -H "Accept: application/json"

<?php
// composer require guzzlehttp/guzzle
require 'vendor/autoload.php';

$client = new GuzzleHttp\Client([
    'base_uri' => 'https://app.odsign.com.br/api/v1/',
    'headers' => [
        'Authorization' => 'Bearer '.getenv('ODSIGN_TOKEN'),
        'Accept' => 'application/json',
    ],
    'http_errors' => false, // 4xx/5xx não lançam exceção: confira o status
]);

$response = $client->post('envelopes/01a1cc92-f28f-73b8-8dcc-f15232d31a3f/resend');

if ($response->getStatusCode() >= 400) {
    exit('Erro '.$response->getStatusCode().': '.$response->getBody());
}
echo json_decode((string) $response->getBody(), true)['message'];

// Node.js 18 ou mais novo (fetch e FormData nativos), como módulo ES (.mjs).

const BASE = 'https://app.odsign.com.br/api/v1';
const headers = { Authorization: `Bearer ${process.env.ODSIGN_TOKEN}`, Accept: 'application/json' };

const res = await fetch(`${BASE}/envelopes/01a1cc92-f28f-73b8-8dcc-f15232d31a3f/resend`, { method: 'POST', headers });
const body = await res.json();
if (!res.ok) throw new Error(`${res.status}: ${body.message}`);
console.log(body.data ?? body.message);

# pip install requests
import os

import requests

BASE = "https://app.odsign.com.br/api/v1"
HEADERS = {"Authorization": f"Bearer {os.environ['ODSIGN_TOKEN']}", "Accept": "application/json"}

resp = requests.post(
    f"{BASE}/envelopes/01a1cc92-f28f-73b8-8dcc-f15232d31a3f/resend",
    headers=HEADERS,
    timeout=60,
)
resp.raise_for_status()  # 4xx/5xx: requests.HTTPError (o corpo traz "message" e "errors")
print(resp.json()["message"])

curl -X POST "https://app.odsign.com.br/api/v1/envelopes/01a1cc92-f28f-73b8-8dcc-f15232d31a3f/void" \
  -H "Authorization: Bearer $ODSIGN_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{"reason":"Valores revisados; um novo contrato será enviado."}'

<?php
// composer require guzzlehttp/guzzle
require 'vendor/autoload.php';

$client = new GuzzleHttp\Client([
    'base_uri' => 'https://app.odsign.com.br/api/v1/',
    'headers' => [
        'Authorization' => 'Bearer '.getenv('ODSIGN_TOKEN'),
        'Accept' => 'application/json',
    ],
    'http_errors' => false, // 4xx/5xx não lançam exceção: confira o status
]);

$response = $client->post('envelopes/01a1cc92-f28f-73b8-8dcc-f15232d31a3f/void', [
    'json' => ['reason' => 'Valores revisados; um novo contrato será enviado.'],
]);

if ($response->getStatusCode() >= 400) {
    exit('Erro '.$response->getStatusCode().': '.$response->getBody());
}
$envelope = json_decode((string) $response->getBody(), true)['data'];
echo $envelope['id'], ' ', $envelope['status'], PHP_EOL;

// Node.js 18 ou mais novo (fetch e FormData nativos), como módulo ES (.mjs).

const BASE = 'https://app.odsign.com.br/api/v1';
const headers = { Authorization: `Bearer ${process.env.ODSIGN_TOKEN}`, Accept: 'application/json' };

const res = await fetch(`${BASE}/envelopes/01a1cc92-f28f-73b8-8dcc-f15232d31a3f/void`, { method: 'POST', headers: { ...headers, 'Content-Type': 'application/json' }, body: JSON.stringify({"reason":"Valores revisados; um novo contrato será enviado."}) });
const body = await res.json();
if (!res.ok) throw new Error(`${res.status}: ${body.message}`);
console.log(body.data ?? body.message);

# pip install requests
import os

import requests

BASE = "https://app.odsign.com.br/api/v1"
HEADERS = {"Authorization": f"Bearer {os.environ['ODSIGN_TOKEN']}", "Accept": "application/json"}

resp = requests.post(
    f"{BASE}/envelopes/01a1cc92-f28f-73b8-8dcc-f15232d31a3f/void",
    headers=HEADERS,
    json={"reason": "Valores revisados; um novo contrato será enviado."},
    timeout=60,
)
resp.raise_for_status()  # 4xx/5xx: requests.HTTPError (o corpo traz "message" e "errors")
print(resp.json()["data"])

curl "https://app.odsign.com.br/api/v1/envelopes/01a1cc92-f28f-73b8-8dcc-f15232d31a3f/audit-events" \
  -H "Authorization: Bearer $ODSIGN_TOKEN" \
  -H "Accept: application/json"

<?php
// composer require guzzlehttp/guzzle
require 'vendor/autoload.php';

$client = new GuzzleHttp\Client([
    'base_uri' => 'https://app.odsign.com.br/api/v1/',
    'headers' => [
        'Authorization' => 'Bearer '.getenv('ODSIGN_TOKEN'),
        'Accept' => 'application/json',
    ],
    'http_errors' => false, // 4xx/5xx não lançam exceção: confira o status
]);

$response = $client->get('envelopes/01a1cc92-f28f-73b8-8dcc-f15232d31a3f/audit-events');

if ($response->getStatusCode() >= 400) {
    exit('Erro '.$response->getStatusCode().': '.$response->getBody());
}
$envelope = json_decode((string) $response->getBody(), true)['data'];
echo $envelope['id'], ' ', $envelope['status'], PHP_EOL;

// Node.js 18 ou mais novo (fetch e FormData nativos), como módulo ES (.mjs).

const BASE = 'https://app.odsign.com.br/api/v1';
const headers = { Authorization: `Bearer ${process.env.ODSIGN_TOKEN}`, Accept: 'application/json' };

const res = await fetch(`${BASE}/envelopes/01a1cc92-f28f-73b8-8dcc-f15232d31a3f/audit-events`, { method: 'GET', headers });
const body = await res.json();
if (!res.ok) throw new Error(`${res.status}: ${body.message}`);
console.log(body.data ?? body.message);

# pip install requests
import os

import requests

BASE = "https://app.odsign.com.br/api/v1"
HEADERS = {"Authorization": f"Bearer {os.environ['ODSIGN_TOKEN']}", "Accept": "application/json"}

resp = requests.get(
    f"{BASE}/envelopes/01a1cc92-f28f-73b8-8dcc-f15232d31a3f/audit-events",
    headers=HEADERS,
    timeout=60,
)
resp.raise_for_status()  # 4xx/5xx: requests.HTTPError (o corpo traz "message" e "errors")
print(resp.json()["data"])

curl "https://app.odsign.com.br/api/v1/envelopes/01a1cc92-f28f-73b8-8dcc-f15232d31a3f/documents/signed" \
  -H "Authorization: Bearer $ODSIGN_TOKEN" \
  -o contrato-assinado.pdf

<?php
// composer require guzzlehttp/guzzle
require 'vendor/autoload.php';

$client = new GuzzleHttp\Client([
    'base_uri' => 'https://app.odsign.com.br/api/v1/',
    'headers' => [
        'Authorization' => 'Bearer '.getenv('ODSIGN_TOKEN'),
        'Accept' => 'application/json',
    ],
    'http_errors' => false, // 4xx/5xx não lançam exceção: confira o status
]);

$response = $client->get('envelopes/01a1cc92-f28f-73b8-8dcc-f15232d31a3f/documents/signed', [
    'sink' => 'contrato-assinado.pdf', // grava o arquivo direto no disco
]);

if ($response->getStatusCode() >= 400) {
    exit('Erro '.$response->getStatusCode().': '.$response->getBody());
}
// Content-Disposition traz o nome original do arquivo.
echo $response->getHeaderLine('Content-Disposition');

// Node.js 18 ou mais novo (fetch e FormData nativos), como módulo ES (.mjs).
import { writeFile } from 'node:fs/promises';

const BASE = 'https://app.odsign.com.br/api/v1';
const headers = { Authorization: `Bearer ${process.env.ODSIGN_TOKEN}`, Accept: 'application/json' };

const res = await fetch(`${BASE}/envelopes/01a1cc92-f28f-73b8-8dcc-f15232d31a3f/documents/signed`, { method: 'GET', headers });
if (!res.ok) throw new Error(`${res.status}: ${(await res.json()).message}`);
await writeFile('contrato-assinado.pdf', Buffer.from(await res.arrayBuffer()));

# pip install requests
import os

import requests

BASE = "https://app.odsign.com.br/api/v1"
HEADERS = {"Authorization": f"Bearer {os.environ['ODSIGN_TOKEN']}", "Accept": "application/json"}

resp = requests.get(
    f"{BASE}/envelopes/01a1cc92-f28f-73b8-8dcc-f15232d31a3f/documents/signed",
    headers=HEADERS,
    timeout=60,
)
resp.raise_for_status()  # 4xx/5xx: requests.HTTPError (o corpo traz "message" e "errors")
with open("contrato-assinado.pdf", "wb") as f:
    f.write(resp.content)