Yousign\Client\SignatureRequestApi

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

Method	HTTP request	Description
deleteSignatureRequestsSignatureRequestId()	DELETE /signature_requests/{signatureRequestId}	Delete a Signature Request
getSignatureRequests()	GET /signature_requests	List Signature Requests
getSignatureRequestsSignatureRequestId()	GET /signature_requests/{signatureRequestId}	Fetch a Signature Request
patchSignatureRequestsSignatureRequestId()	PATCH /signature_requests/{signatureRequestId}	Update a Signature Request
postSignatureRequests()	POST /signature_requests	Initiate a new Signature Request
postSignatureRequestsSignatureRequestIdActivate()	POST /signature_requests/{signatureRequestId}/activate	Activate a Signature Request
postSignatureRequestsSignatureRequestIdCancel()	POST /signature_requests/{signatureRequestId}/cancel	Cancel a Signature Request
postSignatureRequestsSignatureRequestIdReactivate()	POST /signature_requests/{signatureRequestId}/reactivate	Reactivate an expired Signature Request

`deleteSignatureRequestsSignatureRequestId()`

deleteSignatureRequestsSignatureRequestId($signature_request_id, $permanent_delete)

Delete a Signature Request

Deletes a given Signature Request, not possible if the Signature Request is in approval and ongoing status.

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\SignatureRequestApi(
    // 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
$permanent_delete = false; // bool | If true it will permanently delete the Signature Request. It will no longer be retrievable.

try {
    $apiInstance->deleteSignatureRequestsSignatureRequestId($signature_request_id, $permanent_delete);
} catch (Exception $e) {
    echo 'Exception when calling SignatureRequestApi->deleteSignatureRequestsSignatureRequestId: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
signature_request_id	string	Signature Request Id
permanent_delete	bool	If true it will permanently delete the Signature Request. It will no longer be retrievable.	[optional] [default to false]

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]

`getSignatureRequests()`

getSignatureRequests($status, $after, $limit, $external_id, $source, $q): \Yousign\Client\Model\GetSignatureRequests200Response

List Signature Requests

Returns the list of all Signatures Requests in your organization. You can limit the number of items returned by using filters and pagination.

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\SignatureRequestApi(
    // 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
);
$status = 'status_example'; // string | Filter by status
$after = 'after_example'; // string | After cursor (pagination)
$limit = 100; // int | The limit of items count to retrieve.
$external_id = an_external_id; // string | Filter by external_id
$source = array('source_example'); // string[] | Filter by source
$q = 'q_example'; // string | Search on name

try {
    $result = $apiInstance->getSignatureRequests($status, $after, $limit, $external_id, $source, $q);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SignatureRequestApi->getSignatureRequests: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
status	string	Filter by status	[optional]
after	string	After cursor (pagination)	[optional]
limit	int	The limit of items count to retrieve.	[optional] [default to 100]
external_id	string	Filter by external_id	[optional]
source	string[]	Filter by source	[optional]
q	string	Search on name	[optional]

Return type

\Yousign\Client\Model\GetSignatureRequests200Response

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]

`getSignatureRequestsSignatureRequestId()`

getSignatureRequestsSignatureRequestId($signature_request_id): \Yousign\Client\Model\SignatureRequest

Fetch a Signature Request

Retrieves 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\SignatureRequestApi(
    // 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

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

Parameters

Name	Type	Description	Notes
signature_request_id	string	Signature Request Id

Return type

\Yousign\Client\Model\SignatureRequest

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]

`patchSignatureRequestsSignatureRequestId()`

patchSignatureRequestsSignatureRequestId($signature_request_id, $update_signature_request): \Yousign\Client\Model\SignatureRequest

Update a Signature Request

Updates a given Signature Request. 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\SignatureRequestApi(
    // 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
$update_signature_request = new \Yousign\Client\Model\UpdateSignatureRequest(); // \Yousign\Client\Model\UpdateSignatureRequest

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

Parameters

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

Return type

\Yousign\Client\Model\SignatureRequest

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]

`postSignatureRequests()`

postSignatureRequests($create_signature_request): \Yousign\Client\Model\SignatureRequest

Initiate a new Signature Request

Creates a new Signature Request resource.

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\SignatureRequestApi(
    // 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
);
$create_signature_request = new \Yousign\Client\Model\CreateSignatureRequest(); // \Yousign\Client\Model\CreateSignatureRequest

try {
    $result = $apiInstance->postSignatureRequests($create_signature_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SignatureRequestApi->postSignatureRequests: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
create_signature_request	\Yousign\Client\Model\CreateSignatureRequest		[optional]

Return type

\Yousign\Client\Model\SignatureRequest

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]

`postSignatureRequestsSignatureRequestIdActivate()`

postSignatureRequestsSignatureRequestIdActivate($signature_request_id): \Yousign\Client\Model\SignatureRequestActivated

Activate a Signature Request

Activates a Signature request, so it is not in draft status anymore. If the delivery_mode is not null, activating the Signature Request will trigger the notifications to Approvers/Followers/Signers.

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\SignatureRequestApi(
    // 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

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

Parameters

Name	Type	Description	Notes
signature_request_id	string	Signature Request Id

Return type

\Yousign\Client\Model\SignatureRequestActivated

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]

`postSignatureRequestsSignatureRequestIdCancel()`

postSignatureRequestsSignatureRequestIdCancel($signature_request_id, $post_signature_requests_signature_request_id_cancel_request): \Yousign\Client\Model\SignatureRequest

Cancel a Signature Request

Cancels a Signature Request when it is in approval or ongoing status. A canceled Signature Request cannot be reactivated.

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\SignatureRequestApi(
    // 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
$post_signature_requests_signature_request_id_cancel_request = new \Yousign\Client\Model\PostSignatureRequestsSignatureRequestIdCancelRequest(); // \Yousign\Client\Model\PostSignatureRequestsSignatureRequestIdCancelRequest

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

Parameters

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

Return type

\Yousign\Client\Model\SignatureRequest

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]

`postSignatureRequestsSignatureRequestIdReactivate()`

postSignatureRequestsSignatureRequestIdReactivate($signature_request_id, $post_signature_requests_signature_request_id_reactivate_request): \Yousign\Client\Model\SignatureRequest

Reactivate an expired Signature Request

Reactivates a Signature Request when it is in expired status.

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\SignatureRequestApi(
    // 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
$post_signature_requests_signature_request_id_reactivate_request = new \Yousign\Client\Model\PostSignatureRequestsSignatureRequestIdReactivateRequest(); // \Yousign\Client\Model\PostSignatureRequestsSignatureRequestIdReactivateRequest

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

Parameters

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

Return type

\Yousign\Client\Model\SignatureRequest

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]

Files

SignatureRequestApi.md

Latest commit

History

SignatureRequestApi.md

File metadata and controls

Yousign\Client\SignatureRequestApi

deleteSignatureRequestsSignatureRequestId()

Example

Parameters

Return type

Authorization

HTTP request headers

getSignatureRequests()

Example

Parameters

Return type

Authorization

HTTP request headers

getSignatureRequestsSignatureRequestId()

Example

Parameters

Return type

Authorization

HTTP request headers

patchSignatureRequestsSignatureRequestId()

Example

Parameters

Return type

Authorization

HTTP request headers

postSignatureRequests()

Example

Parameters

Return type

Authorization

HTTP request headers

postSignatureRequestsSignatureRequestIdActivate()

Example

Parameters

Return type

Authorization

HTTP request headers

postSignatureRequestsSignatureRequestIdCancel()

Example

Parameters

Return type

Authorization

HTTP request headers

postSignatureRequestsSignatureRequestIdReactivate()

Example

Parameters

Return type

Authorization

HTTP request headers

`deleteSignatureRequestsSignatureRequestId()`

`getSignatureRequests()`

`getSignatureRequestsSignatureRequestId()`

`patchSignatureRequestsSignatureRequestId()`

`postSignatureRequests()`

`postSignatureRequestsSignatureRequestIdActivate()`

`postSignatureRequestsSignatureRequestIdCancel()`

`postSignatureRequestsSignatureRequestIdReactivate()`