Yousign\Client\SignerDocumentRequestApi

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

Method	HTTP request	Description
deleteSignatureRequestsSignatureRequestIdDocumentRequestsDocumentRequestId()	DELETE /signature_requests/{signatureRequestId}/document_requests/{documentRequestId}	Delete a Signer Document Request
deleteSignatureRequestsSignatureRequestIdDocumentRequestsDocumentRequestIdSignersSignerId()	DELETE /signature_requests/{signatureRequestId}/document_requests/{documentRequestId}/signers/{signerId}	Remove a Signer to a given Signer Document Request
deleteSignatureRequestsSignatureRequestIdSignersSignerIdDocuments()	DELETE /signature_requests/{signatureRequestId}/signers/{signerId}/documents	Delete the Documents uploaded by a Signer
getSignatureRequestsSignatureRequestIdSignersSignerIdDocuments()	GET /signature_requests/{signatureRequestId}/signers/{signerId}/documents	List the Signer Documents of a Signer
getSignatureRequestsSignatureRequestIdSignersSignerIdDocumentsSignerDocumentId()	GET /signature_requests/{signatureRequestId}/signers/{signerId}/documents/{signerDocumentId}/download	Download a Signer Document
postSignatureRequestsSignatureRequestIdDocumentRequests()	POST /signature_requests/{signatureRequestId}/document_requests	Add Signer Document Request to a Signature Request
putSignatureRequestsSignatureRequestIdDocumentRequestsDocumentRequestIdSignersSignerId()	PUT /signature_requests/{signatureRequestId}/document_requests/{documentRequestId}/signers/{signerId}	Adds a Signer to a given Signer Document Request

`deleteSignatureRequestsSignatureRequestIdDocumentRequestsDocumentRequestId()`

deleteSignatureRequestsSignatureRequestIdDocumentRequestsDocumentRequestId($signature_request_id, $document_request_id)

Delete a Signer Document Request

