Yousign\Client\DocumentApi

All URIs are relative to https://api-sandbox.yousign.app/v3, except if the operation defines another base path.

Method	HTTP request	Description
deleteSignatureRequestsSignatureRequestIdDocumentsDocumentId()	DELETE /signature_requests/{signatureRequestId}/documents/{documentId}	Delete a Document
getSignatureRequestsSignatureRequestIdDocuments()	GET /signature_requests/{signatureRequestId}/documents	List Signature Request's Documents
getSignatureRequestsSignatureRequestIdDocumentsDocumentId()	GET /signature_requests/{signatureRequestId}/documents/{documentId}	Get a Document
getSignatureRequestsSignatureRequestIdDocumentsDocumentsIdDownload()	GET /signature_requests/{signatureRequestId}/documents/{documentId}/download	Download a single Signature Request's Document
getSignatureRequestsSignatureRequestIdDocumentsDownload()	GET /signature_requests/{signatureRequestId}/documents/download	Download Signature Request's Documents
patchSignatureRequestsSignatureRequestIdDocumentsDocumentId()	PATCH /signature_requests/{signatureRequestId}/documents/{documentId}	Update a Document
postDocuments()	POST /documents	[DEPRECATED] Upload a Document
postSignatureRequestsSignatureRequestIdDocuments()	POST /signature_requests/{signatureRequestId}/documents	Add Document to a Signature Request
postSignatureRequestsSignatureRequestIdDocumentsDocumentIdReplace()	POST /signature_requests/{signatureRequestId}/documents/{documentId}/replace	Replace a Document in a Signature Request

`deleteSignatureRequestsSignatureRequestIdDocumentsDocumentId()`

deleteSignatureRequestsSignatureRequestIdDocumentsDocumentId($signature_request_id, $document_id)

Delete a Document

Deletes a given Document from a Signature Request.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure Bearer authorization: bearerAuth
$config = Yousign\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Yousign\Client\Api\DocumentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$signature_request_id = 'signature_request_id_example'; // string | Signature Request Id
$document_id = 'document_id_example'; // string | Document Id

