BoldSign\DocumentApi

All URIs are relative to https://api.boldsign.com, except if the operation defines another base path.

Method	HTTP request	Description
addAuthentication()	PATCH /v1/document/addAuthentication	The add authentication to recipient.
addTag()	PATCH /v1/document/addTags	Add the Tags in Documents.
behalfDocuments()	GET /v1/document/behalfList	Gets the behalf documents.
changeAccessCode()	PATCH /v1/document/changeAccessCode	Changes the access code for the given document signer.
changeRecipient()	PATCH /v1/document/changeRecipient	Change recipient details of a document.
createEmbeddedRequestUrlDocument()	POST /v1/document/createEmbeddedRequestUrl	Generates a send URL which embeds document sending process into your application.
deleteDocument()	DELETE /v1/document/delete	Delete the document.
deleteTag()	DELETE /v1/document/deleteTags	Delete the Tags in Documents.
downloadAttachment()	GET /v1/document/downloadAttachment	Download the Attachment.
downloadAuditLog()	GET /v1/document/downloadAuditLog	Download the audit trail document.
downloadDocument()	GET /v1/document/download	Download the document.
extendExpiry()	PATCH /v1/document/extendExpiry	Extends the expiration date of the document.
getEmbeddedSignLink()	GET /v1/document/getEmbeddedSignLink	Get sign link for Embedded Sign.
getProperties()	GET /v1/document/properties	Get summary of the document.
listDocuments()	GET /v1/document/list	List user documents.
prefillFields()	PATCH /v1/document/prefillFields	Updates the value (prefill) of the fields in the document.
remindDocument()	POST /v1/document/remind	Send reminder to pending signers.
removeAuthentication()	PATCH /v1/document/RemoveAuthentication	Remove the access code for the given document signer.
revokeDocument()	POST /v1/document/revoke	Revoke the document.
sendDocument()	POST /v1/document/send	Sends the document for sign.
teamDocuments()	GET /v1/document/teamlist	Get user Team documents.

`addAuthentication()`

addAuthentication($document_id, $access_code_detail)

The add authentication to recipient.

Example

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


// Configure API key authorization: X-API-KEY
$config = BoldSign\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = BoldSign\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

// Configure API key authorization: Bearer
$config = BoldSign\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = BoldSign\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new BoldSign\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
);
$document_id = 'document_id_example'; // string | The DocumentId.
$access_code_detail = new \BoldSign\Model\AccessCodeDetail(); // \BoldSign\Model\AccessCodeDetail | Access code details.

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

Parameters

Name	Type	Description	Notes
document_id	string	The DocumentId.
access_code_detail	\BoldSign\Model\AccessCodeDetail	Access code details.	[optional]

Return type

void (empty response body)

Authorization

X-API-KEY, Bearer

HTTP request headers