Delete a Signer Document Request from signature request. This action is only permitted when the Signature Request is a draft.

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\SignerDocumentRequestApi(
    // 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_request_id = 'document_request_id_example'; // string | Signer Document Request Id

try {
    $apiInstance->deleteSignatureRequestsSignatureRequestIdDocumentRequestsDocumentRequestId($signature_request_id, $document_request_id);
} catch (Exception $e) {
    echo 'Exception when calling SignerDocumentRequestApi->deleteSignatureRequestsSignatureRequestIdDocumentRequestsDocumentRequestId: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
signature_request_id	string	Signature Request Id
document_request_id	string	Signer Document Request 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]

`deleteSignatureRequestsSignatureRequestIdDocumentRequestsDocumentRequestIdSignersSignerId()`

deleteSignatureRequestsSignatureRequestIdDocumentRequestsDocumentRequestIdSignersSignerId($signature_request_id, $document_request_id, $signer_id)

Remove a Signer to a given Signer Document Request

Remove a Signer to a given Signer Document Request. This action is only permitted when the Signature Request is a draft.

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\SignerDocumentRequestApi(
    // 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_request_id = 'document_request_id_example'; // string | Signer Document Request Id
$signer_id = 'signer_id_example'; // string | Signer Id

try {
    $apiInstance->deleteSignatureRequestsSignatureRequestIdDocumentRequestsDocumentRequestIdSignersSignerId($signature_request_id, $document_request_id, $signer_id);
} catch (Exception $e) {
    echo 'Exception when calling SignerDocumentRequestApi->deleteSignatureRequestsSignatureRequestIdDocumentRequestsDocumentRequestIdSignersSignerId: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description
signature_request_id	string	Signature Request Id
document_request_id	string	Signer Document Request Id
signer_id	string	Signer 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]

`deleteSignatureRequestsSignatureRequestIdSignersSignerIdDocuments()`

deleteSignatureRequestsSignatureRequestIdSignersSignerIdDocuments($signature_request_id, $signer_id)

Delete the Documents uploaded by a Signer

Deletes all documents uploaded by a given Signer for a specific Signature Request. Deletion is only possible when Signer status is signed.

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\SignerDocumentRequestApi(
    // 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
$signer_id = 'signer_id_example'; // string | Signer Id

try {
    $apiInstance->deleteSignatureRequestsSignatureRequestIdSignersSignerIdDocuments($signature_request_id, $signer_id);
} catch (Exception $e) {
    echo 'Exception when calling SignerDocumentRequestApi->deleteSignatureRequestsSignatureRequestIdSignersSignerIdDocuments: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
signature_request_id	string	Signature Request Id
signer_id	string	Signer 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]

`getSignatureRequestsSignatureRequestIdSignersSignerIdDocuments()`

getSignatureRequestsSignatureRequestIdSignersSignerIdDocuments($signature_request_id, $signer_id): \Yousign\Client\Model\GetSignatureRequestsSignatureRequestIdSignersSignerIdDocuments200Response

List the Signer Documents of a Signer

Returns a list of Documents uploaded by a given Signer. Only possible when Signer status is signed.

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\SignerDocumentRequestApi(
    // 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
$signer_id = 'signer_id_example'; // string | Signer Id

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

Parameters

Name	Type	Description	Notes
signature_request_id	string	Signature Request Id
signer_id	string	Signer Id

Return type

\Yousign\Client\Model\GetSignatureRequestsSignatureRequestIdSignersSignerIdDocuments200Response

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]

`getSignatureRequestsSignatureRequestIdSignersSignerIdDocumentsSignerDocumentId()`

getSignatureRequestsSignatureRequestIdSignersSignerIdDocumentsSignerDocumentId($signature_request_id, $signer_id, $signer_document_id): \SplFileObject

Download a Signer Document

Downloads a Document uploaded by a given Signer. Only possible when Signer status is signed.

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\SignerDocumentRequestApi(
    // 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
$signer_id = 'signer_id_example'; // string | Signer Id
$signer_document_id = 'signer_document_id_example'; // string | Signer Document Id

try {
    $result = $apiInstance->getSignatureRequestsSignatureRequestIdSignersSignerIdDocumentsSignerDocumentId($signature_request_id, $signer_id, $signer_document_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SignerDocumentRequestApi->getSignatureRequestsSignatureRequestIdSignersSignerIdDocumentsSignerDocumentId: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description
signature_request_id	string	Signature Request Id
signer_id	string	Signer Id
signer_document_id	string	Signer 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]

`postSignatureRequestsSignatureRequestIdDocumentRequests()`

postSignatureRequestsSignatureRequestIdDocumentRequests($signature_request_id, $create_signer_document_request): \Yousign\Client\Model\SignerDocumentRequest

Add Signer Document Request to a Signature Request

Adds a Signer Document Request 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\SignerDocumentRequestApi(
    // 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
$create_signer_document_request = new \Yousign\Client\Model\CreateSignerDocumentRequest(); // \Yousign\Client\Model\CreateSignerDocumentRequest

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

Parameters

Name	Type	Description	Notes
signature_request_id	string	Signature Request Id
create_signer_document_request	\Yousign\Client\Model\CreateSignerDocumentRequest		[optional]

Return type

\Yousign\Client\Model\SignerDocumentRequest

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]

`putSignatureRequestsSignatureRequestIdDocumentRequestsDocumentRequestIdSignersSignerId()`

putSignatureRequestsSignatureRequestIdDocumentRequestsDocumentRequestIdSignersSignerId($signature_request_id, $document_request_id, $signer_id): \Yousign\Client\Model\SignerDocumentRequest

Adds a Signer to a given Signer Document Request

Adds a Signer to a given Signer Document Request. This action is only permitted when the Signature Request is a draft.

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\SignerDocumentRequestApi(
    // 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_request_id = 'document_request_id_example'; // string | Signer Document Request Id
$signer_id = 'signer_id_example'; // string | Signer Id

try {
    $result = $apiInstance->putSignatureRequestsSignatureRequestIdDocumentRequestsDocumentRequestIdSignersSignerId($signature_request_id, $document_request_id, $signer_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SignerDocumentRequestApi->putSignatureRequestsSignatureRequestIdDocumentRequestsDocumentRequestIdSignersSignerId: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description
signature_request_id	string	Signature Request Id
document_request_id	string	Signer Document Request Id
signer_id	string	Signer Id

Return type

\Yousign\Client\Model\SignerDocumentRequest

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]

Files

SignerDocumentRequestApi.md

Latest commit

History

SignerDocumentRequestApi.md

File metadata and controls

Yousign\Client\SignerDocumentRequestApi

deleteSignatureRequestsSignatureRequestIdDocumentRequestsDocumentRequestId()

Example

Parameters

Return type

Authorization

HTTP request headers

deleteSignatureRequestsSignatureRequestIdDocumentRequestsDocumentRequestIdSignersSignerId()

Example

Parameters

Return type

Authorization

HTTP request headers

deleteSignatureRequestsSignatureRequestIdSignersSignerIdDocuments()

Example

Parameters

Return type

Authorization

HTTP request headers

getSignatureRequestsSignatureRequestIdSignersSignerIdDocuments()

Example

Parameters

Return type

Authorization

HTTP request headers

getSignatureRequestsSignatureRequestIdSignersSignerIdDocumentsSignerDocumentId()

Example

Parameters

Return type

Authorization

HTTP request headers

postSignatureRequestsSignatureRequestIdDocumentRequests()

Example

Parameters

Return type

Authorization

HTTP request headers

putSignatureRequestsSignatureRequestIdDocumentRequestsDocumentRequestIdSignersSignerId()

Example

Parameters

Return type

Authorization

HTTP request headers

`deleteSignatureRequestsSignatureRequestIdDocumentRequestsDocumentRequestId()`

`deleteSignatureRequestsSignatureRequestIdDocumentRequestsDocumentRequestIdSignersSignerId()`

`deleteSignatureRequestsSignatureRequestIdSignersSignerIdDocuments()`

`getSignatureRequestsSignatureRequestIdSignersSignerIdDocuments()`

`getSignatureRequestsSignatureRequestIdSignersSignerIdDocumentsSignerDocumentId()`

`postSignatureRequestsSignatureRequestIdDocumentRequests()`

`putSignatureRequestsSignatureRequestIdDocumentRequestsDocumentRequestIdSignersSignerId()`