PHPackages                             equipmentc/laravel-oathello - 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. equipmentc/laravel-oathello

ActiveLibrary

equipmentc/laravel-oathello
===========================

A Laravel wrapper for the Oathello API

v1.0.9(4y ago)11.7k[2 PRs](https://github.com/equipmentc/laravel-oathello/pulls)MITPHPCI passing

Since May 26Pushed 3mo ago1 watchersCompare

[ Source](https://github.com/equipmentc/laravel-oathello)[ Packagist](https://packagist.org/packages/equipmentc/laravel-oathello)[ RSS](/packages/equipmentc-laravel-oathello/feed)WikiDiscussions master Synced yesterday

READMEChangelog (10)Dependencies (3)Versions (14)Used By (0)

[![Latest Stable Version](https://camo.githubusercontent.com/ef5bb07c2a01b07e5da0867a72122127084bf5a33f0d97fa7255aabdfd4b365c/68747470733a2f2f706f7365722e707567782e6f72672f65717569706d656e74632f6c61726176656c2d6f617468656c6c6f2f76)](//packagist.org/packages/equipmentc/laravel-oathello) [![Total Downloads](https://camo.githubusercontent.com/b28ce5d79b66bf942cfb97219a4f859dd1afd43571d7d4605b9b4704bfe9cd43/68747470733a2f2f706f7365722e707567782e6f72672f65717569706d656e74632f6c61726176656c2d6f617468656c6c6f2f646f776e6c6f616473)](//packagist.org/packages/equipmentc/laravel-oathello) [![Latest Unstable Version](https://camo.githubusercontent.com/2a565514a9f9f262ac58865447fd0331349e22d057db97c66bf6b5acc8f655c6/68747470733a2f2f706f7365722e707567782e6f72672f65717569706d656e74632f6c61726176656c2d6f617468656c6c6f2f762f756e737461626c65)](//packagist.org/packages/equipmentc/laravel-oathello) [![License](https://camo.githubusercontent.com/21c405bb15df92ee0e4a652fdd1abbf7ed21225756f73a44893abdc315bb491e/68747470733a2f2f706f7365722e707567782e6f72672f65717569706d656e74632f6c61726176656c2d6f617468656c6c6f2f6c6963656e7365)](//packagist.org/packages/equipmentc/laravel-oathello)

laravel-oathello
================

[](#laravel-oathello)

Oathello API Laravel package.
[Oathello](https://www.oathello.com/oathello-sign) is the Signing API built for the Finance Industry.

Install
-------

[](#install)

composer require equipmentc/laravel-oathello

publish config
--------------

[](#publish-config)

php artisan vendor:publish --tag=oathello

add to .env
-----------

[](#add-to-env)

OATHELLO\_ENDPOINT= (optional)
OATHELLO\_API\_KEY=xyz
OATHELLO\_CALLBACK\_URL=

HOW TO USE
==========

[](#how-to-use)

There are two ways to use this package.
The first is to use the Oathello Base Class to query the Oathello RESTful API directly.

### 1. Use the Oathello Base Class to query the Oathello RESTful API directly.

[](#1-use-the-oathello-base-class-to-query-the-oathello-restful-api-directly)

You can find the API Endpoints here

```
use Equipmentc\Oathello\Oathello;

$oathello = new Oathello;
$oathello->get('Session/xyz');
$oathello->post('Session', $array);

```

#### Or use the facade

[](#or-use-the-facade)

```
Oathello::get('Session/xyz');
Oathello::post('Session', $array);

```

### 2. For embedded integrations you may only be concerned with documents.

[](#2-for-embedded-integrations-you-may-only-be-concerned-with-documents)

In this scenario you can use the helper classes OathelloSession &amp; Document to simplify the process.

#### Create a session of one or more (an envelope) documents

[](#create-a-session-of-one-or-more-an-envelope-documents)

```
use Equipmentc\Oathello\Session as OathelloSession;

$documents = [...];  (See a document array example below)
$oathelloSession = new OathelloSession;
$oathelloSession->create($documents [, $metadata = null ]);

or the facade

$documents = [...];  (See a document array example below)
OathelloSession::create($documents [, $metadata = null ]);

```

#### Retrieve a session

[](#retrieve-a-session)

```
$oathelloSession->get($sessionId);

or the facade

OathelloSession::get($sessionId);

```

#### Cancel a session

[](#cancel-a-session)

```
$oathelloSession->cancel($sessionId);

or the facade

OathelloSession::cancel($sessionId);

```

#### Document example usage

[](#document-example-usage)

```
use Equipmentc\Oathello\Document;

$document = new Document;
$file = $document->get($documentID);
$document->download($file);

or the facade

$file = Document::get($documentID);
Document::download($file);

```

HOW TO EMBED A DOCUMENT
=======================

[](#how-to-embed-a-document)

```
@document(SESSION_ID, DOCUMENT_ID, SIGNER_ID (optional))
@onDocumentSigned
    // add your javascript without script tags
@endonDocumentSigned
@onSessionFinished
    // add your javascript without script tags
@endonSessionFinished

```

Testing
-------

[](#testing)

Add your own API key and callback url to the phpunit.xml file.

Example Document
----------------

[](#example-document)

```
$documents = [[
    'title'    => 'Example',
    'fileName' => 'example.pdf',
    'mode'     => 'Signing',
    'content'  => '{{YOUR_BASE64_ENCODED_DOCUMENT}}',
    "instructions" => [[
        "userInputFields" => [[
           "title" => "Add signature",
           "type" => "signature",
           "for" => "signer",
           "region" => [
               "pageNumber" => 1,
               "x" => 260,
               "y" => 395,
               "width" => 120,
               "height" => 20,
               "isVisible" => true,
            ],
            "declarations" => []
        ]],
    ]],
    "textFields" => [[
       "content" => "[DATE]",
       "region" => [
           "pageNumber" => 1,
           "x" => 280,
           "y" => 735,
           "width" => 60,
           "height" => 10,
           "isVisible" => true
        ],
        "fontSize" => 8,
    ]],
]];

```

###  Health Score

39

—

LowBetter than 86% of packages

Maintenance54

Moderate activity, may be stable

Popularity17

Limited adoption so far

Community11

Small or concentrated contributor base

Maturity63

Established project with proven stability

 Bus Factor1

Top contributor holds 89.3% 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 ~78 days

Recently: every ~170 days

Total

10

Last Release

1475d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/917620e0dbf1140913b430937e92c40a070cdb83c563dc0db299f35e08ad6daf?d=identicon)[trevec](/maintainers/trevec)

---

Top Contributors

[![trevsewell](https://avatars.githubusercontent.com/u/18395918?v=4)](https://github.com/trevsewell "trevsewell (25 commits)")[![paul-court](https://avatars.githubusercontent.com/u/437990?v=4)](https://github.com/paul-court "paul-court (1 commits)")[![thomsonjf](https://avatars.githubusercontent.com/u/3081097?v=4)](https://github.com/thomsonjf "thomsonjf (1 commits)")[![trevequipmentconnect](https://avatars.githubusercontent.com/u/60614900?v=4)](https://github.com/trevequipmentconnect "trevequipmentconnect (1 commits)")

###  Code Quality

TestsPHPUnit

Code StylePHP\_CodeSniffer

### Embed Badge

![Health badge](/badges/equipmentc-laravel-oathello/health.svg)

```
[![Health](https://phpackages.com/badges/equipmentc-laravel-oathello/health.svg)](https://phpackages.com/packages/equipmentc-laravel-oathello)
```

###  Alternatives

[neuron-core/neuron-ai

The PHP Agentic Framework.

1.8k245.3k21](/packages/neuron-core-neuron-ai)[tencentcloud/tencentcloud-sdk-php

TencentCloudApi php sdk

3731.2M42](/packages/tencentcloud-tencentcloud-sdk-php)[aedart/athenaeum

Athenaeum is a mono repository; a collection of various PHP packages

255.2k](/packages/aedart-athenaeum)

PHPackages © 2026

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