Content-Type: application/json;odata.metadata=minimal;odata.streaming=true, application/json;odata.metadata=minimal;odata.streaming=false, application/json;odata.metadata=minimal, application/json;odata.metadata=full;odata.streaming=true, application/json;odata.metadata=full;odata.streaming=false, application/json;odata.metadata=full, application/json;odata.metadata=none;odata.streaming=true, application/json;odata.metadata=none;odata.streaming=false, application/json;odata.metadata=none, application/json;odata.streaming=true, application/json;odata.streaming=false, application/json, application/xml, application/prs.odatatestxx-odata, application/json-patch+json, text/json, application/*+json
Accept: application/json

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

`addTag()`

addTag($document_tags)

Add the Tags in Documents.

Example

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


// Configure API key authorization: X-API-KEY
$config = BoldSign\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = BoldSign\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

// Configure API key authorization: Bearer
$config = BoldSign\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = BoldSign\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new BoldSign\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
);
$document_tags = new \BoldSign\Model\DocumentTags(); // \BoldSign\Model\DocumentTags | Contains DocumentId and LabelNames for Adding Tags.

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

Parameters

Name	Type	Description	Notes
document_tags	\BoldSign\Model\DocumentTags	Contains DocumentId and LabelNames for Adding Tags.	[optional]

Return type

void (empty response body)

Authorization

X-API-KEY, Bearer

HTTP request headers

Content-Type: application/json;odata.metadata=minimal;odata.streaming=true, application/json;odata.metadata=minimal;odata.streaming=false, application/json;odata.metadata=minimal, application/json;odata.metadata=full;odata.streaming=true, application/json;odata.metadata=full;odata.streaming=false, application/json;odata.metadata=full, application/json;odata.metadata=none;odata.streaming=true, application/json;odata.metadata=none;odata.streaming=false, application/json;odata.metadata=none, application/json;odata.streaming=true, application/json;odata.streaming=false, application/json, application/xml, application/prs.odatatestxx-odata, application/json-patch+json, text/json, application/*+json
Accept: application/json;odata.metadata=minimal;odata.streaming=true, application/json;odata.metadata=minimal;odata.streaming=false, application/json;odata.metadata=minimal, application/json;odata.metadata=full;odata.streaming=true, application/json;odata.metadata=full;odata.streaming=false, application/json;odata.metadata=full, application/json;odata.metadata=none;odata.streaming=true, application/json;odata.metadata=none;odata.streaming=false, application/json;odata.metadata=none, application/json;odata.streaming=true, application/json;odata.streaming=false, application/json, application/xml, application/prs.odatatestxx-odata, text/plain, text/json

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

`behalfDocuments()`

behalfDocuments($page, $page_type, $email_address, $signers, $page_size, $start_date, $status, $end_date, $search_key, $labels, $next_cursor, $brand_ids): \BoldSign\Model\BehalfDocumentRecords

Gets the behalf documents.

Example

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


// Configure API key authorization: X-API-KEY
$config = BoldSign\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = BoldSign\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

// Configure API key authorization: Bearer
$config = BoldSign\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = BoldSign\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new BoldSign\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
);
$page = 1; // int | Page index specified in get document list request.
$page_type = 'page_type_example'; // string | The filter used to differentiate between documents sent on the user's behalf and documents sent by the user on behalf of others. The API will return documents based on the specified value.
$email_address = array('email_address_example'); // string[] | The sender identity's email used to filter the documents returned in the API. The API will return documents that were sent on behalf of the specified email address.
$signers = array('signers_example'); // string[] | A list of signer email addresses used to filter the documents returned in the API. The API will return documents where the signer's email address matches one of the email addresses provided in this list
$page_size = 10; // int | Page size specified in get document list request.
$start_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | Start date of the document
$status = array('status_example'); // string[] | Status of the document such as In-progress, Completed, Decline, Expired, Revoked, Draft.
$end_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | End date of the document
$search_key = 'search_key_example'; // string | Documents can be listed by the search key present in the document like document title, document ID, sender or recipient(s) name, etc.,
$labels = array('labels_example'); // string[] | Labels of the document.
$next_cursor = 56; // int | Next cursor value for pagination, required for fetching the next set of documents beyond 10,000 records.
$brand_ids = array('brand_ids_example'); // string[] | BrandId(s) of the document.

try {
    $result = $apiInstance->behalfDocuments($page, $page_type, $email_address, $signers, $page_size, $start_date, $status, $end_date, $search_key, $labels, $next_cursor, $brand_ids);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DocumentApi->behalfDocuments: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
page	int	Page index specified in get document list request.	[default to 1]
page_type	string	The filter used to differentiate between documents sent on the user's behalf and documents sent by the user on behalf of others. The API will return documents based on the specified value.	[optional]
email_address	string[]	The sender identity's email used to filter the documents returned in the API. The API will return documents that were sent on behalf of the specified email address.	[optional]
signers	string[]	A list of signer email addresses used to filter the documents returned in the API. The API will return documents where the signer's email address matches one of the email addresses provided in this list	[optional]
page_size	int	Page size specified in get document list request.	[optional] [default to 10]
start_date	\DateTime	Start date of the document	[optional]
status	string[]	Status of the document such as In-progress, Completed, Decline, Expired, Revoked, Draft.	[optional]
end_date	\DateTime	End date of the document	[optional]
search_key	string	Documents can be listed by the search key present in the document like document title, document ID, sender or recipient(s) name, etc.,	[optional]
labels	string[]	Labels of the document.	[optional]
next_cursor	int	Next cursor value for pagination, required for fetching the next set of documents beyond 10,000 records.	[optional]
brand_ids	string[]	BrandId(s) of the document.	[optional]

Return type

\BoldSign\Model\BehalfDocumentRecords

Authorization

X-API-KEY, Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`changeAccessCode()`

changeAccessCode($document_id, $access_code_details, $email_id, $z_order)

Changes the access code for the given document signer.

Example

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


// Configure API key authorization: X-API-KEY
$config = BoldSign\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = BoldSign\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

// Configure API key authorization: Bearer
$config = BoldSign\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = BoldSign\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new BoldSign\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
);
$document_id = 'document_id_example'; // string
$access_code_details = new \BoldSign\Model\AccessCodeDetails(); // \BoldSign\Model\AccessCodeDetails | The new access code.
$email_id = 'email_id_example'; // string
$z_order = 56; // int

try {
    $apiInstance->changeAccessCode($document_id, $access_code_details, $email_id, $z_order);
} catch (Exception $e) {
    echo 'Exception when calling DocumentApi->changeAccessCode: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
document_id	string
access_code_details	\BoldSign\Model\AccessCodeDetails	The new access code.
email_id	string		[optional]
z_order	int		[optional]

Return type

void (empty response body)

Authorization

X-API-KEY, Bearer

HTTP request headers

Content-Type: application/json;odata.metadata=minimal;odata.streaming=true, application/json;odata.metadata=minimal;odata.streaming=false, application/json;odata.metadata=minimal, application/json;odata.metadata=full;odata.streaming=true, application/json;odata.metadata=full;odata.streaming=false, application/json;odata.metadata=full, application/json;odata.metadata=none;odata.streaming=true, application/json;odata.metadata=none;odata.streaming=false, application/json;odata.metadata=none, application/json;odata.streaming=true, application/json;odata.streaming=false, application/json, application/xml, application/prs.odatatestxx-odata, application/json-patch+json, text/json, application/*+json
Accept: application/json;odata.metadata=minimal;odata.streaming=true, application/json;odata.metadata=minimal;odata.streaming=false, application/json;odata.metadata=minimal, application/json;odata.metadata=full;odata.streaming=true, application/json;odata.metadata=full;odata.streaming=false, application/json;odata.metadata=full, application/json;odata.metadata=none;odata.streaming=true, application/json;odata.metadata=none;odata.streaming=false, application/json;odata.metadata=none, application/json;odata.streaming=true, application/json;odata.streaming=false, application/json, application/xml, application/prs.odatatestxx-odata, text/plain, text/json

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

`changeRecipient()`

changeRecipient($document_id, $change_recipient): \BoldSign\Model\ErrorResult

Change recipient details of a document.

Example

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


// Configure API key authorization: X-API-KEY
$config = BoldSign\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = BoldSign\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

// Configure API key authorization: Bearer
$config = BoldSign\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = BoldSign\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new BoldSign\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
);
$document_id = 'document_id_example'; // string | The documentID details.
$change_recipient = new \BoldSign\Model\ChangeRecipient(); // \BoldSign\Model\ChangeRecipient | The new recipient details.

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

Parameters

Name	Type	Description	Notes
document_id	string	The documentID details.
change_recipient	\BoldSign\Model\ChangeRecipient	The new recipient details.

Return type

\BoldSign\Model\ErrorResult

Authorization

X-API-KEY, Bearer

HTTP request headers

Content-Type: application/json;odata.metadata=minimal;odata.streaming=true, application/json;odata.metadata=minimal;odata.streaming=false, application/json;odata.metadata=minimal, application/json;odata.metadata=full;odata.streaming=true, application/json;odata.metadata=full;odata.streaming=false, application/json;odata.metadata=full, application/json;odata.metadata=none;odata.streaming=true, application/json;odata.metadata=none;odata.streaming=false, application/json;odata.metadata=none, application/json;odata.streaming=true, application/json;odata.streaming=false, application/json, application/xml, application/prs.odatatestxx-odata, application/json-patch+json, text/json, application/*+json
Accept: application/json;odata.metadata=minimal;odata.streaming=true, application/json;odata.metadata=minimal;odata.streaming=false, application/json;odata.metadata=minimal, application/json;odata.metadata=full;odata.streaming=true, application/json;odata.metadata=full;odata.streaming=false, application/json;odata.metadata=full, application/json;odata.metadata=none;odata.streaming=true, application/json;odata.metadata=none;odata.streaming=false, application/json;odata.metadata=none, application/json;odata.streaming=true, application/json;odata.streaming=false, application/json, application/xml, application/prs.odatatestxx-odata, text/plain, text/json

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

`createEmbeddedRequestUrlDocument()`

createEmbeddedRequestUrlDocument($embedded_document_request): \BoldSign\Model\EmbeddedSendCreated

Generates a send URL which embeds document sending process into your application.

Example

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


// Configure API key authorization: X-API-KEY
$config = BoldSign\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = BoldSign\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

// Configure API key authorization: Bearer
$config = BoldSign\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = BoldSign\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new BoldSign\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
);
$embedded_document_request = new \BoldSign\Model\EmbeddedDocumentRequest(); // \BoldSign\Model\EmbeddedDocumentRequest | The embedded send document request body.

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

Parameters

Name	Type	Description	Notes
embedded_document_request	\BoldSign\Model\EmbeddedDocumentRequest	The embedded send document request body.	[optional]

Return type

\BoldSign\Model\EmbeddedSendCreated

Authorization

X-API-KEY, Bearer

HTTP request headers

Content-Type: application/json, multipart/form-data, application/x-www-form-urlencoded
Accept: application/json

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

`deleteDocument()`

deleteDocument($document_id, $delete_permanently)

Delete the document.

Example

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


// Configure API key authorization: X-API-KEY
$config = BoldSign\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = BoldSign\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

// Configure API key authorization: Bearer
$config = BoldSign\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = BoldSign\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new BoldSign\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
);
$document_id = 'document_id_example'; // string | Document Id.
$delete_permanently = false; // bool | Delete Permanently.

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

Parameters

Name	Type	Description	Notes
document_id	string	Document Id.
delete_permanently	bool	Delete Permanently.	[optional] [default to false]

Return type

void (empty response body)

Authorization

X-API-KEY, Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json;odata.metadata=minimal;odata.streaming=true, application/json;odata.metadata=minimal;odata.streaming=false, application/json;odata.metadata=minimal, application/json;odata.metadata=full;odata.streaming=true, application/json;odata.metadata=full;odata.streaming=false, application/json;odata.metadata=full, application/json;odata.metadata=none;odata.streaming=true, application/json;odata.metadata=none;odata.streaming=false, application/json;odata.metadata=none, application/json;odata.streaming=true, application/json;odata.streaming=false, application/json, application/xml, application/prs.odatatestxx-odata, text/plain, text/json

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

`deleteTag()`

deleteTag($document_tags)

Delete the Tags in Documents.

Example

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


// Configure API key authorization: X-API-KEY
$config = BoldSign\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = BoldSign\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

// Configure API key authorization: Bearer
$config = BoldSign\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = BoldSign\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new BoldSign\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
);
$document_tags = new \BoldSign\Model\DocumentTags(); // \BoldSign\Model\DocumentTags | Contains DocumentId and LabelNames for Adding Tags.

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

Parameters

Name	Type	Description	Notes
document_tags	\BoldSign\Model\DocumentTags	Contains DocumentId and LabelNames for Adding Tags.	[optional]

Return type

void (empty response body)

Authorization

X-API-KEY, Bearer

HTTP request headers

Content-Type: application/json;odata.metadata=minimal;odata.streaming=true, application/json;odata.metadata=minimal;odata.streaming=false, application/json;odata.metadata=minimal, application/json;odata.metadata=full;odata.streaming=true, application/json;odata.metadata=full;odata.streaming=false, application/json;odata.metadata=full, application/json;odata.metadata=none;odata.streaming=true, application/json;odata.metadata=none;odata.streaming=false, application/json;odata.metadata=none, application/json;odata.streaming=true, application/json;odata.streaming=false, application/json, application/xml, application/prs.odatatestxx-odata, application/json-patch+json, text/json, application/*+json
Accept: application/json;odata.metadata=minimal;odata.streaming=true, application/json;odata.metadata=minimal;odata.streaming=false, application/json;odata.metadata=minimal, application/json;odata.metadata=full;odata.streaming=true, application/json;odata.metadata=full;odata.streaming=false, application/json;odata.metadata=full, application/json;odata.metadata=none;odata.streaming=true, application/json;odata.metadata=none;odata.streaming=false, application/json;odata.metadata=none, application/json;odata.streaming=true, application/json;odata.streaming=false, application/json, application/xml, application/prs.odatatestxx-odata, text/plain, text/json

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

`downloadAttachment()`

downloadAttachment($document_id, $attachment_id, $on_behalf_of): \SplFileObject

Download the Attachment.

Example

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


// Configure API key authorization: X-API-KEY
$config = BoldSign\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = BoldSign\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

// Configure API key authorization: Bearer
$config = BoldSign\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = BoldSign\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new BoldSign\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
);
$document_id = 'document_id_example'; // string | Document Id.
$attachment_id = 'attachment_id_example'; // string | Attachment Id(Get attachment ID from Properties API).
$on_behalf_of = 'on_behalf_of_example'; // string | The on behalfof email address.

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

Parameters

Name	Type	Description	Notes
document_id	string	Document Id.
attachment_id	string	Attachment Id(Get attachment ID from Properties API).
on_behalf_of	string	The on behalfof email address.	[optional]

Return type

\SplFileObject

Authorization

X-API-KEY, Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json;odata.metadata=minimal;odata.streaming=true, application/json;odata.metadata=minimal;odata.streaming=false, application/json;odata.metadata=minimal, application/json;odata.metadata=full;odata.streaming=true, application/json;odata.metadata=full;odata.streaming=false, application/json;odata.metadata=full, application/json;odata.metadata=none;odata.streaming=true, application/json;odata.metadata=none;odata.streaming=false, application/json;odata.metadata=none, application/json;odata.streaming=true, application/json;odata.streaming=false, application/json, application/xml, application/prs.odatatestxx-odata, text/plain, text/json

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

`downloadAuditLog()`

downloadAuditLog($document_id, $on_behalf_of): \SplFileObject

Download the audit trail document.

Example

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


// Configure API key authorization: X-API-KEY
$config = BoldSign\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = BoldSign\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

// Configure API key authorization: Bearer
$config = BoldSign\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = BoldSign\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new BoldSign\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
);
$document_id = 'document_id_example'; // string | Document Id.
$on_behalf_of = 'on_behalf_of_example'; // string | The on behalfof email address.

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

Parameters

Name	Type	Description	Notes
document_id	string	Document Id.
on_behalf_of	string	The on behalfof email address.	[optional]

Return type

\SplFileObject

Authorization

X-API-KEY, Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json;odata.metadata=minimal;odata.streaming=true, application/json;odata.metadata=minimal;odata.streaming=false, application/json;odata.metadata=minimal, application/json;odata.metadata=full;odata.streaming=true, application/json;odata.metadata=full;odata.streaming=false, application/json;odata.metadata=full, application/json;odata.metadata=none;odata.streaming=true, application/json;odata.metadata=none;odata.streaming=false, application/json;odata.metadata=none, application/json;odata.streaming=true, application/json;odata.streaming=false, application/json, application/xml, application/prs.odatatestxx-odata, text/plain, text/json

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

`downloadDocument()`

downloadDocument($document_id, $on_behalf_of): \SplFileObject

Download the document.

Example

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


// Configure API key authorization: X-API-KEY
$config = BoldSign\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = BoldSign\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

// Configure API key authorization: Bearer
$config = BoldSign\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = BoldSign\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new BoldSign\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
);
$document_id = 'document_id_example'; // string | Document Id.
$on_behalf_of = 'on_behalf_of_example'; // string | The on behalfof email address.

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

Parameters

Name	Type	Description	Notes
document_id	string	Document Id.
on_behalf_of	string	The on behalfof email address.	[optional]

Return type

\SplFileObject

Authorization

X-API-KEY, Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json;odata.metadata=minimal;odata.streaming=true, application/json;odata.metadata=minimal;odata.streaming=false, application/json;odata.metadata=minimal, application/json;odata.metadata=full;odata.streaming=true, application/json;odata.metadata=full;odata.streaming=false, application/json;odata.metadata=full, application/json;odata.metadata=none;odata.streaming=true, application/json;odata.metadata=none;odata.streaming=false, application/json;odata.metadata=none, application/json;odata.streaming=true, application/json;odata.streaming=false, application/json, application/xml, application/prs.odatatestxx-odata, text/plain, text/json

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

`extendExpiry()`

extendExpiry($document_id, $extend_expiry)

Extends the expiration date of the document.

Example

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


// Configure API key authorization: X-API-KEY
$config = BoldSign\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = BoldSign\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

// Configure API key authorization: Bearer
$config = BoldSign\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = BoldSign\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new BoldSign\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
);
$document_id = 'document_id_example'; // string | Document Id.
$extend_expiry = new \BoldSign\Model\ExtendExpiry(); // \BoldSign\Model\ExtendExpiry | The new expiry value should be specified in yyyy-MM-dd format for days type, ISO date time format for specific date time and integer for hours type.

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

Parameters

Name	Type	Description	Notes
document_id	string	Document Id.
extend_expiry	\BoldSign\Model\ExtendExpiry	The new expiry value should be specified in yyyy-MM-dd format for days type, ISO date time format for specific date time and integer for hours type.	[optional]

Return type

void (empty response body)

Authorization

X-API-KEY, Bearer

HTTP request headers

Content-Type: application/json;odata.metadata=minimal;odata.streaming=true, application/json;odata.metadata=minimal;odata.streaming=false, application/json;odata.metadata=minimal, application/json;odata.metadata=full;odata.streaming=true, application/json;odata.metadata=full;odata.streaming=false, application/json;odata.metadata=full, application/json;odata.metadata=none;odata.streaming=true, application/json;odata.metadata=none;odata.streaming=false, application/json;odata.metadata=none, application/json;odata.streaming=true, application/json;odata.streaming=false, application/json, application/xml, application/prs.odatatestxx-odata, application/json-patch+json, text/json, application/*+json
Accept: application/json;odata.metadata=minimal;odata.streaming=true, application/json;odata.metadata=minimal;odata.streaming=false, application/json;odata.metadata=minimal, application/json;odata.metadata=full;odata.streaming=true, application/json;odata.metadata=full;odata.streaming=false, application/json;odata.metadata=full, application/json;odata.metadata=none;odata.streaming=true, application/json;odata.metadata=none;odata.streaming=false, application/json;odata.metadata=none, application/json;odata.streaming=true, application/json;odata.streaming=false, application/json, application/xml, application/prs.odatatestxx-odata, text/plain, text/json

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

`getEmbeddedSignLink()`

getEmbeddedSignLink($document_id, $signer_email, $country_code, $phone_number, $sign_link_valid_till, $redirect_url): \BoldSign\Model\EmbeddedSigningLink

Get sign link for Embedded Sign.

Example

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


// Configure API key authorization: X-API-KEY
$config = BoldSign\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = BoldSign\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

// Configure API key authorization: Bearer
$config = BoldSign\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = BoldSign\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new BoldSign\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
);
$document_id = 'document_id_example'; // string
$signer_email = 'signer_email_example'; // string
$country_code = 'country_code_example'; // string
$phone_number = 'phone_number_example'; // string
$sign_link_valid_till = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime
$redirect_url = 'redirect_url_example'; // string

try {
    $result = $apiInstance->getEmbeddedSignLink($document_id, $signer_email, $country_code, $phone_number, $sign_link_valid_till, $redirect_url);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DocumentApi->getEmbeddedSignLink: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Notes
document_id	string
signer_email	string	[optional]
country_code	string	[optional]
phone_number	string	[optional]
sign_link_valid_till	\DateTime	[optional]
redirect_url	string	[optional]

Return type

\BoldSign\Model\EmbeddedSigningLink

Authorization

X-API-KEY, Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json;odata.metadata=minimal;odata.streaming=true, application/json;odata.metadata=minimal;odata.streaming=false, application/json;odata.metadata=minimal, application/json;odata.metadata=full;odata.streaming=true, application/json;odata.metadata=full;odata.streaming=false, application/json;odata.metadata=full, application/json;odata.metadata=none;odata.streaming=true, application/json;odata.metadata=none;odata.streaming=false, application/json;odata.metadata=none, application/json;odata.streaming=true, application/json;odata.streaming=false, application/json, application/xml, application/prs.odatatestxx-odata, text/plain, text/json

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

`getProperties()`

getProperties($document_id): \BoldSign\Model\DocumentProperties

Get summary of the document.

Example

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


// Configure API key authorization: X-API-KEY
$config = BoldSign\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = BoldSign\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

// Configure API key authorization: Bearer
$config = BoldSign\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = BoldSign\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new BoldSign\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
);
$document_id = 'document_id_example'; // string | Document Id.

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

Parameters

Name	Type	Description	Notes
document_id	string	Document Id.

Return type

\BoldSign\Model\DocumentProperties

Authorization

X-API-KEY, Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`listDocuments()`

listDocuments($page, $sent_by, $recipients, $transmit_type, $page_size, $start_date, $status, $end_date, $search_key, $labels, $next_cursor, $brand_ids): \BoldSign\Model\DocumentRecords

List user documents.

Example

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


// Configure API key authorization: X-API-KEY
$config = BoldSign\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = BoldSign\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

// Configure API key authorization: Bearer
$config = BoldSign\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = BoldSign\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new BoldSign\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
);
$page = 1; // int | Page index specified in get document list request.
$sent_by = array('sent_by_example'); // string[]
$recipients = array('recipients_example'); // string[]
$transmit_type = 'transmit_type_example'; // string
$page_size = 10; // int | Page size specified in get document list request.
$start_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | Start date of the document
$status = array('status_example'); // string[] | Status of the document such as In-progress, Completed, Decline, Expired, Revoked, Draft.
$end_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | End date of the document
$search_key = 'search_key_example'; // string | Documents can be listed by the search key present in the document like document title, document ID, sender or recipient(s) name, etc.,
$labels = array('labels_example'); // string[] | Labels of the document.
$next_cursor = 56; // int | Next cursor value for pagination, required for fetching the next set of documents beyond 10,000 records.
$brand_ids = array('brand_ids_example'); // string[] | BrandId(s) of the document.

try {
    $result = $apiInstance->listDocuments($page, $sent_by, $recipients, $transmit_type, $page_size, $start_date, $status, $end_date, $search_key, $labels, $next_cursor, $brand_ids);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DocumentApi->listDocuments: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
page	int	Page index specified in get document list request.	[default to 1]
sent_by	string[]		[optional]
recipients	string[]		[optional]
transmit_type	string		[optional]
page_size	int	Page size specified in get document list request.	[optional] [default to 10]
start_date	\DateTime	Start date of the document	[optional]
status	string[]	Status of the document such as In-progress, Completed, Decline, Expired, Revoked, Draft.	[optional]
end_date	\DateTime	End date of the document	[optional]
search_key	string	Documents can be listed by the search key present in the document like document title, document ID, sender or recipient(s) name, etc.,	[optional]
labels	string[]	Labels of the document.	[optional]
next_cursor	int	Next cursor value for pagination, required for fetching the next set of documents beyond 10,000 records.	[optional]
brand_ids	string[]	BrandId(s) of the document.	[optional]

Return type

\BoldSign\Model\DocumentRecords

Authorization

X-API-KEY, Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`prefillFields()`

prefillFields($document_id, $prefill_field_request)

Updates the value (prefill) of the fields in the document.

Example

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


// Configure API key authorization: X-API-KEY
$config = BoldSign\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = BoldSign\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

// Configure API key authorization: Bearer
$config = BoldSign\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = BoldSign\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new BoldSign\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
);
$document_id = 'document_id_example'; // string | The DocumentId.
$prefill_field_request = new \BoldSign\Model\PrefillFieldRequest(); // \BoldSign\Model\PrefillFieldRequest | The prefill field request.

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

Parameters

Name	Type	Description	Notes
document_id	string	The DocumentId.
prefill_field_request	\BoldSign\Model\PrefillFieldRequest	The prefill field request.

Return type

void (empty response body)

Authorization

X-API-KEY, Bearer

HTTP request headers

Content-Type: application/json;odata.metadata=minimal;odata.streaming=true, application/json;odata.metadata=minimal;odata.streaming=false, application/json;odata.metadata=minimal, application/json;odata.metadata=full;odata.streaming=true, application/json;odata.metadata=full;odata.streaming=false, application/json;odata.metadata=full, application/json;odata.metadata=none;odata.streaming=true, application/json;odata.metadata=none;odata.streaming=false, application/json;odata.metadata=none, application/json;odata.streaming=true, application/json;odata.streaming=false, application/json, application/xml, application/prs.odatatestxx-odata, application/json-patch+json, text/json, application/*+json
Accept: application/json

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

`remindDocument()`

remindDocument($document_id, $receiver_emails, $reminder_message)

Send reminder to pending signers.

Example

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


// Configure API key authorization: X-API-KEY
$config = BoldSign\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = BoldSign\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

// Configure API key authorization: Bearer
$config = BoldSign\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = BoldSign\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new BoldSign\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
);
$document_id = 'document_id_example'; // string | Document Id.
$receiver_emails = array('receiver_emails_example'); // string[] | Signer emails.
$reminder_message = new \BoldSign\Model\ReminderMessage(); // \BoldSign\Model\ReminderMessage | Reminder Message for signers.

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

Parameters

Name	Type	Description	Notes
document_id	string	Document Id.
receiver_emails	string[]	Signer emails.	[optional]
reminder_message	\BoldSign\Model\ReminderMessage	Reminder Message for signers.	[optional]

Return type

void (empty response body)

Authorization

X-API-KEY, Bearer

HTTP request headers

Content-Type: application/json;odata.metadata=minimal;odata.streaming=true, application/json;odata.metadata=minimal;odata.streaming=false, application/json;odata.metadata=minimal, application/json;odata.metadata=full;odata.streaming=true, application/json;odata.metadata=full;odata.streaming=false, application/json;odata.metadata=full, application/json;odata.metadata=none;odata.streaming=true, application/json;odata.metadata=none;odata.streaming=false, application/json;odata.metadata=none, application/json;odata.streaming=true, application/json;odata.streaming=false, application/json, application/xml, application/prs.odatatestxx-odata, application/json-patch+json, text/json, application/*+json
Accept: application/json;odata.metadata=minimal;odata.streaming=true, application/json;odata.metadata=minimal;odata.streaming=false, application/json;odata.metadata=minimal, application/json;odata.metadata=full;odata.streaming=true, application/json;odata.metadata=full;odata.streaming=false, application/json;odata.metadata=full, application/json;odata.metadata=none;odata.streaming=true, application/json;odata.metadata=none;odata.streaming=false, application/json;odata.metadata=none, application/json;odata.streaming=true, application/json;odata.streaming=false, application/json, application/xml, application/prs.odatatestxx-odata, text/plain, text/json

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

`removeAuthentication()`

removeAuthentication($document_id, $remove_authentication)

Remove the access code for the given document signer.

Example

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


// Configure API key authorization: X-API-KEY
$config = BoldSign\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = BoldSign\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

// Configure API key authorization: Bearer
$config = BoldSign\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = BoldSign\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new BoldSign\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
);
$document_id = 'document_id_example'; // string | Document ID of the signature request
$remove_authentication = new \BoldSign\Model\RemoveAuthentication(); // \BoldSign\Model\RemoveAuthentication | To remove access code.

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

Parameters

Name	Type	Description	Notes
document_id	string	Document ID of the signature request
remove_authentication	\BoldSign\Model\RemoveAuthentication	To remove access code.	[optional]

Return type

void (empty response body)

Authorization

X-API-KEY, Bearer

HTTP request headers

Content-Type: application/json;odata.metadata=minimal;odata.streaming=true, application/json;odata.metadata=minimal;odata.streaming=false, application/json;odata.metadata=minimal, application/json;odata.metadata=full;odata.streaming=true, application/json;odata.metadata=full;odata.streaming=false, application/json;odata.metadata=full, application/json;odata.metadata=none;odata.streaming=true, application/json;odata.metadata=none;odata.streaming=false, application/json;odata.metadata=none, application/json;odata.streaming=true, application/json;odata.streaming=false, application/json, application/xml, application/prs.odatatestxx-odata, application/json-patch+json, text/json, application/*+json
Accept: application/json;odata.metadata=minimal;odata.streaming=true, application/json;odata.metadata=minimal;odata.streaming=false, application/json;odata.metadata=minimal, application/json;odata.metadata=full;odata.streaming=true, application/json;odata.metadata=full;odata.streaming=false, application/json;odata.metadata=full, application/json;odata.metadata=none;odata.streaming=true, application/json;odata.metadata=none;odata.streaming=false, application/json;odata.metadata=none, application/json;odata.streaming=true, application/json;odata.streaming=false, application/json, application/xml, application/prs.odatatestxx-odata, text/plain, text/json

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

`revokeDocument()`

revokeDocument($document_id, $revoke_document)

Revoke the document.

Example

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


// Configure API key authorization: X-API-KEY
$config = BoldSign\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = BoldSign\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

// Configure API key authorization: Bearer
$config = BoldSign\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = BoldSign\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new BoldSign\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
);
$document_id = 'document_id_example'; // string | Document Id.
$revoke_document = new \BoldSign\Model\RevokeDocument(); // \BoldSign\Model\RevokeDocument | RevokeDetails.

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

Parameters

Name	Type	Description	Notes
document_id	string	Document Id.
revoke_document	\BoldSign\Model\RevokeDocument	RevokeDetails.

Return type

void (empty response body)

Authorization

X-API-KEY, Bearer

HTTP request headers

Content-Type: application/json;odata.metadata=minimal;odata.streaming=true, application/json;odata.metadata=minimal;odata.streaming=false, application/json;odata.metadata=minimal, application/json;odata.metadata=full;odata.streaming=true, application/json;odata.metadata=full;odata.streaming=false, application/json;odata.metadata=full, application/json;odata.metadata=none;odata.streaming=true, application/json;odata.metadata=none;odata.streaming=false, application/json;odata.metadata=none, application/json;odata.streaming=true, application/json;odata.streaming=false, application/json, application/xml, application/prs.odatatestxx-odata, application/json-patch+json, text/json, application/*+json
Accept: application/json

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

`sendDocument()`

sendDocument($send_for_sign): \BoldSign\Model\DocumentCreated

Sends the document for sign.

Example

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


// Configure API key authorization: X-API-KEY
$config = BoldSign\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = BoldSign\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

// Configure API key authorization: Bearer
$config = BoldSign\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = BoldSign\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new BoldSign\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
);
$send_for_sign = new \BoldSign\Model\SendForSign(); // \BoldSign\Model\SendForSign | The send for sign request body.

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

Parameters

Name	Type	Description	Notes
send_for_sign	\BoldSign\Model\SendForSign	The send for sign request body.	[optional]

Return type

\BoldSign\Model\DocumentCreated

Authorization

X-API-KEY, Bearer

HTTP request headers

Content-Type: application/json, multipart/form-data, application/x-www-form-urlencoded
Accept: application/json

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

`teamDocuments()`

teamDocuments($page, $user_id, $team_id, $transmit_type, $page_size, $start_date, $status, $end_date, $search_key, $labels, $next_cursor, $brand_ids): \BoldSign\Model\TeamDocumentRecords

Get user Team documents.

Example

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


// Configure API key authorization: X-API-KEY
$config = BoldSign\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = BoldSign\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

// Configure API key authorization: Bearer
$config = BoldSign\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = BoldSign\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new BoldSign\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
);
$page = 1; // int | Page index specified in get document list request.
$user_id = array('user_id_example'); // string[] | UserId of the  Team document.
$team_id = array('team_id_example'); // string[] | TeamId  of the  Team document.
$transmit_type = 'transmit_type_example'; // string | Transmit type as Sent, Received and Both.
$page_size = 10; // int | Page size specified in get document list request.
$start_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | Start date of the document
$status = array('status_example'); // string[] | Status of the document such as In-progress, Completed, Decline, Expired, Revoked, Draft.
$end_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | End date of the document
$search_key = 'search_key_example'; // string | Documents can be listed by the search key present in the document like document title, document ID, sender or recipient(s) name, etc.,
$labels = array('labels_example'); // string[] | Labels of the document.
$next_cursor = 56; // int | Next cursor value for pagination, required for fetching the next set of documents beyond 10,000 records.
$brand_ids = array('brand_ids_example'); // string[] | BrandId(s) of the document.

try {
    $result = $apiInstance->teamDocuments($page, $user_id, $team_id, $transmit_type, $page_size, $start_date, $status, $end_date, $search_key, $labels, $next_cursor, $brand_ids);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DocumentApi->teamDocuments: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
page	int	Page index specified in get document list request.	[default to 1]
user_id	string[]	UserId of the Team document.	[optional]
team_id	string[]	TeamId of the Team document.	[optional]
transmit_type	string	Transmit type as Sent, Received and Both.	[optional]
page_size	int	Page size specified in get document list request.	[optional] [default to 10]
start_date	\DateTime	Start date of the document	[optional]
status	string[]	Status of the document such as In-progress, Completed, Decline, Expired, Revoked, Draft.	[optional]
end_date	\DateTime	End date of the document	[optional]
search_key	string	Documents can be listed by the search key present in the document like document title, document ID, sender or recipient(s) name, etc.,	[optional]
labels	string[]	Labels of the document.	[optional]
next_cursor	int	Next cursor value for pagination, required for fetching the next set of documents beyond 10,000 records.	[optional]
brand_ids	string[]	BrandId(s) of the document.	[optional]

Return type

\BoldSign\Model\TeamDocumentRecords

Authorization

X-API-KEY, Bearer

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

DocumentApi.md

Latest commit

History

DocumentApi.md

File metadata and controls

BoldSign\DocumentApi

addAuthentication()

Example

Parameters

Return type

Authorization

HTTP request headers

addTag()

Example

Parameters

Return type

Authorization

HTTP request headers

behalfDocuments()

Example

Parameters

Return type

Authorization

HTTP request headers

changeAccessCode()

Example

Parameters

Return type

Authorization

HTTP request headers

changeRecipient()

Example

Parameters

Return type

Authorization

HTTP request headers

createEmbeddedRequestUrlDocument()

Example

Parameters

Return type

Authorization

HTTP request headers

deleteDocument()

Example

Parameters

Return type

Authorization

HTTP request headers

deleteTag()

Example

Parameters

Return type

Authorization

HTTP request headers

downloadAttachment()

Example

Parameters

Return type

Authorization

HTTP request headers

downloadAuditLog()

Example

Parameters

Return type

Authorization

HTTP request headers

downloadDocument()

Example

Parameters

Return type

Authorization

HTTP request headers

extendExpiry()

Example

Parameters

Return type

Authorization

HTTP request headers

getEmbeddedSignLink()

`addAuthentication()`

`addTag()`

`behalfDocuments()`

`changeAccessCode()`

`changeRecipient()`

`createEmbeddedRequestUrlDocument()`

`deleteDocument()`

`deleteTag()`

`downloadAttachment()`

`downloadAuditLog()`

`downloadDocument()`

`extendExpiry()`

`getEmbeddedSignLink()`

`getProperties()`

`listDocuments()`

`prefillFields()`

`remindDocument()`

`removeAuthentication()`

`revokeDocument()`

`sendDocument()`

`teamDocuments()`