PHPackages                             clicksign/clicksign-php - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. clicksign/clicksign-php

AbandonedArchivedLibrary[API Development](/categories/api)

clicksign/clicksign-php
=======================

PHP client to consume Clicksign JSON API

v1.0.0(10y ago)873.0k↓42.3%10MITPHPPHP >=5.4

Since Sep 14Pushed 5y ago56 watchersCompare

[ Source](https://github.com/clicksign/clicksign-php)[ Packagist](https://packagist.org/packages/clicksign/clicksign-php)[ Docs](http://github.com/clicksign/clicksign-php)[ RSS](/packages/clicksign-clicksign-php/feed)WikiDiscussions main Synced 1mo ago

READMEChangelogDependencies (1)Versions (5)Used By (0)

Clicksign PHP Client
====================

[](#clicksign-php-client)

This is the PHP wrapper for [Clicksign REST API](http://clicksign.readme.io).

How to use
----------

[](#how-to-use)

### Installing with composer

[](#installing-with-composer)

Create a file named **composer.json** with the content below:

```
{
    "require": {
        "clicksign/clicksign-php": "*"
    }
}
```

Then, create a file like [example/sample1.php](example/sample1.php) to load the library:

### Installing without composer

[](#installing-without-composer)

Download the code at

Extract the code to a folder

Then, create a file like [example/sample1.php](example/sample1.php) to load the library:

A more complete example can be found in [example/sample2.php](example/sample2.php)

Documents Services
------------------

[](#documents-services)

### List all documents:

[](#list-all-documents)

```
$docs = $client->documents->all();

foreach ($docs as $d)
{
    print $d->document->key;
}
```

### Upload a document:

[](#upload-a-document)

Upload only the file:

```
$client->documents->upload("/Users/clicksign/Documents/Filename.pdf");
```

It also accepts an `$options` array:

```
$signers = array(array("email" => "jose.silva@example.com", "act" => "sign"), array("email" => "joao.souza@example.org", "act" => "witness"));
$message = "Please sign this document.";
$skipEmail = false;

$options = array("signers" => $signers, "message" => $message, "skipEmail" => $skipEmail);

$client->documents->upload("/Users/clicksign/Documents/Filename.pdf", $options);
```

This call will upload the file and create the signature list along with the message. If `$options` array is passed, *signers* array inside of it is mandatory.

**Attention**: You must enforce use of UTF-8 or you may get server-side errors when you try to send anything but regular ASCII.

### Retrieve a document:

[](#retrieve-a-document)

```
$doc = $client->documents->find("DOCUMENT_KEY");

print $doc->document->original_name;
```

### Download a document:

[](#download-a-document)

```
$file = $client->documents->download("DOCUMENT_KEY");
```

### Create a signature list:

[](#create-a-signature-list)

```
$signers[0]["email"] = "jose.silva@example.com";
$signers[0]["act"] = "sign";

$signers[1]["email"] = "joao.souza@example.org";
$signers[1]["act"] = "witness";

$client->documents->createList("DOCUMENT_KEY", $signers);
```

Or:

```
$signers = array(array("email" => "jose.silva@example.com", "act" => "sign"), array("email" => "joao.souza@example.org", "act" => "witness"));
$client->documents->createList("DOCUMENT_KEY", $signers);
```

You may pass `message` and `skip_email` parameters:

```
$client->documents->createList("DOCUMENT_KEY", $signers, "Hi guys, please sign this document.", false);
```

**Attention**: You must enforce use of UTF-8 or you may get server-side errors when you try to send anything but regular ASCII.

### Resend a document:

[](#resend-a-document)

```
$email = "jose.silva@example.com";
$message = "This is a reminder. Please sign the document";
$client->documents->resend("DOCUMENT_KEY", $email, $message);
```

### Cancel document:

[](#cancel-document)

```
$client->documents->cancel("DOCUMENT_KEY");
```

Hooks Services
--------------

[](#hooks-services)

### Create a hook:

[](#create-a-hook)

```
$hook = $client->hooks->create("DOCUMENT_KEY", "http://example.com/clicksign/callback.php");
```

### List all document's hooks:

[](#list-all-documents-hooks)

```
$hooks = $client->hooks->all("DOCUMENT_KEY");
```

### Delete a hook:

[](#delete-a-hook)

```
$client->hooks->delete("DOCUMENT_KEY", 2163);
```

Batches Services
----------------

[](#batches-services)

### Create a batch:

[](#create-a-batch)

```
$documentKeys = array("DOCUMENT_KEY_1", "DOCUMENT_KEY_2", "DOCUMENT_KEY_3");
$batch = $client->batches->create($documentKeys);
```

### List all batches:

[](#list-all-batches)

```
$batches = $client->batches->all();
```

### Delete a batch:

[](#delete-a-batch)

```
$client->batches->delete("DOCUMENT_BATCH_KEY");
```

Dev notes
---------

[](#dev-notes)

To "vendor" compose packages, run the command `composer install --no-dev --no-scripts` (based on instructions in )

###  Health Score

38

—

LowBetter than 85% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity37

Limited adoption so far

Community25

Small or concentrated contributor base

Maturity61

Established project with proven stability

 Bus Factor2

2 contributors hold 50%+ of commits

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Unknown

Total

1

Last Release

3899d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/77fe6270e17fefed67c5733dac92eac928e741d95b33bf7ef6d55988624a3a62?d=identicon)[mauriciovieira](/maintainers/mauriciovieira)

![](https://www.gravatar.com/avatar/652c16fce6d60eb06fb8c7472a21ef2f4899c1de25c5bd7a5183b669c7b942a3?d=identicon)[dlibanori](/maintainers/dlibanori)

---

Top Contributors

[![vitorfs](https://avatars.githubusercontent.com/u/1429529?v=4)](https://github.com/vitorfs "vitorfs (24 commits)")[![mauriciovieira](https://avatars.githubusercontent.com/u/95258?v=4)](https://github.com/mauriciovieira "mauriciovieira (19 commits)")[![locawebemailmarketing](https://avatars.githubusercontent.com/u/96137?v=4)](https://github.com/locawebemailmarketing "locawebemailmarketing (4 commits)")[![dlibanori](https://avatars.githubusercontent.com/u/27499?v=4)](https://github.com/dlibanori "dlibanori (3 commits)")[![mbbernstein](https://avatars.githubusercontent.com/u/1004975?v=4)](https://github.com/mbbernstein "mbbernstein (2 commits)")[![hugosbg](https://avatars.githubusercontent.com/u/14058763?v=4)](https://github.com/hugosbg "hugosbg (1 commits)")[![rfcarrara](https://avatars.githubusercontent.com/u/13314591?v=4)](https://github.com/rfcarrara "rfcarrara (1 commits)")[![fagnerpereira](https://avatars.githubusercontent.com/u/4353880?v=4)](https://github.com/fagnerpereira "fagnerpereira (1 commits)")

---

Tags

rest-clientclicksign

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/clicksign-clicksign-php/health.svg)

```
[![Health](https://phpackages.com/badges/clicksign-clicksign-php/health.svg)](https://phpackages.com/packages/clicksign-clicksign-php)
```

###  Alternatives

[twilio/sdk

A PHP wrapper for Twilio's API

1.6k92.9M272](/packages/twilio-sdk)[facebook/php-business-sdk

PHP SDK for Facebook Business

90821.9M34](/packages/facebook-php-business-sdk)[google/common-protos

Google API Common Protos for PHP

173103.7M50](/packages/google-common-protos)[deepseek-php/deepseek-php-client

deepseek PHP client is a robust and community-driven PHP client library for seamless integration with the Deepseek API, offering efficient access to advanced AI and data processing capabilities.

47073.9k5](/packages/deepseek-php-deepseek-php-client)[hubspot/api-client

Hubspot API client

23914.2M16](/packages/hubspot-api-client)[botman/driver-telegram

Telegram driver for BotMan

92437.3k6](/packages/botman-driver-telegram)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)