try {
    $apiInstance->deleteSignatureRequestsSignatureRequestIdDocumentsDocumentId($signature_request_id, $document_id);
} catch (Exception $e) {
    echo 'Exception when calling DocumentApi->deleteSignatureRequestsSignatureRequestIdDocumentsDocumentId: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
signature_request_id	string	Signature Request Id
document_id	string	Document Id

Return type

void (empty response body)

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`getSignatureRequestsSignatureRequestIdDocuments()`

getSignatureRequestsSignatureRequestIdDocuments($signature_request_id, $nature): \Yousign\Client\Model\Document[]

List Signature Request's Documents

Returns a list of Documents for a given Signature Request.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure Bearer authorization: bearerAuth
$config = Yousign\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Yousign\Client\Api\DocumentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$signature_request_id = 'signature_request_id_example'; // string | Signature Request Id
$nature = 'nature_example'; // string | Filter by nature

try {
    $result = $apiInstance->getSignatureRequestsSignatureRequestIdDocuments($signature_request_id, $nature);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DocumentApi->getSignatureRequestsSignatureRequestIdDocuments: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
signature_request_id	string	Signature Request Id
nature	string	Filter by nature	[optional]

Return type

\Yousign\Client\Model\Document[]

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`getSignatureRequestsSignatureRequestIdDocumentsDocumentId()`

getSignatureRequestsSignatureRequestIdDocumentsDocumentId($signature_request_id, $document_id): \Yousign\Client\Model\Document

Get a Document

Retrieves a given Document.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure Bearer authorization: bearerAuth
$config = Yousign\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Yousign\Client\Api\DocumentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$signature_request_id = 'signature_request_id_example'; // string | Signature Request Id
$document_id = 'document_id_example'; // string | Document Id

try {
    $result = $apiInstance->getSignatureRequestsSignatureRequestIdDocumentsDocumentId($signature_request_id, $document_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DocumentApi->getSignatureRequestsSignatureRequestIdDocumentsDocumentId: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
signature_request_id	string	Signature Request Id
document_id	string	Document Id

Return type

\Yousign\Client\Model\Document

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`getSignatureRequestsSignatureRequestIdDocumentsDocumentsIdDownload()`

getSignatureRequestsSignatureRequestIdDocumentsDocumentsIdDownload($signature_request_id, $document_id): \SplFileObject

Download a single Signature Request's Document

Downloads the PDF version of a given Document.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure Bearer authorization: bearerAuth
$config = Yousign\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Yousign\Client\Api\DocumentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$signature_request_id = 'signature_request_id_example'; // string | Signature Request Id
$document_id = 'document_id_example'; // string | Document Id

try {
    $result = $apiInstance->getSignatureRequestsSignatureRequestIdDocumentsDocumentsIdDownload($signature_request_id, $document_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DocumentApi->getSignatureRequestsSignatureRequestIdDocumentsDocumentsIdDownload: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
signature_request_id	string	Signature Request Id
document_id	string	Document Id

Return type

\SplFileObject

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/pdf, application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`getSignatureRequestsSignatureRequestIdDocumentsDownload()`

getSignatureRequestsSignatureRequestIdDocumentsDownload($signature_request_id, $version, $archive): \SplFileObject

Download Signature Request's Documents

Downloads the PDF version of all Documents attached to a given Signature Request.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure Bearer authorization: bearerAuth
$config = Yousign\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Yousign\Client\Api\DocumentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$signature_request_id = 'signature_request_id_example'; // string | Signature Request Id
$version = 'version_example'; // string | Specify Documents version to download, `completed` is only available when the Signature Request status is `done`.
$archive = True; // bool | Force zip archive download

try {
    $result = $apiInstance->getSignatureRequestsSignatureRequestIdDocumentsDownload($signature_request_id, $version, $archive);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DocumentApi->getSignatureRequestsSignatureRequestIdDocumentsDownload: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
signature_request_id	string	Signature Request Id
version	string	Specify Documents version to download, `completed` is only available when the Signature Request status is `done`.	[optional]
archive	bool	Force zip archive download	[optional]

Return type

\SplFileObject

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/zip, application/pdf, application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`patchSignatureRequestsSignatureRequestIdDocumentsDocumentId()`

patchSignatureRequestsSignatureRequestIdDocumentsDocumentId($signature_request_id, $document_id, $update_document): \Yousign\Client\Model\Document

Update a Document

Updates a given Document. Any parameters not provided are left unchanged.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure Bearer authorization: bearerAuth
$config = Yousign\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Yousign\Client\Api\DocumentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$signature_request_id = 'signature_request_id_example'; // string | Signature Request Id
$document_id = 'document_id_example'; // string | Document Id
$update_document = new \Yousign\Client\Model\UpdateDocument(); // \Yousign\Client\Model\UpdateDocument

try {
    $result = $apiInstance->patchSignatureRequestsSignatureRequestIdDocumentsDocumentId($signature_request_id, $document_id, $update_document);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DocumentApi->patchSignatureRequestsSignatureRequestIdDocumentsDocumentId: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
signature_request_id	string	Signature Request Id
document_id	string	Document Id
update_document	\Yousign\Client\Model\UpdateDocument		[optional]

Return type

\Yousign\Client\Model\Document

Authorization

bearerAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`postDocuments()`

postDocuments($file, $nature, $insert_after_id, $password, $initials, $parse_anchors): \Yousign\Client\Model\Document

[DEPRECATED] Upload a Document

Deprecated endpoint, do not use.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure Bearer authorization: bearerAuth
$config = Yousign\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Yousign\Client\Api\DocumentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$file = "/path/to/file.txt"; // \SplFileObject | Binary file
$nature = 'nature_example'; // string
$insert_after_id = 'insert_after_id_example'; // string | Insert just after the position of the specified document id
$password = 'password_example'; // string
$initials = new \Yousign\Client\Model\InitialsArea(); // \Yousign\Client\Model\InitialsArea
$parse_anchors = True; // bool

try {
    $result = $apiInstance->postDocuments($file, $nature, $insert_after_id, $password, $initials, $parse_anchors);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DocumentApi->postDocuments: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
file	\SplFileObject\SplFileObject	Binary file
nature	string
insert_after_id	string	Insert just after the position of the specified document id	[optional]
password	string		[optional]
initials	\Yousign\Client\Model\InitialsArea		[optional]
parse_anchors	bool		[optional]

Return type

\Yousign\Client\Model\Document

Authorization

bearerAuth

HTTP request headers

Content-Type: multipart/form-data
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`postSignatureRequestsSignatureRequestIdDocuments()`

postSignatureRequestsSignatureRequestIdDocuments($signature_request_id, $file, $nature, $insert_after_id, $password, $initials, $parse_anchors): \Yousign\Client\Model\Document

Add Document to a Signature Request

Adds a Document to a given Signature Request.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure Bearer authorization: bearerAuth
$config = Yousign\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Yousign\Client\Api\DocumentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$signature_request_id = 'signature_request_id_example'; // string | Signature Request Id
$file = "/path/to/file.txt"; // \SplFileObject | Binary file
$nature = 'nature_example'; // string
$insert_after_id = 'insert_after_id_example'; // string | Insert just after the position of the specified document id
$password = 'password_example'; // string
$initials = new \Yousign\Client\Model\InitialsArea(); // \Yousign\Client\Model\InitialsArea
$parse_anchors = True; // bool

try {
    $result = $apiInstance->postSignatureRequestsSignatureRequestIdDocuments($signature_request_id, $file, $nature, $insert_after_id, $password, $initials, $parse_anchors);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DocumentApi->postSignatureRequestsSignatureRequestIdDocuments: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
signature_request_id	string	Signature Request Id
file	\SplFileObject\SplFileObject	Binary file
nature	string
insert_after_id	string	Insert just after the position of the specified document id	[optional]
password	string		[optional]
initials	\Yousign\Client\Model\InitialsArea		[optional]
parse_anchors	bool		[optional]

Return type

\Yousign\Client\Model\Document

Authorization

bearerAuth

HTTP request headers

Content-Type: multipart/form-data
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`postSignatureRequestsSignatureRequestIdDocumentsDocumentIdReplace()`

postSignatureRequestsSignatureRequestIdDocumentsDocumentIdReplace($signature_request_id, $document_id, $file): \Yousign\Client\Model\Document

Replace a Document in a Signature Request

Replace the file of a given Document.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure Bearer authorization: bearerAuth
$config = Yousign\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Yousign\Client\Api\DocumentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$signature_request_id = 'signature_request_id_example'; // string | Signature Request Id
$document_id = 'document_id_example'; // string | Document Id
$file = "/path/to/file.txt"; // \SplFileObject

try {
    $result = $apiInstance->postSignatureRequestsSignatureRequestIdDocumentsDocumentIdReplace($signature_request_id, $document_id, $file);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DocumentApi->postSignatureRequestsSignatureRequestIdDocumentsDocumentIdReplace: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description
signature_request_id	string	Signature Request Id
document_id	string	Document Id
file	\SplFileObject\SplFileObject

Return type

\Yousign\Client\Model\Document

Authorization

bearerAuth

HTTP request headers

Content-Type: multipart/form-data
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

DocumentApi.md

Latest commit

History

DocumentApi.md

File metadata and controls

Yousign\Client\DocumentApi

deleteSignatureRequestsSignatureRequestIdDocumentsDocumentId()

Example

Parameters

Return type

Authorization

HTTP request headers

getSignatureRequestsSignatureRequestIdDocuments()

Example

Parameters

Return type

Authorization

HTTP request headers

getSignatureRequestsSignatureRequestIdDocumentsDocumentId()

Example

Parameters

Return type

Authorization

HTTP request headers

getSignatureRequestsSignatureRequestIdDocumentsDocumentsIdDownload()

Example

Parameters

Return type

Authorization

HTTP request headers

getSignatureRequestsSignatureRequestIdDocumentsDownload()

Example

Parameters

Return type

Authorization

HTTP request headers

patchSignatureRequestsSignatureRequestIdDocumentsDocumentId()

Example

Parameters

Return type

Authorization

HTTP request headers

postDocuments()

Example

Parameters

Return type

Authorization

HTTP request headers

postSignatureRequestsSignatureRequestIdDocuments()

Example

Parameters

Return type

Authorization

HTTP request headers

postSignatureRequestsSignatureRequestIdDocumentsDocumentIdReplace()

Example

Parameters

Return type

Authorization

HTTP request headers

`deleteSignatureRequestsSignatureRequestIdDocumentsDocumentId()`

`getSignatureRequestsSignatureRequestIdDocuments()`

`getSignatureRequestsSignatureRequestIdDocumentsDocumentId()`

`getSignatureRequestsSignatureRequestIdDocumentsDocumentsIdDownload()`

`getSignatureRequestsSignatureRequestIdDocumentsDownload()`

`patchSignatureRequestsSignatureRequestIdDocumentsDocumentId()`

`postDocuments()`

`postSignatureRequestsSignatureRequestIdDocuments()`

`postSignatureRequestsSignatureRequestIdDocumentsDocumentIdReplace()`