README

ValidSign (OneSpan Sign) implementation of the SignatureProvider contract from laulamanapps/document-signer-sdk.

Install

composer require laulamanapps/document-signer-validsign

Quick start

use LauLamanApps\DocumentSigner\Sdk\Document\Document;
use LauLamanApps\DocumentSigner\Sdk\Envelope\Envelope;
use LauLamanApps\DocumentSigner\Sdk\Signer\Signer;
use LauLamanApps\DocumentSigner\ValidSign\ValidSignConfig;
use LauLamanApps\DocumentSigner\ValidSign\ValidSignProvider;

$provider = new ValidSignProvider(new ValidSignConfig(
    apiKey:  getenv('VALIDSIGN_API_KEY'),
    baseUrl: 'https://my.validsign.nl/api',
));

$receipt = $provider->send(new Envelope(
    name:         'NDA',
    documents:    [new Document(
        id:   'nda',
        name: 'NDA',
        html: '<p>{[signature:counterparty:sig]} on {[date:counterparty:signdate]}</p>',
    )],
    signers:      [new Signer(key: 'counterparty', name: 'Jane Doe', email: 'jane@example.com')],
    emailSubject: 'Please sign the NDA',
));

echo $receipt->provider;           // "validsign" (ValidSignProvider::NAME)
echo $receipt->providerEnvelopeId; // ValidSign packageId

What it does

For every document in the envelope, this package:

1. Parses {[type:signer:name]} placeholders out of the HTML.
2. Substitutes each one with a hidden anchor token ([[VS:type:signer:name]]).
3. Renders the HTML to PDF via the SDK's PdfRenderer (Browsershot by default).
4. POSTs the PDFs + a OneSpan package JSON to POST /packages with anchor extraction enabled, so ValidSign positions each signature/field at its anchor location.
5. Returns an EnvelopeReceipt containing the ValidSign package id and a normalised EnvelopeStatus.

Field mapping

Requirements

• PHP 8.5
• laulamanapps/documentsigner-sdk
• A ValidSign tenant + API key
• Node.js + Puppeteer (for the default Browsershot renderer)

Documentation

The full provider guide — credentials, endpoint mapping, status mapping, sequential signing, injecting a custom HTTP client, troubleshooting — lives in the SDK's docs:

• ValidSign provider guide
• Placeholder syntax
• PDF rendering
• Architecture overview