PHPackages                             landrok/yousign-api - 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. landrok/yousign-api

ActiveLibrary[API Development](/categories/api)

landrok/yousign-api
===================

A PHP implementation of YouSign API.

1.4.0(2y ago)611.6k↓36%5[1 PRs](https://github.com/landrok/yousign-api/pulls)MITPHPPHP ^7.4 || ^8.0

Since May 11Pushed 1y ago2 watchersCompare

[ Source](https://github.com/landrok/yousign-api)[ Packagist](https://packagist.org/packages/landrok/yousign-api)[ Docs](https://yousign-api.readthedocs.io)[ RSS](/packages/landrok-yousign-api/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (4)Dependencies (3)Versions (6)Used By (0)

Yousign API client
==================

[](#yousign-api-client)

[![Build Status](https://camo.githubusercontent.com/ba3057ef56cb79d44fbb41d0b27ac9aa535da9007d6a9dcbb63b90a71a0de897/68747470733a2f2f6170692e7472617669732d63692e636f6d2f6c616e64726f6b2f796f757369676e2d6170692e7376673f6272616e63683d6d6173746572)](https://travis-ci.com/landrok/yousign-api)[![Maintainability](https://camo.githubusercontent.com/4fdc8bd9b88d475feabb39db4d3b0595edfb0d08b4f2350d3cae51f948bd892a/68747470733a2f2f6170692e636f6465636c696d6174652e636f6d2f76312f6261646765732f63616438313735306333326335333436616336622f6d61696e7461696e6162696c697479)](https://codeclimate.com/github/landrok/yousign-api/maintainability)[![Test Coverage](https://camo.githubusercontent.com/0cc84a555cc150a864bfb4d7cf26e9488fe054fa11187d790aba1b08375024bc/68747470733a2f2f6170692e636f6465636c696d6174652e636f6d2f76312f6261646765732f63616438313735306333326335333436616336622f746573745f636f766572616765)](https://codeclimate.com/github/landrok/yousign-api/test_coverage)

Yousign API client is a wrapper for the Yousign API v2 in PHP.

Its purpose is to use this API without having to write the HTTP calls yourself and then to retrieve the returned data through an object model.

If you still want to make HTTP calls to check the API responses, this is possible thanks to the low-level calls.

It provides several an API wrapper and shortcut methods.

All the API calls are wrapped into an object model. All features are implemented, it aims to be a full-featured client.

All subsequent types (Member, Procedure, File, etc...) are implemented too.

[See the full documentation](https://yousign-api.readthedocs.io/) or an overview below.

Table of contents
=================

[](#table-of-contents)

- [Requirements](#requirements)
- [Install](#install)
- [Quick start](#quick-start)
- [Basic mode](#basic-mode)
- [Advanced mode](#advanced-mode)
- [Branding with signature UI](#branding-with-signature-ui)

---

Requirements
------------

[](#requirements)

- PHP 7.4+
- You have to create your account on Yousign platform to get an API token before using this library.

---

Install
-------

[](#install)

```
composer require landrok/yousign-api
```

---

Quick start
-----------

[](#quick-start)

In this example, we will get all users in staging mode.

```
use Yousign\YousignApi;

/*
 * token
 */
$token = '123456789';

$yousign = new YousignApi($token);

$users = $yousign->getUsers();
```

Good news, your token is available.

---

Responses and data
------------------

[](#responses-and-data)

All API responses are converted into objects that are iterable when it's a collection (ie a list of users) or an item (an user itself).

### Dump data

[](#dump-data)

You can use toArray() method to dump all data as a PHP array.

```
print_r(
    $users->toArray()
);
```

### Iterate over a list

[](#iterate-over-a-list)

You can iterate over all items of a collection.

```
foreach ($users as $user) {
    /*
     * For each User model, some methods are available
     */

    // toArray(): to get all property values
    print_r($user->toArray());

    // get + property name
    echo PHP_EOL . "User.id=" . $user->getId();

    // property (read-only)
    echo PHP_EOL . "User.id=" . $user->id;

    // Some properties are models that you can use the same way
    echo PHP_EOL . "User.Group.id=" . $user->getGroup()->getId();
    echo PHP_EOL . "User.Group.id=" . $user->group->id;

    // Some properties are collections that you can iterate
    foreach ($user->group->permissions as $index => $permission) {
        echo PHP_EOL . "User.Group.Permission.name=" . $permission->getName();
    }

    // At any level, you can call a toArray() to dump the current model
    // and its children
    echo PHP_EOL . "User.Group=\n";
    print_r($user->group->toArray());
    echo PHP_EOL . "User.Group.Permissions=\n";
    print_r($user->group->permissions->toArray());
}
```

---

Basic Mode
----------

[](#basic-mode)

Let's create your first signature procedure in basic mode.

In this example, we will accomplish this mode with low-level features.

```
use Yousign\YousignApi;

/*
 * Token
 */
$token = '123456789';

/*
 * Production mode
 */
$production = false;

/*
 * Instanciate API wrapper
 */
$yousign = new YousignApi($token, $production);

/*
 * 1st step : send a file
 */
$file = $yousign->postFile([
    'name'    => 'My filename.pdf',
    'content' => base64_encode(
        file_get_contents(
            dirname(__DIR__, 2) . '/tests/samples/test-file-1.pdf'
        )
    )
]);

/*
 * 2nd step : create the procedure
 */
$procedure = $yousign->postProcedure([
    "name"        => "My first procedure",
    "description" => "Awesome! Here is the description of my first procedure",
    "members"     => [
        [
            "firstname" => "John",
            "lastname" => "Doe",
            "email" => "john.doe@yousign.fr",
            "phone" => "+33612345678",
            "fileObjects" => [
                [
                    "file" => $file->getId(),
                    "page" => 2,
                    "position" => "230,499,464,589",
                    "mention" => "Read and approved",
                    "mention2" => "Signed by John Doe"
                ]
            ]
        ]
    ]
]);

// toJson() supports all PHP json_encode flags
echo $procedure->toJson(JSON_PRETTY_PRINT);
```

When the procedure is created, you can retrieve all the data with the getters or dump all data with `toJson()` and `toArray()` methods.

It would output something like:

```
{
    "id": "\/procedures\/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
    "name": "My first procedure",
    "description": "Awesome! Here is the description of my first procedure",
    "createdAt": "2018-12-01T11:49:11+01:00",
    "updatedAt": "2018-12-01T11:49:11+01:00",
    "finishedAt": null,
    "expiresAt": null,
    "status": "active",
    "creator": null,
    "creatorFirstName": null,
    "creatorLastName": null,
    "workspace": "\/workspaces\/XXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
    "template": false,
    "ordered": false,
    "parent": null,
    "metadata": [],
    "config": [],
    "members": [
        {
            "id": "\/members\/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
            "user": null,
            "type": "signer",
            "firstname": "John",
            "lastname": "Doe",
            "email": "john.doe@yousign.fr",
            "phone": "+33612345678",
            "position": 1,
            "createdAt": "2018-12-01T11:49:11+01:00",
            "updatedAt": "2018-12-01T11:49:11+01:00",
            "finishedAt": null,
            "status": "pending",
            "fileObjects": [
                {
                    "id": "\/file_objects\/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
                    "file": {
                        "id": "\/files\/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
                        "name": "The best name for my file.pdf",
                        "type": "signable",
                        "contentType": "application\/pdf",
                        "description": null,
                        "createdAt": "2018-12-01T11:36:20+01:00",
                        "updatedAt": "2018-12-01T11:49:11+01:00",
                        "sha256": "bb57ae2b2ca6ad0133a699350d1a6f6c8cdfde3cf872cf526585d306e4675cc2",
                        "metadata": [],
                        "workspace": "\/workspaces\/XXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
                        "creator": null,
                        "protected": false,
                        "position": 0,
                        "parent": null
                    },
                    "page": 2,
                    "position": "230,499,464,589",
                    "fieldName": null,
                    "mention": "Read and approved",
                    "mention2": "Signed by John Doe",
                    "createdAt": "2018-12-01T11:49:11+01:00",
                    "updatedAt": "2018-12-01T11:49:11+01:00",
                    "parent": null,
                    "reason": "Signed by Yousign"
                }
            ],
            "comment": null,
            "notificationsEmail": [],
            "operationLevel": "custom",
            "operationCustomModes": [
                "sms"
            ],
            "operationModeSmsConfig": null,
            "parent": null
        }
    ],
    "subscribers": [],
    "files": [
        {
            "id": "\/files\/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
            "name": "My filename.pdf",
            "type": "signable",
            "contentType": "application\/pdf",
            "description": null,
            "createdAt": "2018-12-01T11:36:20+01:00",
            "updatedAt": "2018-12-01T11:49:11+01:00",
            "sha256": "bb57ae2b2ca6ad0133a699350d1a6f6c8cdfde3cf872cf526585d306e4675cc2",
            "metadata": [],
            "workspace": "\/workspaces\/XXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
            "creator": null,
            "protected": false,
            "position": 0,
            "parent": null
        }
    ],
    "relatedFilesEnable": false,
    "archive": false,
    "archiveMetadata": [],
    "fields": [],
    "permissions": []
}
```

---

Advanced Mode
-------------

[](#advanced-mode)

Here is how to create a procedure in 5 steps with the advanced mode.

```
use Yousign\YousignApi;

/*
 * Token
 */
$token = '123456789';

/*
 * Production mode
 */
$production = false;

/*
 * Instanciate API wrapper
 */
$yousign = new YousignApi($token, $production);

/*
 * Step 1 - Create your procedure
 */
$procedure = $yousign->postProcedure([
    "name"        => "My first procedure",
    "description" => "Description of my procedure with advanced mode",
    "start"       => false,
]);

/*
 * Step 2 - Add the files
 */
$file = $yousign->postFile([
    'name'    => 'Name of my signable file.pdf',
    'content' => base64_encode(
        file_get_contents(
            dirname(__DIR__, 2) . '/tests/samples/test-file-1.pdf'
        )
    ),
    'procedure' => $procedure->getId(),
]);

/*
 * Step 3 - Add the members
 */
$member = $yousign->postMember([
    "firstname"     => "John",
    "lastname"      => "Doe",
    "email"         => "john.doe@yousign.fr",
    "phone"         => "+33612345678",
    "procedure"     => $procedure->getId(),
]);

/*
 * Step 4 - Add the signature images
 */
$fileObject = $yousign->postFileObject([
    "file"      => $file->getId(),
    "member"    => $member->getId(),
    "position"  => "230,499,464,589",
    "page"      => 2,
    "mention"   => "Read and approved",
    "mention2"  => "Signed By John Doe"
]);

 /*
  * Step 5 - Start the procedure
  */
$procedure = $yousign->putProcedure(
    $procedure->getId(), [
        "start" => true,
    ]
);

echo $procedure->toJson(JSON_PRETTY_PRINT);
```

In step 3, you may add several members.

In step 4, you may add one or more signature images for each one.

---

Branding with signature UI
--------------------------

[](#branding-with-signature-ui)

By default, Signature-UI has the Yousign theme (logo, colors, ...) but you can customize the signature flow embedded in the iFrame from Signature-UI view located in the Admin menu of the app or entirely customize this iFrame by using a specific resource `/signature_uis`.

```
use Yousign\YousignApi;

/*
 * Token
 */
$token = '123456789';

/*
 * Production mode
 */
$production = false;

/*
 * Instanciate API wrapper
 */
$yousign = new YousignApi($token, $production);

/*
 * Create your customized UI
 */
$ui = $yousign->postSignatureUi([
    "name"                    => "My first template for Signature-UI",
    "description"             => "Here is the Signature-UI template for Yousign Developers.",
    "defaultZoom"             => 100,
    "logo"                    => "data:image/png;base64,iVBORw0K [...] XIwU3i6foIAAAAAElFTkSuQmCC",
    "languages"               => ["fr", "en"],
    "defaultLanguage"         => "en",
    "labels"                  => [
        [
            "name"      => "NAME OF THE LABEL",
            "languages" => [
                "en" => "Label en",
                "fr" => "Label fr"
            ],
            "creator"   => null,
        ]
    ],
    "signImageTypesAvailable" => [
        "name",
        "draw",
    ],
    "enableHeaderBar"         => true,
    "enableHeaderBarSignAs"   => true,
    "enableSidebar"           => true,
    "enableMemberList"        => true,
    "enableDocumentList"      => true,
    "enableDocumentDownload"  => true,
    "enableActivities"        => false,
    "authenticationPopup"     => false,
    "enableRefuseComment"     => true,
    "fonts"                   => ["Roboto", "Lato"],
    "creator"                 => null,
    "redirectCancel"          => [
        "url"    => "https://example.com?cancel=1",
        "target" => "_top",
        "auto"   => false
    ],
    "redirectError"           => [
        "url"    => "https://example.com?error=1",
        "target" => "_blank",
        "auto"   => true
    ],
    "redirectSuccess"           => [
        "url"    => "https://example.com?success=1",
        "target" => "_parent",
        "auto"   => true
    ],
    "style"                   => "
        .sign-ui-header-bar { background-color: #00f }
        .sign-ui-headerbar-signas { background-color: #f00 }
        .sign-ui-headerbar-signas--primary { background-color: #f00 }
        .sign-ui-tab-item { color: #000 }
        .sign-ui-tab-item--current { background-color: #0f0; color: #fff }
    "
]);
```

In the response below, you will get an id that will be useful to create your iFrame.

```
[
    "id"                      => "/signature_uis/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
    "name"                    => "My first template for Signature-UI",
    "description"             => "Here is the Signature-UI template for Yousign Developers.",
    "enableHeaderBar"         => true,
    "enableHeaderBarSignAs"   => true,
    "enableSidebar"           => true,
    "enableMemberList"        => true,
    "enableDocumentList"      => true,
    "enableDocumentDownload"  => true,
    "enableActivities"        => true,
    "authenticationPopup"     => true,
    "enableRefuseComment"     => true,
    "defaultZoom"             => 100,
    "logo"                    => "data:image/png;base64,iVBORw0K [...] XIwU3i6foIAAAAAElFTkSuQmCC",
    "defaultLanguage"         => "en",
    "signImageTypesAvailable" => [
        "name",
        "draw"
    ],
    "languages"               => [
        "fr",
        "en",
        "es",
        "de",
        "it",
        "pt",
        "nl"
    ],
    "labels"                  => [
        [
            "id"        => "/signature_ui_labels/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
            "name"      => "NAME OF THE LABEL",
            "languages" => [
                "en" => "Label en",
                "fr" => "Label fr"
            ],
            "creator"   => null,
            "createdAt" => "2018-12-07T07:34:22+01:00",
            "updatedAt" => "2018-12-07T07:34:22+01:00"
        ]
    ],
    "fonts"                   => [
        "Roboto",
        "Lato"
    ],
    "style"                   => "Just a CSS string for customize all of our iFrame.",
    "redirectCancel"          => [
        "url"    => "https://example.com?cancel=1",
        "target" => "_top",
        "auto"   => false
    ],
    "redirectError"           => [
        "url"    => "https://example.com?error=1",
        "target" => "_blank",
        "auto"   => true
    ],
    "redirectSuccess"           => [
        "url"    => "https://example.com?success=1",
        "target" => "_parent",
        "auto"   => true
    ],
    "workspace"               => "/workspaces/XXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
    "creator"                 => null,
    "createdAt"               => "2018-12-07T07:34:22+01:00",
    "updatedAt"               => "2018-12-07T07:34:22+01:00"
]
```

---

More
----

[](#more)

- [See the full documentation](https://yousign-api.readthedocs.io/)
- To discuss new features, make feedback or simply to share ideas, you can contact me on Mastodon at
- Create an account and an API token on [Yousign Sandbox sign-up](https://staging-auth.yousign.com/pre-signup)
- [Official API manual](https://dev.yousign.com/?version=latest)

###  Health Score

38

—

LowBetter than 85% of packages

Maintenance28

Infrequent updates — may be unmaintained

Popularity33

Limited adoption so far

Community14

Small or concentrated contributor base

Maturity64

Established project with proven stability

 Bus Factor1

Top contributor holds 96.4% of commits — single point of failure

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 ~329 days

Total

5

Last Release

880d ago

PHP version history (4 changes)1.0PHP ^7.0

1.1PHP ^7.1|^8.0

1.3.0PHP ^7.2.5 || ^8.0

1.4.0PHP ^7.4 || ^8.0

### Community

Maintainers

![](https://www.gravatar.com/avatar/04ee1be59b281d31a2d48077a359052060f53baf7409cd1be97fe54ad4e7eb51?d=identicon)[landrok](/maintainers/landrok)

---

Top Contributors

[![landrok](https://avatars.githubusercontent.com/u/3310446?v=4)](https://github.com/landrok "landrok (53 commits)")[![Alpifra](https://avatars.githubusercontent.com/u/57103080?v=4)](https://github.com/Alpifra "Alpifra (1 commits)")[![LoBrs](https://avatars.githubusercontent.com/u/5214756?v=4)](https://github.com/LoBrs "LoBrs (1 commits)")

---

Tags

apiclientprocedureyousignapisignatureyousign

###  Code Quality

TestsPHPUnit

Static AnalysisPHPStan

Type Coverage Yes

### Embed Badge

![Health badge](/badges/landrok-yousign-api/health.svg)

```
[![Health](https://phpackages.com/badges/landrok-yousign-api/health.svg)](https://phpackages.com/packages/landrok-yousign-api)
```

###  Alternatives

[openai-php/laravel

OpenAI PHP for Laravel is a supercharged PHP API client that allows you to interact with the Open AI API

3.7k7.6M74](/packages/openai-php-laravel)[mailchimp/transactional

458.9M16](/packages/mailchimp-transactional)[get-stream/stream-chat

A PHP client for Stream Chat (https://getstream.io/chat/)

301.8M2](/packages/get-stream-stream-chat)[convertkit/convertkitapi

Kit PHP SDK for the Kit API

2167.1k1](/packages/convertkit-convertkitapi)

PHPackages © 2026

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