PHPackages                             signaturit/signaturit-sdk - 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. signaturit/signaturit-sdk

ActiveLibrary[API Development](/categories/api)

signaturit/signaturit-sdk
=========================

Signaturit PHP SDK

1.2.0(4y ago)6273.4k↓16.4%6[5 PRs](https://github.com/signaturit/php-sdk/pulls)MITPHPPHP ^7.2|^8.0

Since Sep 4Pushed 3y ago25 watchersCompare

[ Source](https://github.com/signaturit/php-sdk)[ Packagist](https://packagist.org/packages/signaturit/signaturit-sdk)[ RSS](/packages/signaturit-signaturit-sdk/feed)WikiDiscussions master Synced 1mo ago

READMEChangelogDependencies (2)Versions (11)Used By (0)

` ⚠️ DO NOT USE MASTER BRANCH ⚠️`

Signaturit PHP SDK
==================

[](#signaturit-php-sdk)

[![Quality Gate Status](https://camo.githubusercontent.com/5f4ebc2d779a3de7213f9a556d1dbf39650ec49a9a44b928de3b9e7da4f50ba9/68747470733a2f2f736f6e6172636c6f75642e696f2f6170692f70726f6a6563745f6261646765732f6d6561737572653f70726f6a6563743d7369676e6174757269745f7068702d73646b266d65747269633d616c6572745f73746174757326746f6b656e3d34363331656464386161653633333630633334616437643366616338313330623138636130636634)](https://sonarcloud.io/dashboard?id=signaturit_php-sdk)

This package is a PHP wrapper around the Signaturit API. If you didn't read the documentation yet you can take a look [here](https://docs.signaturit.com/).

You'll need at least PHP `^7.2` or `^8.0` to use this package ().

Configuration
-------------

[](#configuration)

The recommended way to install the SDK is through [Composer](https://getcomposer.org/).

```
composer require signaturit/signaturit-sdk
```

Then import Composer's autoload.php file from your script and instantiate the Client class passing in your API access token.

```
require_once __DIR__.'/vendor/autoload.php';

$accessToken = 'OTllYjUwM2NhYmNjNmJlYTZlNWEzNWYzYmZjNTRiZWI2YjU0ZjUxNzUwZDRjZjEwZTA0ZTFkZWQwZGExNDM3ZQ';

$client = new Signaturit\Client($accessToken);
```

Please note that by default the client will use our sandbox API. When you are ready to start using the production environment just get the correct access token and pass an additional argument to the constructor:

```
$client = new Signaturit\Client($accessToken, true);
```

Examples
--------

[](#examples)

Signatures
----------

[](#signatures)

### Count signature requests

[](#count-signature-requests)

Count your signature requests.

```
$response = $client->countSignatures();
```

### Get all signature requests

[](#get-all-signature-requests)

Retrieve all data from your signature requests using different filters.

##### All signatures

[](#all-signatures)

```
$response = $client->getSignatures();
```

##### Getting the last 50 signatures

[](#getting-the-last-50-signatures)

```
$response = $client->getSignatures(50);
```

##### Getting signatures with custom field "crm\_id"

[](#getting-signatures-with-custom-field-crm_id)

```
$response = $client->getSignatures(100, 0, ['crm_id' => 'CUSTOM_ID'])
```

### Get signature request

[](#get-signature-request)

Get the information regarding a single signature request passing its ID.

```
$response = $client->getSignature('a066298d-2877-11e4-b641-080027ea3a6e');
```

### Signature request

[](#signature-request)

Create a new signature request. You can check all signature [params](https://docs.signaturit.com/api/v3#sign_create_sign).

```
$filePath   = '/documents/contracts/receipt250.pdf';
$recipients = ['email' => 'john.doe@example.com', 'name' => 'John Doe'];
$options    = ['subject' => 'Receipt no. 250', 'body' => 'Please sign the receipt'];

$response = $client->createSignature($filePath, $recipients, $options);
```

You can add custom info in your requests

```
$filePath   = '/documents/contracts/receipt250.pdf';
$recipients = ['email' => 'john.doe@example.com', 'name' => 'John Doe'];
$options    = ['subject' => 'Receipt no. 250', 'body' => 'Please sign the receipt', 'data' => ['crm_id' => '45673']];

$response = $client->createSignature($filePath, $recipients, $options);
```

You can send templates with the fields filled

```
$recipients = ['email' => 'john.doe@example.com', 'name' => 'John Doe'];
$options    = ['subject' => 'Receipt no. 250', 'body' => 'Please sign the receipt', 'templates' => ['template_name'], 'data' => ['widget_id' => 'default value']];

$response = $client->createSignature([], $recipients, $options);
```

### Cancel signature request

[](#cancel-signature-request)

Cancel a signature request.

```
$response = $client->cancelSignature('a066298d-2877-11e4-b641-080027ea3a6e');
```

### Send reminder

[](#send-reminder)

Send a reminder email.

```
$response = $client->sendSignatureReminder('a066298d-2877-11e4-b641-080027ea3a6e');
```

### Get audit trail

[](#get-audit-trail)

Get the audit trail of a signature request document

```
$response = $client->downloadAuditTrail('a066298d-2877-11e4-b641-080027ea3a6e', 'd474a1eb-2877-11e4-b641-080027ea3a6e');
```

### Get signed document

[](#get-signed-document)

Get the signed document of a signature request document

```
$response = $client->downloadSignedDocument('a066298d-2877-11e4-b641-080027ea3a6e', 'd474a1eb-2877-11e4-b641-080027ea3a6e');
```

Branding
--------

[](#branding)

### Get brandings

[](#get-brandings)

Get all account brandings.

```
$response = $client->getBrandings();
```

### Get branding

[](#get-branding)

Get a single branding.

```
$response = $client->getBranding('6472aad7-2877-11e4-b641-080027ea3a6e');
```

### Create branding

[](#create-branding)

Create a new branding. You can check all branding [params](https://docs.signaturit.com/api/v3#set_branding).`

```
$options = [
    'layout_color'      => '#FFBF00',
    'text_color'        => '#2A1B0A',
    'application_texts' => ['sign_button' => 'Sign!']
];

$response = $client->createBranding($options);
```

### Update branding

[](#update-branding)

Update a single branding.

```
$options = ['application_texts' => ['send_button' => 'Send!']];

$response = $client->updateBranding('6472aad7-2877-11e4-b641-080027ea3a6e', $options);
```

Template
--------

[](#template)

### Get all templates

[](#get-all-templates)

Retrieve all data from your templates.

```
$response = $client->getTemplates();
```

Email
-----

[](#email)

### Get emails

[](#get-emails)

\####Get all certified emails

```
response = client->getEmails()
```

\####Get last 50 emails

```
response = client->getEmails(50)
```

\####Navigate through all emails in blocks of 50 results

```
response = client->getEmails(50, 50)
```

### Count emails

[](#count-emails)

Count all certified emails

```
response = client->countEmails()
```

### Get email

[](#get-email)

Get a single email

```
client->getEmail('EMAIL_ID')
```

### Create email

[](#create-email)

Create a new certified email.

```
response = client.createEmail(
    ['demo.pdf', 'receipt.pdf'],
    ['email' => 'john.doe@signaturit.com', 'name' => 'Mr John'],
    'Php subject',
    'Php body',
    []
)
```

### Get audit trail document

[](#get-audit-trail-document)

Get the audit trail document of an email request.

```
response = client.downloadEmailAuditTrail('EMAIL_ID','CERTIFICATE_ID')
```

Sms
---

[](#sms)

### Get all sms

[](#get-all-sms)

```
response = client->getSms()
```

### Count emails

[](#count-emails-1)

Count all certified sms

```
response = client->countSms()
```

### Get sms

[](#get-sms)

Get a single sms

```
client->getSms('SMS_ID')
```

### Create sms

[](#create-sms)

Create a new certified sms.

```
response = client.createSms(
    [],
    ['phone' => '34123456', 'name' => 'Mr John'],
    'Php body',
    []
)
```

### Get audit trail document

[](#get-audit-trail-document-1)

Get the audit trail document of an sms request.

```
response = client.downloadSmsAuditTrail('SMS_ID','CERTIFICATE_ID')
```

Team
----

[](#team)

### Get users

[](#get-users)

Get all account users

```
$response = $client->getUsers();
```

### Get seats

[](#get-seats)

Get all account seats

```
$response = $client->getSeats();
```

### Get user

[](#get-user)

Get a single user

```
$response = $client->getUser('USER_ID');
```

### Invite users to join your team

[](#invite-users-to-join-your-team)

Invite user to join the team

```
$response = $client->inviteUser('bob.soap@signaturit.com', 'admin');
```

### Change user role

[](#change-user-role)

Change role for user

```
$response = $client->changeUserRole('USER_ID', 'member');
```

### Remove user

[](#remove-user)

Remove user from the team

```
$response = $client->removeUser('USER_ID');
```

### Remove seat

[](#remove-seat)

Remove seat from the team

```
$response = $client->removeSeat('SEAT_ID');
```

### Get groups

[](#get-groups)

Get all account groups

```
$response = $client->getGroups();
```

### Get group

[](#get-group)

Get a single group

```
$response = $client->getGroup('GROUP_ID');
```

### Create group

[](#create-group)

Create a new group

```
$response = $client->createGroup('test_node');
```

### Update group

[](#update-group)

Update group name

```
$response = $client->updateGroup('GROUP_ID', 'new_name');
```

### Delete group

[](#delete-group)

Delete a group

```
$response = $client->deleteGroup('GROUP_ID');
```

### Add manager to group

[](#add-manager-to-group)

Add a manager to a group

```
$response = $client->addManagerToGroup('GROUP_ID', 'USER_ID');
```

### Add manager to group

[](#add-manager-to-group-1)

Add a member to a group

```
$response = $client->addMemberToGroup('GROUP_ID', 'USER_ID');
```

### Delete manager from group

[](#delete-manager-from-group)

Remove a manager from group

```
$response = $client->removeManagerFromGroup('GROUP_ID', 'USER_ID');
```

### Delete member from group

[](#delete-member-from-group)

Remove a member from group

```
$response  = $client->removeMemberFromGroup('GROUP_ID', 'USER_ID');
```

Contacts
--------

[](#contacts)

### Get contacts

[](#get-contacts)

Get all contacts

```
$response = $client->getContacts();
```

### Get contact

[](#get-contact)

Get a single contact

```
$response = $client->getContact('CONTACT_ID');
```

### Create contact

[](#create-contact)

Create a new contact

```
$response = $client->createContact('email@signaturit.com', 'name');
```

### Update contact

[](#update-contact)

Update contact

```
$response = $client->updateContact('CONTACT_ID', 'new_email@signaturit.com', 'name1');
```

### Delete contact

[](#delete-contact)

Delete a contact

```
$response = $client->deleteContact('CONTACT_ID');
```

### Get subscriptions

[](#get-subscriptions)

Get all subscriptions

```
$response = $client->getSubscriptions();
```

### Get subscription

[](#get-subscription)

Get a single subscription

```
$response = $client->getSubscription('SUBSCRIPTION_ID');
```

### Create subscription

[](#create-subscription)

Create a new subscription

```
$response = $client->createSubscription('http://httpbin.org/post', 'email_processed');
```

### Update subscription

[](#update-subscription)

Update contact

```
$response = $client->updateSubscription('SUBSCRIPTION_ID', null, 'email_delivered');
```

### Delete subscription

[](#delete-subscription)

Delete a subscription

```
$response = $client->deleteSubscription('SUBSCRIPTION_ID');
```

###  Health Score

43

—

FairBetter than 91% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity41

Moderate usage in the ecosystem

Community20

Small or concentrated contributor base

Maturity74

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

Every ~382 days

Recently: every ~658 days

Total

8

Last Release

1595d ago

Major Versions

0.0.5 → 1.0.02016-01-20

PHP version history (3 changes)0.0.1PHP >=5.3.0

1.0.0PHP >=5.5.0

1.2.0PHP ^7.2|^8.0

### Community

Maintainers

![](https://www.gravatar.com/avatar/3a4d673cbc26e17760f8a02d9db3cd22aa9eb933a64674bb7dc2c2f01258c95b?d=identicon)[signaturit](/maintainers/signaturit)

---

Top Contributors

[![ecentinela](https://avatars.githubusercontent.com/u/13818?v=4)](https://github.com/ecentinela "ecentinela (22 commits)")[![Psramos](https://avatars.githubusercontent.com/u/4967050?v=4)](https://github.com/Psramos "Psramos (21 commits)")[![1ma](https://avatars.githubusercontent.com/u/1456708?v=4)](https://github.com/1ma "1ma (3 commits)")[![lales12](https://avatars.githubusercontent.com/u/4629235?v=4)](https://github.com/lales12 "lales12 (3 commits)")[![asurcodes](https://avatars.githubusercontent.com/u/25269358?v=4)](https://github.com/asurcodes "asurcodes (2 commits)")

---

Tags

phpsdksignaturit

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/signaturit-signaturit-sdk/health.svg)

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

###  Alternatives

[tencentcloud/tencentcloud-sdk-php

TencentCloudApi php sdk

3731.2M42](/packages/tencentcloud-tencentcloud-sdk-php)[convertkit/convertkitapi

Kit PHP SDK for the Kit API

2167.1k1](/packages/convertkit-convertkitapi)[mapado/rest-client-sdk

Rest Client SDK for hydra API

1125.9k2](/packages/mapado-rest-client-sdk)

PHPackages © 2026

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